UplinkConnection

Configuration of VNS Gateway uplinks

Overview

address string
addressFamily enum (IPV4 | IPV6)
addressV6 string
advertisementCriteria enum (BFD | CONTROL_SESSION | OPERATIONAL_LINK) filterable   orderable  
associatedBGPNeighborID string
associatedUnderlayName string
assocUnderlayID string
auxiliaryLink boolean filterable   orderable  
auxMode enum (COLD | HOT | NONE) filterable   orderable  
DNSAddress string
DNSAddressV6 string
downloadRateLimit float
embeddedMetadata list read only   autogenerated  
entityScope enum (ENTERPRISE | GLOBAL) autogenerated  
externalID string filterable   orderable   locally unique  
gateway string
gatewayV6 string
inherited boolean read only  
installerManaged boolean filterable   orderable  
interfaceConnectionType enum (AUTOMATIC | EMBEDDED | PCI_EXPRESS | USB_ETHERNET | USB_MODEM)
lastUpdatedBy string autogenerated  
mode enum (Any | Dynamic | LTE | PPPoE | Static) filterable   orderable  
netmask string
password string
PATEnabled boolean filterable   orderable  
portName string read only  
role enum (NONE | PRIMARY | SECONDARY | TERTIARY | UNKNOWN) filterable   orderable  
roleOrder integer
secondaryAddress string
underlayEnabled boolean filterable   orderable  
underlayID integer
uplinkID integer filterable  
username string
vlan integer

API Resource

/uplinkconnections/id
delete get put

Parents

/nsgateways/id/uplinkconnections
get
/vlans/id/uplinkconnections
get post put
/vlantemplates/id/uplinkconnections
get post

Children

/uplinkconnections/id/metadatas
get post
/uplinkconnections/id/bfdsessions
get post put
/uplinkconnections/id/globalmetadatas
get post put
/uplinkconnections/id/customproperties
get post put

Members

This object has no members.

Attributes documentation

address string
Discussion

IP address for static configuration


Charateristics

Format: free
Max length: 255
SDK attribute: address

addressFamily enum
Discussion

IP address family of this UplinkConnection


Charateristics

Allowed values: IPV4, IPV6
Default value: IPV4
SDK attribute: addressFamily

addressV6 string
Discussion

IPv6 address for static configuration


Charateristics

Format: ipv6
Max length: 255
SDK attribute: addressV6

advertisementCriteria enum filterable   orderable  
Discussion

Advertisement Criteria for Traffic Flow


Charateristics

Allowed values: BFD, CONTROL_SESSION, OPERATIONAL_LINK
SDK attribute: advertisementCriteria

associatedBGPNeighborID string
Discussion

UUID of BGP Neighbor associated to the Uplink which will be used for Bootstrap. This is mandatory if a secondaryAddress is defined.


Charateristics

Format: free
SDK attribute: associatedBGPNeighborID

associatedUnderlayName string
Discussion

The display name of the Underlay instance associated with this uplink connection.


Charateristics

Format: free
SDK attribute: associatedUnderlayName

assocUnderlayID string
Discussion

UUID of the underlay associated to the uplink.


Charateristics

Format: free
SDK attribute: assocUnderlayID

auxMode enum filterable   orderable  
Discussion

The type of redundancy this Uplink offers when marked as auxiliary link.


Charateristics

Allowed values: COLD, HOT, NONE
Default value: NONE
SDK attribute: auxMode

DNSAddress string
Discussion

DNS server address.


Charateristics

Format: free
Max length: 255
SDK attribute: DNSAddress

DNSAddressV6 string
Discussion

IPv6 DNS server address.


Charateristics

Format: ipv6
Max length: 255
SDK attribute: DNSAddressV6

downloadRateLimit float
Discussion

Download rate limit for this uplink in Mb/s.


Charateristics

Default value: 8.0
Min value: 1
Max value: 10000
SDK attribute: downloadRateLimit

embeddedMetadata list read only   autogenerated  
Discussion

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.


Charateristics

SDK attribute: embeddedMetadata

entityScope enum autogenerated  
Discussion

Specify if scope of entity is Data center or Enterprise level


Charateristics

Allowed values: ENTERPRISE, GLOBAL
SDK attribute: entityScope

externalID string filterable   orderable   locally unique  
Discussion

External object ID. Used for integration with third party systems


Charateristics

Format: free
SDK attribute: externalID

gateway string
Discussion

IP address of the gateway bound to the port


Charateristics

Format: free
Max length: 255
SDK attribute: gateway

gatewayV6 string
Discussion

IPv6 address of the gateway bound to the port.


Charateristics

Format: ipv6
Max length: 255
SDK attribute: gatewayV6

inherited boolean read only  
Discussion

This flag will determine if the abstract connection is inherited from the instance template


Charateristics

Default value: false
SDK attribute: inherited

installerManaged boolean filterable   orderable  
Discussion

Boolean flag to indicate that connection parameters will be configured by the installer onsite. Limited to ConnectionMode: PPPoE


Charateristics

Default value: false
SDK attribute: installerManaged

interfaceConnectionType enum
Discussion

The way the interface is connected via the NSG. This value depends on if the interface internal or external to the NSG.


Charateristics

Allowed values: AUTOMATIC, EMBEDDED, PCI_EXPRESS, USB_ETHERNET, USB_MODEM
Default value: AUTOMATIC
SDK attribute: interfaceConnectionType

lastUpdatedBy string autogenerated  
Discussion

ID of the user who last updated the object.


Charateristics

Format: free
SDK attribute: lastUpdatedBy

mode enum filterable   orderable  
Discussion

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


Charateristics

Allowed values: Any, Dynamic, LTE, PPPoE, Static
Default value: Dynamic
SDK attribute: mode

netmask string
Discussion

Subnet mask of the uplink connection if mode is set to Static.


Charateristics

Format: free
Max length: 255
SDK attribute: netmask

password string
Discussion

PPPoE password.


Charateristics

Format: free
Max length: 255
SDK attribute: password

PATEnabled boolean filterable   orderable  
Discussion

Indicates whether PAT is enabled on the underlay for this uplink connection.


Charateristics

Default value: true
SDK attribute: PATEnabled

portName string read only  
Discussion

Physical port name this uplink belongs to.


Charateristics

Format: free
SDK attribute: portName

role enum filterable   orderable  
Discussion

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,


Charateristics

Allowed values: NONE, PRIMARY, SECONDARY, TERTIARY, UNKNOWN
Default value: PRIMARY
SDK attribute: role

roleOrder integer
Discussion

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.


Charateristics

Min value: 1
Max value: 3
SDK attribute: roleOrder

secondaryAddress string
Discussion

Secondary IP Address (Control IP Address) for Loopback.


Charateristics

Format: free
Max length: 255
SDK attribute: secondaryAddress

underlayEnabled boolean filterable   orderable  
Discussion

Indicated whether route to underlay is enabled on this uplink connection.


Charateristics

Default value: true
SDK attribute: underlayEnabled

underlayID integer
Discussion

Underlay Identifier of underlay associated with this uplink.


Charateristics

SDK attribute: underlayID

uplinkID integer filterable  
Discussion

ID that unqiuely identifies the uplink.


Charateristics

Format: free
Max value: 65535
SDK attribute: uplinkID

username string
Discussion

PPPoE username if uplink mode is set to PPPoE.


Charateristics

Format: free
Max length: 255
SDK attribute: username

vlan integer
Discussion

VLAN Id of this uplink


Charateristics

SDK attribute: vlan