Configuration of VNS Gateway uplinks
This object has no members.
IP address for static configuration
Format: free
Max length: 255
SDK attribute: address
IP address family of this UplinkConnection
Allowed values: IPV4, IPV6
Default value: IPV4
SDK attribute: addressFamily
IPv6 address for static configuration
Format: ipv6
Max length: 255
SDK attribute: addressV6
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
The type of redundancy this Uplink offers when marked as auxiliary link.
Allowed values: COLD, HOT, NONE
Default value: NONE
SDK attribute: auxMode
DNS server address.
Format: free
Max length: 255
SDK attribute: DNSAddress
IPv6 DNS server address.
Format: ipv6
Max length: 255
SDK attribute: DNSAddressV6
Download rate limit for this uplink in Mb/s.
Default value: 8.0
Min value: 1
Max value: 10000
SDK attribute: downloadRateLimit
Metadata objects associated with this entity. This will contain a list of Metadata objects if the API request is made using the special flag to enable the embedded Metadata feature. Only a maximum of Metadata objects is returned based on the value set in the system configuration.
SDK attribute: embeddedMetadata
Specify if scope of entity is Data center or Enterprise level
Allowed values: ENTERPRISE, GLOBAL
SDK attribute: entityScope
External object ID. Used for integration with third party systems
Format: free
SDK attribute: externalID
IP address of the gateway bound to the port
Format: free
Max length: 255
SDK attribute: gateway
IPv6 address of the gateway bound to the port.
Format: ipv6
Max length: 255
SDK attribute: gatewayV6
This flag will determine if the abstract connection is inherited from the instance template
Default value: false
SDK attribute: inherited
Boolean flag to indicate that connection parameters will be configured by the installer onsite. Limited to ConnectionMode: PPPoE
Default value: false
SDK attribute: installerManaged
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
ID of the user who last updated the object.
Format: free
SDK attribute: lastUpdatedBy
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: Any, Dynamic, LTE, PPPoE, Static
Default value: Dynamic
SDK attribute: mode
Subnet mask of the uplink connection if mode is set to Static.
Format: free
Max length: 255
SDK attribute: netmask
PPPoE password.
Format: free
Max length: 255
SDK attribute: password
Indicates whether PAT is enabled on the underlay for this uplink connection.
Default value: true
SDK attribute: PATEnabled
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
Determines the order in which uplinks are configured on NSG. It also determines the priority for an Uplink for management traffic. This value will be auto-generated when not provided by user.
Min value: 1
Max value: 3
SDK attribute: roleOrder
Secondary IP Address (Control IP Address) for Loopback.
Format: free
Max length: 255
SDK attribute: secondaryAddress
Indicated whether route to underlay is enabled on this uplink connection.
Default value: true
SDK attribute: underlayEnabled
Underlay Identifier of underlay associated with this uplink.
SDK attribute: underlayID
ID that unqiuely identifies the uplink.
Format: free
Max value: 65535
SDK attribute: uplinkID
PPPoE username if uplink mode is set to PPPoE.
Format: free
Max length: 255
SDK attribute: username
VLAN Id of this uplink
SDK attribute: vlan