Link

Border router links provide a way to interconnect VNS domains in the wide-area to datacenter domains. Service chaining links allow domain leaking in order to simplify and enhance capabilities of doing service chaining and traffic steering for NFV and service-provider-grade VPN services.

Overview

acceptanceCriteria enum (ALL | SUBNETS_ONLY)
associatedDestinationID string filterable  
associatedDestinationName string
associatedDestinationType enum (DOMAIN) filterable  
associatedSourceID string filterable  
associatedSourceName string
associatedSourceType string filterable  
embeddedMetadata list read only   autogenerated  
entityScope enum (ENTERPRISE | GLOBAL) autogenerated  
externalID string filterable   orderable   locally unique  
lastUpdatedBy string autogenerated  
readOnly boolean creation only  
type enum (BIDIR | BORDER_ROUTER | HUB_AND_SPOKE | OVERLAY_ADDRESS_TRANSLATION | SERVICE_CHAINING)

API Resource

/links/id
delete get put

Parents

/domains/id/links
get post put
/aggregateddomains/id/links
get post put

Children

/links/id/demarcationservices
get post put
/links/id/metadatas
get post
/links/id/nexthops
get post put
/links/id/globalmetadatas
get post put
/links/id/policystatements
get post put
/links/id/csnatpools
get post put
/links/id/psnatpools
get post put
/links/id/overlayaddresspools
get post

Members

This object has no members.

Attributes documentation

acceptanceCriteria enum
Discussion

A route filtering criteria enum. Defaults to ALL.

Charateristics

Allowed values: ALL, SUBNETS_ONLY
Default value: ALL
SDK attribute: acceptanceCriteria

associatedDestinationID string filterable  
Discussion

This is the ID of the domain receiving the routes from the source. This can only be set for links of type OVERLAY_ADDRESS_TRANSLATION.

Charateristics

Format: free
SDK attribute: associatedDestinationID

associatedDestinationName string
Discussion

None

Charateristics

SDK attribute: associatedDestinationName

associatedDestinationType enum filterable  
Discussion

Type of the entity type for the source

Charateristics

Allowed values: DOMAIN
SDK attribute: associatedDestinationType

associatedSourceID string filterable  
Discussion

The ID of the domain receiving the routes from another domain

Charateristics

Format: free
SDK attribute: associatedSourceID

associatedSourceName string
Discussion

None

Charateristics

Format: free
SDK attribute: associatedSourceName

associatedSourceType string filterable  
Discussion

This is the source object type for the associatedSourceID

Charateristics

Format: free
SDK attribute: associatedSourceType

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

readOnly boolean creation only  
Discussion

This is set to true if a link has been created in the opposite direction

Charateristics

SDK attribute: readOnly

type enum
Discussion

This is used to distinguish between different type of links: hub and spoke, IP address, VNS border router links.

Charateristics

Allowed values: BIDIR, BORDER_ROUTER, HUB_AND_SPOKE, OVERLAY_ADDRESS_TRANSLATION, SERVICE_CHAINING
SDK attribute: type