VirtualUplink

Virtual Uplinks are entities that represent on an NSG the properties that are set for corresponding control uplink instances that are residing on the NSG RG Peer when tied together by a Shunt Link.

Overview

associatedEgressQoSPolicyID string read only  
associatedIngressOverlayQoSPolicerID string read only  
associatedIngressQoSPolicyID string read only  
associatedIngressUnderlayQoSPolicerID string read only  
associatedUplinkConnectionID string read only  
associatedVSCProfileID string read only  
auxMode enum (COLD | HOT | NONE) read only  
enableNATProbes boolean read only  
fecEnabled enum (ACTIVE | DISABLED | PASSIVE) filterable   orderable  
peerEndpoint string read only  
peerGatewayID string read only  
peerGatewayName string read only  
peerGatewaySystemID string read only  
peerPortID string read only  
peerUplinkID integer read only  
peerVLANID string read only  
role enum (NONE | PRIMARY | SECONDARY | TERTIARY | UNKNOWN) read only  
roleOrder integer read only  
shuntEndpoint string filterable   orderable  
shuntPortID string read only  
shuntVLANID string read only  
trafficThroughUBROnly boolean read only  
underlayID integer read only  
underlayName string read only  
underlayNAT boolean read only  
underlayRouting boolean read only  
virtualUplinkDatapathID string read only  

API Resource

/virtualuplinks/id
delete get put

Parents

/shuntlinks/id/virtualuplinks
get
/nsgateways/id/virtualuplinks
get

Children

/virtualuplinks/id/ikegatewayconnections
get

Members

This object has no members.

Attributes documentation

associatedEgressQoSPolicyID string read only  
Discussion

ID of the Egress QoS Policy associated with remote VlLAN.


Charateristics

Format: free
SDK attribute: associatedEgressQoSPolicyID

associatedIngressOverlayQoSPolicerID string read only  
Discussion

ID of the Ingress Overlay QoS Policer associated with the remote VlLAN.


Charateristics

Format: free
SDK attribute: associatedIngressOverlayQoSPolicerID

associatedIngressQoSPolicyID string read only  
Discussion

ID of the Ingress QoS Policy / Tunnel Shaper associated with the remote VLAN.


Charateristics

Format: free
SDK attribute: associatedIngressQoSPolicyID

associatedIngressUnderlayQoSPolicerID string read only  
Discussion

ID of the Ingress Underlay QoS Policer associated with the remote VLAN.


Charateristics

Format: free
SDK attribute: associatedIngressUnderlayQoSPolicerID

associatedUplinkConnectionID string read only  
Discussion

UUID of the uplink connection from the peer NSG that this virtual uplink mirrors.


Charateristics

Format: free
SDK attribute: associatedUplinkConnectionID

associatedVSCProfileID string read only  
Discussion

The associated VSC profile of remote control uplink.


Charateristics

Format: free
SDK attribute: associatedVSCProfileID

auxMode enum read only  
Discussion

Type of redundancy offered by the Uplink that is mirrored by this Virtual uplink when marked as auxiliary.


Charateristics

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

enableNATProbes boolean read only  
Discussion

If enabled, probes will be sent to other NSGs and DTLS sessions for IPSEC and VXLAN will be set up to the VSCs. If disabled, no NAT probes are sent on that uplink and no DTLS sessions are set up to the VSCs.


Charateristics

Default value: false
SDK attribute: enableNATProbes

fecEnabled enum filterable   orderable  
Discussion

Indicates the FEC (Forward Error Correction) setting on this Virtual Uplink. Possible values are Active(Encode & Decode on all paths over this uplink), Passive(Encode & Decode only to uplinks with FEC Active) and Disabled(do not Encode or Decode, do not detect or report loss).


Charateristics

Allowed values: ACTIVE, DISABLED, PASSIVE
Default value: DISABLED
SDK attribute: fecEnabled

peerEndpoint string read only  
Discussion

The physical port and VLAN endpoint hosting the peer control uplink that this virtual uplink mirrors. This is derived from the peer NSG of the Shunt Link in a redundant gateway group.


Charateristics

Format: free
Max length: 255
SDK attribute: peerEndpoint

peerGatewayID string read only  
Discussion

The UUID of the peer NSG in the redundant gateway group part of the Shunt Link.


Charateristics

Format: free
SDK attribute: peerGatewayID

peerGatewayName string read only  
Discussion

The name of the peer NSG in the redundant gateway group part of the Shunt Link.


Charateristics

Format: free
Max length: 255
SDK attribute: peerGatewayName

peerGatewaySystemID string read only  
Discussion

IP format of system generated identifier of the peer NSG.


Charateristics

Format: free
SDK attribute: peerGatewaySystemID

peerPortID string read only  
Discussion

The UUID of the port hosting the peer control uplink that this virtual uplink mirrors. This is derived from the peer NSG of the Shunt Link on a redundant gateway group.


Charateristics

Format: free
Max length: 255
SDK attribute: peerPortID

peerUplinkID integer read only  
Discussion

ID that unqiuely identifies the uplink. This attribute represents the configuration on the remote uplink connection that this virtual uplink mirrors.


Charateristics

Max value: 65535
SDK attribute: peerUplinkID

peerVLANID string read only  
Discussion

The UUID of the VLAN in the control uplink that this virtual uplink mirrors.This is derived from the peer NSG of the Shunt Link on a redundant gateway group.


Charateristics

Format: free
Max length: 255
SDK attribute: peerVLANID

role enum read only  
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, This attribute represents the configuration on the remote uplink connection that this virtual uplink mirrors.


Charateristics

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

roleOrder integer read only  
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 based on the order of creation of Virtual Uplink.


Charateristics

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

shuntEndpoint string filterable   orderable  
Discussion

The physical port and VLAN endpoint hosting the shunt endpoint on this Gateway.


Charateristics

Format: free
Max length: 255
SDK attribute: shuntEndpoint

shuntPortID string read only  
Discussion

The UUID of the shunt port on the NSG hosting the Virtual Uplink.


Charateristics

Format: free
Max length: 255
SDK attribute: shuntPortID

shuntVLANID string read only  
Discussion

The UUID of the shunt VLAN on the NSG hosting the Virtual Uplink.


Charateristics

Format: free
Max length: 255
SDK attribute: shuntVLANID

trafficThroughUBROnly boolean read only  
Discussion

If enabled, cuts down the number of probes to just the number of provisioned UBRs. This attribute represents " + "the configuration on the remote uplink connection that this virtual uplink mirrors.


Charateristics

Default value: false
SDK attribute: trafficThroughUBROnly

underlayID integer read only  
Discussion

Underlay Identifier of underlay associated with the uplink mirrored by this Virtual Uplink.


Charateristics

SDK attribute: underlayID

underlayName string read only  
Discussion

Name of the underlay associated with the uplink mirrored by this Virtual Uplink.


Charateristics

Format: free
Max length: 255
SDK attribute: underlayName

underlayNAT boolean read only  
Discussion

Indicates whether PAT is enabled on the underlay for this uplink connection. Inherits the PATEnabled attribute from remote uplink connection.


Charateristics

Default value: true
SDK attribute: underlayNAT

underlayRouting boolean read only  
Discussion

Indicates whether route to underlay is enabled on the uplink connection that this Virtual uplink mirrors.


Charateristics

Default value: true
SDK attribute: underlayRouting

virtualUplinkDatapathID string read only  
Discussion

IP format of system generated identifier of an uplink on NSG.


Charateristics

Format: free
Min length: 1
Max length: 255
SDK attribute: virtualUplinkDatapathID