Underlay

Underlays identify the transport networks that provide connectivity between NSGs, e.g. the Internet or a carrier MPLS VPN. The modelling of an underlay is required when using multiple disjoint underlays that are interconnected via one or more NSG-UBRs. The underlay object is used at the NSG Control uplink and at the NSG-UBR Underlay uplink. If no underlays are defined a default underlay is used.

Overview

description string filterable   orderable  
embeddedMetadata list read only   autogenerated  
entityScope enum (ENTERPRISE | GLOBAL) autogenerated  
externalID string filterable   orderable   locally unique  
lastUpdatedBy string autogenerated  
name string required   filterable   orderable  
underlayId integer read only   autogenerated   filterable   orderable   locally unique  

API Resource

/underlays/id
delete get put

Parents

/underlays
get post

Children

/underlays/id/permissions
delete get post put
/underlays/id/metadatas
get post
/underlays/id/globalmetadatas
get post put

Members

This object has no members.

Attributes documentation

description string filterable   orderable  
Discussion

Description of the underlay


Charateristics

Format: free
Max length: 255
SDK attribute: description

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

name string required   filterable   orderable  
Discussion

Name of the underlay


Charateristics

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

underlayId integer read only   autogenerated   filterable   orderable   locally unique  
Discussion

Used to identify and make a distinction between different Underlays with an autogenerated integer.


Charateristics

Min value: 1
Max value: 65535
SDK attribute: underlayId