UplinkConnection

None

Overview

address enum (IPv4 | IPv6) filterable   orderable  
advertisementCriteria enum (CONTROL_SESSION | FATE_SHARING | GATEWAY_PING | OPERATIONAL_LINK) filterable   orderable  
associatedBGPNeighborID string filterable   orderable  
associatedUnderlayName string filterable   orderable  
associatedVSCProfileID string filterable   orderable  
assocUnderlayID string filterable   orderable  
auxiliaryLink boolean filterable   orderable  
DNSAddress string filterable   orderable  
gateway string filterable   orderable  
interfaceConnectionType enum (AUTOMATIC | EMBEDDED | PCI_EXPRESS | USB_ETHERNET | USB_MODEM) filterable   orderable  
mode enum (Any | Dynamic | LTE | PPPoE | Static) filterable   orderable  
netmask string filterable   orderable  
password string filterable   orderable  
portName string read only  
role enum (NONE | PRIMARY | SECONDARY | TERTIARY | UNKNOWN) filterable   orderable  
roleOrder string read only  
secondaryAddress string
uplinkID string filterable   orderable  
username string filterable   orderable  
vlanId string read only  

API Resource

/uplinkconnections/id
delete get put

Parents

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

Children

/uplinkconnections/id/underlays
get post
/uplinkconnections/id/customproperties
get post

Members

This object has no members.

Attributes documentation

address enum filterable   orderable  
Discussion

IP address for static configuration


Charateristics

Allowed values: IPv4, IPv6
Default value: IPv4
SDK attribute: address

advertisementCriteria enum filterable   orderable  
Discussion

Advertisement Criteria for Traffic Flow


Charateristics

Allowed values: CONTROL_SESSION, FATE_SHARING, GATEWAY_PING, OPERATIONAL_LINK
SDK attribute: advertisementCriteria

associatedBGPNeighborID string filterable   orderable  
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 filterable   orderable  
Discussion

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


Charateristics

Format: free
SDK attribute: associatedUnderlayName

associatedVSCProfileID string filterable   orderable  
Discussion

The ID of the infrastructure VSC profile this is associated with this instance of a vlan or vlan template.


Charateristics

Format: free
SDK attribute: associatedVSCProfileID

assocUnderlayID string filterable   orderable  
Discussion

UUID of the underlay associated to the uplink.


Charateristics

Format: free
SDK attribute: assocUnderlayID

DNSAddress string filterable   orderable  
Discussion

DNS server address


Charateristics

Format: free
SDK attribute: DNSAddress

gateway string filterable   orderable  
Discussion

IP address of the gateway bound to the port


Charateristics

Format: free
SDK attribute: gateway

interfaceConnectionType enum filterable   orderable  
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

mode enum filterable   orderable  
Discussion

Specify how to connect to the network. Possible values: Any, 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 filterable   orderable  
Discussion

Subnet mask


Charateristics

Format: free
SDK attribute: netmask

password string filterable   orderable  
Discussion

PPPoE password.


Charateristics

Format: free
SDK attribute: password

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 string read only  
Discussion

Role order: Primary 1, Primary 2, Secondary 3. Note: Order will be calculated when all uplink connections fetched for gateway


Charateristics

Format: free
SDK attribute: roleOrder

secondaryAddress string
Discussion

Secondary IP Address (Control IP Address) for Loopback.


Charateristics

Format: free
Max length: 64
SDK attribute: secondaryAddress

uplinkID string filterable   orderable  
Discussion

ID that unqiuely identifies the uplink.


Charateristics

Format: free
Min length: 1
Max length: 65535
SDK attribute: uplinkID

username string filterable   orderable  
Discussion

PPPoE username


Charateristics

Format: free
SDK attribute: username

vlanId string read only  
Discussion

The tag of the uplink's parent VLAN


Charateristics

Format: free
SDK attribute: vlanId