Gateway API Reference 5.0

Gateway

Represents Gateway object.

Overview

associatedGatewaySecurityID	string	read only
associatedGatewaySecurityProfileID	string	read only
associatedNetconfProfileID	string
associatedNSGInfoID	string	read only
autoDiscGatewayID	string	read only
BIOSReleaseDate	string	read only
BIOSVersion	string	read only
bootstrapID	string	read only
bootstrapStatus	enum (ACTIVE \| CERTIFICATE_SIGNED \| INACTIVE \| NOTIFICATION_APP_REQ_ACK \| NOTIFICATION_APP_REQ_SENT)	read only
CPUType	string	read only
datapathID	string	read only creation only
description	string	filterable orderable
enterpriseID	string	read only
entityScope	enum (ENTERPRISE \| GLOBAL)	autogenerated
externalID	string	filterable orderable locally unique
family	enum (ANY \| NSG_AMI \| NSG_AZ \| NSG_C \| NSG_E \| NSG_E200 \| NSG_E300 \| NSG_V \| NSG_X \| NSG_X200 \| VRS)	read only
gatewayConnected	boolean	read only
gatewayModel	string	read only
gatewayVersion	string	read only
lastUpdatedBy	string	autogenerated
libraries	string	read only
locationID	string	read only
MACAddress	string	read only
managementID	string	filterable orderable
name	string	required filterable orderable
patches	string	read only
peer	string	filterable orderable
pending	boolean	filterable
permittedAction	enum (ALL \| DEPLOY \| EXTEND \| INSTANTIATE \| READ \| USE)
personality	enum (DC7X50 \| EVDF \| EVDFB \| HARDWARE_VTEP \| NETCONF_7X50 \| NETCONF_THIRDPARTY_HW_VTEP \| NUAGE_210_WBX_32_Q \| NUAGE_210_WBX_48_S \| OTHER \| VDFG \| VRSB \| VRSG \| VSA \| VSG)	creation only filterable orderable
productName	string	read only
redundancyGroupID	string	read only
serialNumber	string	read only
systemID	string	read only creation only filterable orderable
templateID	string
useGatewayVLANVNID	boolean
UUID	string	read only
vendor	enum (CISCO)	read only
vtep	string	filterable orderable
ZFBMatchAttribute	enum (HOSTNAME \| IP_ADDRESS \| MAC_ADDRESS \| NONE \| SERIAL_NUMBER \| UUID)
ZFBMatchValue	string

API Resource

/gateways/id

delete get put

Parents

/enterprises/id/gateways

get post

/redundancygroups/id/gateways

get put

/gateways

get post

/l2domains/id/gateways

get

Children

/gateways/id/l2domains

get

/gateways/id/macfilterprofiles

get

/gateways/id/sapegressqosprofiles

get

/gateways/id/sapingressqosprofiles

get

/gateways/id/gatewaysecurities

get

/gateways/id/deploymentfailures

get

/gateways/id/permissions

get post

/gateways/id/services

get post

/gateways/id/metadatas

get post

/gateways/id/egressprofiles

get post

/gateways/id/alarms

get

/gateways/id/globalmetadatas

get post put

/gateways/id/infraconfig

get

/gateways/id/ingressprofiles

get post

/gateways/id/enterprisepermissions

get post

/gateways/id/jobs

get post

/gateways/id/locations

get

/gateways/id/domains

get

/gateways/id/bootstraps

get

/gateways/id/bootstrapactivations

post

/gateways/id/ports

get post

/gateways/id/ipfilterprofiles

get

/gateways/id/ipv6filterprofiles

get

/gateways/id/subnets

get

/gateways/id/eventlogs

get

Members

/gateways/id/patnatpools

get put

Attributes documentation

associatedGatewaySecurityID string read only

Discussion

Read only ID of the associated gateway security object.

Charateristics

Format: free
SDK attribute: associatedGatewaySecurityID

associatedGatewaySecurityProfileID string read only

Discussion

Readonly Id of the associated gateway security profile object

Charateristics

Format: free
SDK attribute: associatedGatewaySecurityProfileID

associatedNetconfProfileID string

Discussion

UUID of the Netconf Profile associated to this gateway.

Charateristics

Format: free
SDK attribute: associatedNetconfProfileID

associatedNSGInfoID string read only

Discussion

Read only ID of the associated gateway information object

Charateristics

Format: free
SDK attribute: associatedNSGInfoID

autoDiscGatewayID string read only

Discussion

The Auto Discovered Gateway associated with this Gateway Instance

Charateristics

Format: free
SDK attribute: autoDiscGatewayID

BIOSReleaseDate string read only

Discussion

