None
This object has no members.
IP address for static configuration
Allowed values: IPv4, IPv6
Default value: IPv4
SDK attribute: address
Advertisement Criteria for Traffic Flow
Allowed values: BFD, CONTROL_SESSION, OPERATIONAL_LINK
SDK attribute: advertisementCriteria
UUID of BGP Neighbor associated to the Uplink which will be used for Bootstrap. This is mandatory if a secondaryAddress is defined.
Format: free
SDK attribute: associatedBGPNeighborID
The display name of the Underlay instance associated with this uplink connection.
Format: free
SDK attribute: associatedUnderlayName
UUID of the underlay associated to the uplink.
Format: free
SDK attribute: assocUnderlayID
Make this uplink an auxiliary one that will only come up when all other uplinks are disconnected or can't perform their role.
Default value: false
SDK attribute: auxiliaryLink
DNS server address
Format: free
SDK attribute: DNSAddress
Download rate limit for this uplink in Mbits/sec.
Default value: 8
Min value: 1
Max value: 10000
SDK attribute: downloadRateLimit
IP address of the gateway bound to the port
Format: free
SDK attribute: gateway
The way the interface is connected via the NSG. This value depends on if the interface internal or external to the NSG.
Allowed values: AUTOMATIC, EMBEDDED, PCI_EXPRESS, USB_ETHERNET, USB_MODEM
Default value: AUTOMATIC
SDK attribute: interfaceConnectionType
Specify how to connect to the network. Possible values: Dynamic (DHCP), Static (static configuration is required), PPPoE (pppoe configuration required), LTE (LTE configuration required). Default: Dynamic
Allowed values: Dynamic, LTE, PPPoE, Static
Default value: Dynamic
SDK attribute: mode
Subnet mask
Format: free
SDK attribute: netmask
PPPoE password.
Format: free
SDK attribute: password
Physical port name this uplink belongs to
Format: free
SDK attribute: portName
To allow prioritisation of traffic, the NSG network ports must be configured with an uplink type or tag value which will be used in the identification of packets being forwarded. That identification is at the base of the selection of which network port will serve in sending packets to the outside world. The default value is PRIMARY. Possible values are PRIMARY, SECONDARY, TERTIARY, UNKNOWN,
Allowed values: NONE, PRIMARY, SECONDARY, TERTIARY, UNKNOWN
Default value: PRIMARY
SDK attribute: role
Role order: Primary 1, Primary 2, Secondary 3. Note: Order will be calculated when all uplink connections fetched for gateway
Format: free
SDK attribute: roleOrder
Secondary IP Address (Control IP Address) for Loopback.
Format: free
Max length: 64
SDK attribute: secondaryAddress
ID that unqiuely identifies the uplink.
Format: free
Min length: 1
Max length: 65535
SDK attribute: uplinkID
PPPoE username
Format: free
SDK attribute: username
The tag of the uplink's parent VLAN
Format: free
SDK attribute: vlanId