Parameter Name | Mandatory | Data Type | Default Value | Possible Values | Description |
dns
| N/A | N/A | N/A | N/A | A container that defines the DNS server details. |
hostName | No | String | None | 64 to maximum length | Specifies a hostname for the SBC Edge Portfolio. The combination of the host and domain names is the FQDN, which must not exceed 255 characters. If the FQDN is not provided then the default hostname is the node serial number. |
domainName | No | String | None | 255 to maximum length | Specifies a domain name for the SBC Edge Portfolio, which the SBC uses only if the IP addressing is static. The combination of the host and domain names is the FQDN, which must not exceed 255 characters. |
primaryDNSServerIP | No | String | None | 15 to maximum length | Sets the IP address (IPv4 format) of the primary DNS server. This field does not apply if the ifIpAddrAssignMethod parameter is set to dynamic. Setting this field to empty (with static addressing) disables the primary DNS server. |
secondaryDNSServerIP | No | String | None | 15 to maximum length | Sets the IP address (IPv4 format) of the secondary DNS server. This field does not apply if the ifIpAddrAssignMethod parameter is set to dynamic. Setting this field to empty (with static addressing) disables the secondary DNS server. |
admin_account
| Yes | N/A | N/A | N/A | A container that defines the admin user configurations. |
adminUserName | Yes | String | None | 32 to maximum length | Specifies an administrative username to use in subsequent logins. |
adminUserPassword | Yes | String | None | 128 to maximum length | Specifies an administrative user password to use in subsequent logins. |
netconfig_account | No | String | None | N/A | A container that defines the netconfig configuration. NOTE: Only Release 8.0.3 and later support the netconfig_account configuration. |
netconfigUserPassword | No | String | None | N/A | Overrides the default netconfig password and allows you to set the system without a hardcoded password. |
rest_account | N/A | N/A | N/A | N/A | A container that defines the rest account configuration. |
restUserName | No | String | None | 32 to maximum length | Specifies a REST username to use in subsequent authentications. If this parameter and the restUserPassword are either empty or not provided, then the SBC does not set up the node for REST access until you create a REST user from the UI. |
restUserPassword | No | String | None | 128 to maximum length | Specifies a REST user password to use in subsequent authentications. If this parameter and the restUserName are either empty or not provided, then the SBC does not set up the node for REST access until you create a REST user from the UI. |
mgt0 | Yes | N/A | N/A | N/A | A container that defines the management interface. |
adminIpAddrAssignMethod | No | Enum | 0 | 0 - static 1 - dynamic | Determines whether the specific mgt0 settings are configured dynamically (through DHCP) or statically. |
adminIPAddress | No | String | None | 15 to maximum length | Sets the admin IP address. This field does not apply if the adminIpAddrAssignMethod parameter is set to dynamic. For static addressing, you must use a valid IPv4 address for the adminIPAddress parameter. |
adminNetmask | No | String | None | 15 to maximum length | Sets the admin IP subnet. This field does not apply if the adminIpAddrAssignMethod parameter is set to dynamic. For static addressing, you must use a valid IPv4 subnet for the adminNetmask parameter. |
adminDHCPSuppliedParamUsage | No | Enum | 0 | 0 - USE_ALL 1 - USE_IP_ONLY 2 - USE_IP_DNS_ONLY | Determines how the SBC uses the parameters that the DHCP server supplies when a logical interface is configured with Dynamic IP addressing.- USE_ALL - The SBC uses all supported DHCP parameters. The SBC uses the supplied DNS servers as global DNS servers, which replace the currently configured DNS servers. This configuration does not affect the split-DNS settings.
- USE_IP_ONLY - The SBC uses only the IP address and netmask. This configuration ignores the DNS server and other settings, and does not affect the current split-DNS settings.
- USE_IP_DNS_ONLY - The SBC uses only the IP address, domain-name, and DNS server IP addresses. The SBC uses the supplied domain-name and the DNS server IP addresses depending on the value of the
ConfigureSplitDNS parameter.
NOTE: If you add the adminDHCPSuppliedParamUsage parameter on any interface, the interface becomes dynamic. |
pkt0 | Yes | N/A | N/A | N/A | A container that defines the first packet network for voice traffic. |
applicationIpAddrAssignMethod | No | Enum | 0 | 0 - static 1 - dynamic | Determines whether the specific node-level settings are configured dynamically (through DHCP) or statically. |
applicationIPV4Address | No | String | None | 15 to maximum length | Sets the Ethernet 1 IP address. This field does not apply if the applicationIpAddrAssignMethod parameter is set to dynamic. For static addressing, you must use a valid IPv4 address for the applicationIPV4Address parameter. |
applicationIPV4Netmask | No | String | None | 15 to maximum length | Sets the Ethernet 1 IP subnet. This field does not apply if the eth1IpAddrAssignMethod parameter is set to dynamic. For static addressing, you must use a valid IPv4 subnet for the applicationIPV4Netmask parameter. |
applicationDHCPSuppliedParamUsage | No | Enum | 0 | 0 - USE_ALL 1 - USE_IP_ONLY 2 - USE_IP_DNS_ONLY | Determines how the SBC uses the parameters that the DHCP server supplies when a logical interface is configured with Dynamic IP addressing.- USE_ALL - The SBC uses all supported DHCP parameters. The SBC uses the supplied DNS servers as global DNS servers, which replace the currently configured DNS servers. This configuration does not affect the split-DNS settings.
- USE_IP_ONLY - The SBC uses only the IP address and netmask. This configuration ignores the DNS server and other settings, and does not affect the current split-DNS settings.
- USE_IP_DNS_ONLY - The SBC uses only the IP address, domain-name, and DNS server IP addresses. The SBC uses the supplied domain-name and the DNS server IP addresses depending on the value of the
ConfigureSplitDNS parameter.
|
NextHopIP1 | No | String | None | 15 to maximum length | Specifies the Eth1 next hop IP address. |
pkt1 | N/A | N/A | N/A | N/A | Defines the second packet network for voice traffic. |
eth2IpAddrAssignMethod | No | Enum | 0 | 0 - static 1 - dynamic | Determines whether the specific node-level settings are configured dynamically (through DHCP) or statically. |
eth2IPV4Address | No | String | None | 15 to maximum length | Sets the Ethernet 1 IP address. This field does not apply if the eth2IpAddrAssignMethod parameter is set to dynamic. For static addressing, you must use a valid IPv4 address for the eth2IPV4Address parameter. |
eth2IPV4Netmask | No | String | None | 15 to maximum length | Sets the Ethernet 1 IP subnet. This field does not apply if the eth2IpAddrAssignMethod parameter is set to dynamic. For static addressing, you must use a valid IPv4 subnet for the eth2IPV4Netmask parameter. |
eth2DHCPSuppliedParamUsage | No | Enum | 0 | 0 - USE_ALL 1 - USE_IP_ONLY 2 - USE_IP_DNS_ONLY | Determines how the SBC uses the parameters that the DHCP server supplies when a logical interface is configured with Dynamic IP addressing.- USE_ALL - The SBC uses all supported DHCP parameters. The SBC uses the supplied DNS servers as global DNS servers, which replace the currently configured DNS servers. This configuration does not affect the split-DNS settings.
- USE_IP_ONLY - The SBC uses only the IP address and netmask. This configuration ignores the DNS server and other settings, and does not affect the current split-DNS settings.
- USE_IP_DNS_ONLY - The SBC uses only the IP address, domain-name, and DNS server IP addresses. The SBC uses the supplied domain-name and the DNS server IP addresses depending on the value of the
ConfigureSplitDNS parameter.
|
NextHopIP2 | No | String | None | 15 to maximum length | Specifies the Eth2 next hop IP address. |
pkt2 | N/A | N/A | N/A | N/A | Defines the third packet network for voice traffic. |
eth3IpAddrAssignMethod | No | Enum | 0 | 0 - static 1 - dynamic | Determines whether the specific node-level settings are configured dynamically (through DHCP) or statically. |
eth3IPV4Address | No | String | None | 15 to maximum length | Sets the Ethernet 1 IP address. This field does not apply if the eth3IpAddrAssignMethod parameter is set to dynamic. For static addressing, you must use a valid IPv4 address for the eth3IPV4Address parameter. |
eth3IPV4Netmask | No | String | None | 15 to maximum length | Sets the Ethernet 1 IP subnet. This field does not apply if the eth3IpAddrAssignMethod parameter is set to dynamic. For static addressing, you must use a valid IPv4 subnet for the eth3IPV4Netmask parameter. |
eth3DHCPSuppliedParamUsage | No | Enum | 0 | 0 - USE_ALL 1 - USE_IP_ONLY 2 - USE_IP_DNS_ONLY | Determines how the SBC uses the parameters that the DHCP server supplies when a logical interface is configured with Dynamic IP addressing.- USE_ALL - The SBC uses all supported DHCP parameters. The SBC uses the supplied DNS servers as global DNS servers, which replace the currently configured DNS servers. This configuration does not affect the split-DNS settings.
- USE_IP_ONLY - The SBC uses only the IP address and netmask. This configuration ignores the DNS server and other settings, and does not affect the current split-DNS settings.
- USE_IP_DNS_ONLY - The SBC uses only the IP address, domain-name, and DNS server IP addresses. The SBC uses the supplied domain-name and the DNS server IP addresses depending on the value of the
ConfigureSplitDNS parameter.
|
NextHopIP3 | No | String | None | 15 to maximum length | Specifies the Eth3 next hop IP address. |
pkt3 | N/A | N/A | N/A | N/A | Defines the fourth packet network for voice traffic. |
eth4IpAddrAssignMethod | No | Enum | 0 | 0 - static 1 - dynamic | Determines whether the specific node-level settings are configured dynamically (through DHCP) or statically. |
eth4IPV4Address | No | String | None | 15 to maximum length | Sets the Ethernet 1 IP address. This field does not apply if the eth4IpAddrAssignMethod parameter is set to dynamic. For static addressing, you must use a valid IPv4 address for the eth4IPV4Address parameter. |
eth4IPV4Netmask | No | String | None | 15 to maximum length | Sets the Ethernet 1 IP subnet. This field does not apply if the eth4IpAddrAssignMethod parameter is set to dynamic. For static addressing, you must use a valid IPv4 subnet for the eth4IPV4Netmask parameter. |
eth4DHCPSuppliedParamUsage | No | Enum | 0 | 0 - USE_ALL 1 - USE_IP_ONLY 2 - USE_IP_DNS_ONLY | Determines how the SBC uses the parameters that the DHCP server supplies when a logical interface is configured with Dynamic IP addressing.- USE_ALL - The SBC uses all supported DHCP parameters. The SBC uses the supplied DNS servers as global DNS servers, which replace the currently configured DNS servers. This configuration does not affect the split-DNS settings.
- USE_IP_ONLY - The SBC uses only the IP address and netmask. This configuration ignores the DNS server and other settings, and does not affect the current split-DNS settings.
- USE_IP_DNS_ONLY - The SBC uses only the IP address, domain-name, and DNS server IP addresses. The SBC uses the supplied domain-name and the DNS server IP addresses depending on the value of the
ConfigureSplitDNS parameter.
|
NextHopIP4 | No | String | None | 15 to maximum length | Specifies the Eth4 next hop IP address. |
syslog | N/A | N/A | N/A | N/A | A container that defines the syslog server configuration. |
ServerAddress | No | String | None | 128 to maximum length | Specifies the IP address or FQDN of the Syslog server where the SBC sends log entries. If this field is empty then the SBC does not add a Syslog server. |
ServerPort | Yes | Integer | 514 | 514 to minimum 65534 to maximum | Specifies the Syslog server port number where the SBC sends log entries. |
ServerTransport | Yes | Enum | 0 | 0 - stUDP 1 - stTCP | Specifies the protocol that the SBC uses to send log entries to the Syslog server. |
DefaultLevel | No | Enum | 4 | 0 - llDefault 1 - llTrace 2 - llDebug 3 - llInfo 4 - llWarn 5 - llError 6 - llFatal 7 - llOff | Controls the default minimum severity level of messages sent to this server. You can override this default value on a per-system basis through the Subsystems Configuration. The Informational setting produces the most output and the Fatal setting produces the least output. The more output there is the more the parameter impacts system performance.
NOTE: The following are valid values for the DefaultLevel: - 3 - Informational
- 4 - Warning
- 5 - Error
- 6 - Fatal
|
ntp | No | N/A | N/A | N/A | A container that defines the NTP server configuration. |
Ntp1ServerName | No | String | None | 255 to maximum length | Configures the hostname, IP, or IPv6 address of the first configured NTP server. If the hostname is supplied, the system uses the DNS to connect to the NTP server. NOTE: The SBC uses this parameter only when the useDynamicNetSettings parameter is set to false. If useDynamicNetSettings is set to true, the first configured NTP server is in the runtime rt_NTPServer1 parameter. |
IsNtp1AuthEnabled | No | Enum | 0 | 0 - btFalse 1 - btTrue | Enables or disables the authentication of the first NTP server. NOTE: The SBC uses this parameter only when the useDynamicNetSettings parameter is set to false. |
Ntp1ServerKeyId | No | Integer | 0 | 0 - Minimum 2147483647 - Maximum | Configures the MD5 Key ID to authenticate the first NTP server 0, which is the system default value when the NTP server is not configured. If you configure the NTP server you must use a value higher than 0. NOTE: The SBC uses this parameter only when the useDynamicNetSettings parameter is set to false. |
Ntp1ServerKey | No | String | None | 64 to maximum length | Configures the MD5 key to authenticate the first NTP server. NOTE: The SBC uses this parameter only when the useDynamicNetSettings parameter is set to false. |
staticroute | No | N/A | N/A | N/A | A container that defines the defaultgateway and route1 configurations. |
defaultGateway | No | String | None | 15 to maximum length | Specifies the gateway IP address. This parameter is a member of the staticroute container. |
route1 | No | N/A | N/A | N/A | A container that defines the route configurations. This container is a member of the staticroute container. |
ipDestinationAddr1 | No | String | None | 15 to maximum length | Specifies the destination IP address. This parameter is a member of the route1 container. |
ipDestinationMask1 | No | String | None | 15 to maximum length | Sets the subnet mask for the ipDestinationAddr1 parameter. This parameter is a member of the route1 container. |
ipNexthopAddress1 | No | String | None | 15 to maximum length | Specifies the next hop IP address. This parameter is a member of the route1 container. |
ipStaticRouteMetric1 | No | String | None | 15 to maximum length | Specifies the route cost metric value. This parameter is a member of the route1 container. |
| No | Boolean | 0 | 0 - Disable 1- Enable | Enable or disable the configuration. NOTE: When you enable this parameter, the EdgeviewFQDNName and EdgeviewManagementID parameters are mandatory. |
SecondaryCMPAddress | | String | None | 15 to 255 characters | If the user has a redundant RAMP configuration then the user should enter the address of the secondary server here. |
EdgeviewFQDNName | Yes | String | None | 15 to 255 characters | The EdgeView server address (IP address or FQDN). |
EdgeviewManagementID | Yes | String | None | N/A | CAUTION: When you enter the EdgeView Management ID, you must insert a colon every two characters (00:00:00). Otherwise, the SBC SWe Edge cannot connect to the EdgeView. The EdgeView Management ID. For information about retrieving the EdgeView Management ID, refer to Obtaining and Installing an SBC SWe Edge Production Node-Locked License. |
MACAddress | No | String | None | N/A | It is optional to enter the MACAddress information of the interface objects (mgt0, pkt0, pkt1, pkt2, and pkt3). If you provide this information, the cloud-init function performs the interface mapping based on the supplied MAC addresses. If you do not provide this information, the interface mapping is performed using the default PCI order. NOTE: You must include the MACAddress information to perform interface mapping. |
HAPairName | No | String | None | N/A | The HA Pair Name used to register with RAMP. |
high availability | No | String | None | N/A | A container that defines high availability. |
ha_local_ip | No | String | None | N/A | An HA IP of the local node |
ha_local_netmask | No | String | None | N/A | An HA IP Netmask for the local node |
ha_remote_ip | No | String | None | N/A | An HA IP of the remote node |