Release Date of the BIOS. The format can vary based on the manufacturer but normally includes year/month/day or year/week details (eg. 01/01/2011 or 2018/06/15 or 2018/22)

Charateristics

Format: free
SDK attribute: BIOSReleaseDate

BIOSVersion string read only

Discussion

BIOS Version (eg. 0.5.1)

Charateristics

Format: free
SDK attribute: BIOSVersion

bootstrapID string read only

Discussion

The bootstrap details associated with this Gateway. NOTE: This is a read only property, it can only be set during creation of a gateway.

Charateristics

Format: free
SDK attribute: bootstrapID

bootstrapStatus enum read only

Discussion

The bootstrap status of this Gateway. NOTE: This is a read only property.

Charateristics

Allowed values: ACTIVE, CERTIFICATE_SIGNED, INACTIVE, NOTIFICATION_APP_REQ_ACK, NOTIFICATION_APP_REQ_SENT
Format: free
SDK attribute: bootstrapStatus

CPUType string read only

Discussion

The Processor Type as reported during bootstrapping.

Charateristics

Format: free
SDK attribute: CPUType

datapathID string read only creation only

Discussion

Identifier of the Gateway, based on the systemID which is generated when the instance is created in VSD.

Charateristics

Format: free
SDK attribute: datapathID

description string filterable orderable

Discussion

A description of the Gateway

Charateristics

Format: free
Max length: 255
SDK attribute: description

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

family enum read only

Discussion

The family type of the gateway based on common characteristics with other members of a particular variation of an NSG hardware or of a virtual deployment.

Charateristics

Allowed values: ANY, NSG_AMI, NSG_AZ, NSG_C, NSG_E, NSG_E200, NSG_E300, NSG_V, NSG_X, NSG_X200, VRS
SDK attribute: family

gatewayConnected boolean read only

Discussion

A boolean flag indicating the status of the gateway.

Charateristics

Default value: false
SDK attribute: gatewayConnected

gatewayModel string read only

Discussion

The model string of the gateway. Applicable to netconf managed gateways

Charateristics

Format: free
Max length: 255
SDK attribute: gatewayModel

gatewayVersion string read only

Discussion

The Gateway Software Version as reported during bootstrapping.

Charateristics

Format: free
SDK attribute: gatewayVersion

lastUpdatedBy string autogenerated

Discussion

ID of the user who last updated the object.

Charateristics

Format: free
SDK attribute: lastUpdatedBy

libraries string read only

Discussion

Versions of monitored libraries currently installed on the Gateway.

Charateristics

Format: free
SDK attribute: libraries

locationID string read only

Discussion

Association to an object which contains location information about this gateway instance.

Charateristics

Format: free
SDK attribute: locationID

MACAddress string read only

Discussion

MAC Address of the first interface

Charateristics

Format: free
SDK attribute: MACAddress

managementID string filterable orderable

Discussion

The identifier of this gateway's management interface.

Charateristics

Format: free
Max length: 255
SDK attribute: managementID

name string required filterable orderable

Discussion

Name of the Gateway

Charateristics

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

patches string read only

Discussion

Patches that have been installed on the NSG

Charateristics

Format: free
SDK attribute: patches

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 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, VDFG, VRSB, VRSG, VSA, VSG
SDK attribute: personality

productName string read only

Discussion

Product Name as reported during bootstrapping.

Charateristics

Format: free
SDK attribute: productName

redundancyGroupID string read only

Discussion

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

Charateristics

Format: free
SDK attribute: redundancyGroupID

serialNumber string read only

Discussion

The device's serial number

Charateristics

Format: free
SDK attribute: serialNumber

systemID string read only creation only 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

Discussion

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

Charateristics

SDK attribute: useGatewayVLANVNID

UUID string read only

Discussion

UUID of the device

Charateristics

Format: free
SDK attribute: UUID

vendor enum read only

Discussion

The vendor of the gateway. Applicable to netconf managed gateways

Charateristics

Allowed values: CISCO
SDK attribute: vendor

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

ZFBMatchAttribute enum

Discussion

The Zero Factor Bootstrapping (ZFB) Attribute that should be used to match the gateway on when it tries to bootstrap.

Charateristics

Allowed values: HOSTNAME, IP_ADDRESS, MAC_ADDRESS, NONE, SERIAL_NUMBER, UUID
Default value: NONE
SDK attribute: ZFBMatchAttribute

ZFBMatchValue string

Discussion

The Zero Factor Bootstrapping (ZFB) value that needs to match with the gateway during the bootstrap attempt. This value needs to match with the ZFB Match Attribute.

Charateristics

Format: free
SDK attribute: ZFBMatchValue