Represents Netconf Gateway object.
Read only ID of the associated gateway security object.
Format: free
SDK attribute: associatedGatewaySecurityID
Readonly Id of the associated gateway security profile object
Format: free
SDK attribute: associatedGatewaySecurityProfileID
UUID of the Netconf Profile associated to this gateway.
Format: free
SDK attribute: associatedNetconfProfileID
Read only ID of the associated gateway information object
Format: free
SDK attribute: associatedNSGInfoID
The Auto Discovered Gateway associated with this Gateway Instance
Format: free
SDK attribute: autoDiscGatewayID
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)
Format: free
SDK attribute: BIOSReleaseDate
BIOS Version (eg. 0.5.1)
Format: free
SDK attribute: BIOSVersion
The bootstrap details associated with this Gateway. NOTE: This is a read only property, it can only be set during creation of a gateway.
Format: free
SDK attribute: bootstrapID
The bootstrap status of this Gateway. NOTE: This is a read only property.
Allowed values: ACTIVE, CERTIFICATE_SIGNED, INACTIVE, NOTIFICATION_APP_REQ_ACK, NOTIFICATION_APP_REQ_SENT, QUARANTINED, REVOKED
SDK attribute: bootstrapStatus
The Processor Type as reported during bootstrapping.
Format: free
SDK attribute: CPUType
Identifier of the Gateway, based on the systemID which is generated when the instance is created in VSD.
Format: free
SDK attribute: datapathID
A description of the Gateway
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
The enterprise associated with this Gateway. This is a read only attribute
Format: free
SDK attribute: enterpriseID
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
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.
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
A boolean flag indicating the status of the gateway.
Default value: false
SDK attribute: gatewayConnected
The model string of the gateway. Applicable to netconf managed gateways
Format: free
Max length: 255
SDK attribute: gatewayModel
The Gateway Software Version as reported during bootstrapping.
Format: free
SDK attribute: gatewayVersion
ID of the user who last updated the object.
Format: free
SDK attribute: lastUpdatedBy
Versions of monitored libraries currently installed on the Gateway.
Format: free
SDK attribute: libraries
Association to an object which contains location information about this gateway instance.
Format: free
SDK attribute: locationID
MAC Address of the first interface
Format: free
SDK attribute: MACAddress
The identifier of this gateway's management interface.
Format: free
Max length: 255
SDK attribute: managementID
Name of the Gateway
Format: free
Min length: 1
Max length: 255
SDK attribute: name
Patches that have been installed on the NSG
Format: free
SDK attribute: patches
The System ID of the peer gateway associated with this Gateway instance when it is discovered by the network manager (VSD) as being redundant.
Format: free
Max length: 255
SDK attribute: peer
Indicates that this gateway is pending state or state. When in pending state it cannot be modified from REST.
Format: free
SDK attribute: pending
The permitted action to USE/EXTEND this Gateway.
Allowed values: ALL, DEPLOY, EXTEND, INSTANTIATE, READ, USE
SDK attribute: permittedAction
Personality of the Gateway, cannot be changed after creation.
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
Product Name as reported during bootstrapping.
Format: free
SDK attribute: productName
The Redundancy Gateway Group associated with this Gateway Instance. This is a read only attribute
Format: free
SDK attribute: redundancyGroupID
The device's serial number
Format: free
SDK attribute: serialNumber
Identifier of the Gateway, cannot be modified after creation
Format: free
Min length: 1
Max length: 255
SDK attribute: systemID
The ID of the template that this Gateway was created from. This should be set when instantiating a Gateway
Format: free
SDK attribute: templateID
When set, VLAN-VNID mapping must be unique for all the vports of the gateway
SDK attribute: useGatewayVLANVNID
UUID of the device
Format: free
SDK attribute: UUID
The vendor of the gateway. Applicable to netconf managed gateways
Allowed values: CISCO, NOKIA
SDK attribute: vendor
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.
Format: free
Max length: 255
SDK attribute: vtep
The Zero Factor Bootstrapping (ZFB) Attribute that should be used to match the gateway on when it tries to bootstrap.
Allowed values: HOSTNAME, IP_ADDRESS, MAC_ADDRESS, NONE, SERIAL_NUMBER, UUID
Default value: NONE
SDK attribute: ZFBMatchAttribute
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.
Format: free
SDK attribute: ZFBMatchValue