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.
| description |
| embeddedMetadata |
| entityScope |
| externalID |
| lastUpdatedBy |
| name |
| underlayId |
This object has no members.
Description of the underlay
Format: free
Max length: 255
SDK attribute: description
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.
SDK attribute: embeddedMetadata
Specify if scope of entity is Data center or Enterprise level
Allowed values: ENTERPRISE, GLOBAL
SDK attribute: entityScope
External object ID. Used for integration with third party systems
Format: free
SDK attribute: externalID
ID of the user who last updated the object.
Format: free
SDK attribute: lastUpdatedBy
Name of the underlay
Format: free
Min length: 1
Max length: 255
SDK attribute: name
Used to identify and make a distinction between different Underlays with an autogenerated integer.
Min value: 1
Max value: 65535
SDK attribute: underlayId