GatewayTemplate

A gateway is your point of exit to an external network. It can be a physical or a virtual device. Gateways are templatable. You can attach gateway's VLANs to any existing host or bridge VPorts.

Overview

description string filterable   orderable  
embeddedMetadata list read only   autogenerated  
enterpriseID string read only  
entityScope enum (ENTERPRISE | GLOBAL) autogenerated  
externalID string filterable   orderable   locally unique  
infrastructureProfileID string
lastUpdatedBy string autogenerated  
name string required   filterable   orderable  
personality enum (DC7X50 | EVDF | EVDFB | HARDWARE_VTEP | NETCONF_7X50 | NETCONF_THIRDPARTY_HW_VTEP | NUAGE_210_WBX_32_Q | NUAGE_210_WBX_48_S | OTHER | UNMANAGED_GATEWAY | VDFG | VRSB | VRSG | VSA | VSG) required   creation only   filterable   orderable  

API Resource

/gatewaytemplates/id
delete get put

Parents

/enterprises/id/gatewaytemplates
get post
/gatewaytemplates
get post

Children

/gatewaytemplates/id/metadatas
get post
/gatewaytemplates/id/globalmetadatas
get post put
/gatewaytemplates/id/porttemplates
get post

Members

This object has no members.

Attributes documentation

description string filterable   orderable  
Discussion

A description of the Gateway


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

enterpriseID string read only  
Discussion

The enterprise associated with this Gateway. This is a read only attribute


Charateristics

Format: free
SDK attribute: enterpriseID

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

infrastructureProfileID string
Discussion

The ID of the associated Infrastructure Gateway Profile tied to this instance of a Gateway Template.


Charateristics

Format: free
SDK attribute: infrastructureProfileID

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 Gateway


Charateristics

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

personality enum required   creation only   filterable   orderable  
Discussion

Personality of the Gateway, cannot be changed after creation.


Charateristics

Allowed values: DC7X50, EVDF, EVDFB, HARDWARE_VTEP, NETCONF_7X50, NETCONF_THIRDPARTY_HW_VTEP, NUAGE_210_WBX_32_Q, NUAGE_210_WBX_48_S, OTHER, UNMANAGED_GATEWAY, VDFG, VRSB, VRSG, VSA, VSG
SDK attribute: personality