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.


  • name (Mandatory): Name of the underlay
  • last_updated_by: ID of the user who last updated the object.
  • last_updated_date: Time stamp when this object was last updated.
  • description: Description of the underlay
  • embedded_metadata: 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.
  • underlay_id: Used to identify and make a distinction between different Underlays with an autogenerated integer.
  • entity_scope: Specify if scope of entity is Data center or Enterprise level
  • creation_date: Time stamp when this object was created.
  • owner: Identifies the user that has created this object.
  • external_id: External object ID. Used for integration with third party systems


class fetcher
nupermission.NUPermission permissions
numetadata.NUMetadata metadatas
nuglobalmetadata.NUGlobalMetadata global_metadatas