Gateway

Represents Gateway object.

Overview

autoDiscGatewayID string
description string filterable   orderable  
enterpriseID string
entityScope enum (ENTERPRISE | GLOBAL) autogenerated   filterable   orderable  
externalID string filterable   orderable   locally unique  
lastUpdatedBy string autogenerated  
name string required   filterable   orderable  
peer string filterable   orderable  
pending boolean filterable  
permittedAction enum (ALL | DEPLOY | EXTEND | INSTANTIATE | READ | USE)
personality enum (DC7X50 | HARDWARE_VTEP | NSG | OTHER | VRSB | VRSG | VSA | VSG) required   creation only   filterable   orderable  
redundancyGroupID string
systemID string filterable   orderable  
templateID string
useGatewayVLANVNID boolean filterable   orderable  
vtep string filterable   orderable  

API Resource

/gateways/id
delete get put

Parents

/enterprises/id/gateways
get post
/redundancygroups/id/gateways
get put
/gateways
get post

Children

/gateways/id/patnatpools
get put
/gateways/id/permissions
get post
/gateways/id/services
get post
/gateways/id/metadatas
get post
/gateways/id/alarms
get
/gateways/id/globalmetadatas
get post put
/gateways/id/enterprisepermissions
get post
/gateways/id/jobs
get post
/gateways/id/ports
get post
/gateways/id/eventlogs
get

Members

This object has no members.

Attributes documentation

autoDiscGatewayID string
Discussion

The Auto Discovered Gateway associated with this Gateway Instance

Charateristics

Format: free
SDK attribute: autoDiscGatewayID

description string filterable   orderable  
Discussion

A description of the Gateway

Charateristics

Format: free
Max length: 255
SDK attribute: description

enterpriseID string
Discussion

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

Charateristics

Format: free
SDK attribute: enterpriseID

entityScope enum autogenerated   filterable   orderable  
Discussion

Specify if scope of entity is Data center or Enterprise level

Charateristics

Allowed values: ENTERPRISE, GLOBAL
Format: free
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 Gateway

Charateristics

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

peer string filterable   orderable  
Discussion

The System ID of the peer gateway associated with this Gateway instance when it is discovered by the network manager (VSD) as being redundant.

Charateristics

Format: free
Max length: 255
SDK attribute: peer

pending boolean filterable  
Discussion

Indicates that this gateway is pending state or state. When in pending state it cannot be modified from REST.

Charateristics

Format: free
SDK attribute: pending

permittedAction enum
Discussion

The permitted action to USE/EXTEND this Gateway.

Charateristics

Allowed values: ALL, DEPLOY, EXTEND, INSTANTIATE, READ, USE
SDK attribute: permittedAction

personality enum required   creation only   filterable   orderable  
Discussion

Personality of the Gateway, cannot be changed after creation.

Charateristics

Allowed values: DC7X50, HARDWARE_VTEP, NSG, OTHER, VRSB, VRSG, VSA, VSG
SDK attribute: personality

redundancyGroupID string
Discussion

The Redundancy Gateway Group associated with this Gateway Instance. This is a read only attribute

Charateristics

Format: free
SDK attribute: redundancyGroupID

systemID string filterable   orderable  
Discussion

Identifier of the Gateway, cannot be modified after creation

Charateristics

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

templateID string
Discussion

The ID of the template that this Gateway was created from. This should be set when instantiating a Gateway

Charateristics

Format: free
SDK attribute: templateID

useGatewayVLANVNID boolean filterable   orderable  
Discussion

When set, VLAN-VNID mapping must be unique for all the vports of the gateway

Charateristics

SDK attribute: useGatewayVLANVNID

vtep string filterable   orderable  
Discussion

Represent the system ID or the Virtual IP of a service used by a Gateway (VSG for now) to establish a tunnel with a remote VSG or hypervisor. The format of this field is consistent with an IP address.

Charateristics

Format: free
Max length: 255
SDK attribute: vtep