UplinkRD

Represents a network port uplink route distinguisher value.

Overview

embeddedMetadata list read only   autogenerated  
entityScope enum (ENTERPRISE | GLOBAL) autogenerated  
externalID string filterable   orderable   locally unique  
lastUpdatedBy string autogenerated  
routeDistinguisher string filterable   orderable  
uplinkType enum (RD_PRIMARY1 | RD_PRIMARY2 | RD_PRIMARY3 | RD_SECONDARY1 | RD_SECONDARY2 | RD_SECONDARY3)

API Resource

/uplinkroutedistinguishers/id
get

Parents

/uplinkroutedistinguishers
get
/domains/id/uplinkroutedistinguishers
get
/l2domains/id/uplinkroutedistinguishers
get
/aggregateddomains/id/uplinkroutedistinguishers
get

Children

/uplinkroutedistinguishers/id/metadatas
get post
/uplinkroutedistinguishers/id/globalmetadatas
get post put

Members

This object has no members.

Attributes documentation

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

lastUpdatedBy string autogenerated  
Discussion

ID of the user who last updated the object.

Charateristics

Format: free
SDK attribute: lastUpdatedBy

routeDistinguisher string filterable   orderable  
Discussion

The uplink route distinguisher value is used to identify which route packets should be flowing through with regards to having multiple network ports on the VRS/NSG.

Charateristics

Format: free
Max length: 255
SDK attribute: routeDistinguisher

uplinkType enum
Discussion

Indicates the uplink type associated with the instance of Uplink Route Distinguisher.

Charateristics

Allowed values: RD_PRIMARY1, RD_PRIMARY2, RD_PRIMARY3, RD_SECONDARY1, RD_SECONDARY2, RD_SECONDARY3
Default value: RD_PRIMARY1
SDK attribute: uplinkType