Represents a Network Service Gateway.
Readonly 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
Readonly Id of the associated nsg info object
Format: free
SDK attribute: associatedNSGInfoID
The Auto Discovered Gateway associated with this Gateway Instance
Format: free
SDK attribute: autoDiscGatewayID
The bootstrap details associated with this NSGateway. NOTE: this is a read only property, it can only be set during creation of an NSG
Format: free
SDK attribute: bootstrapID
The bootstrap status of this NSGateway. NOTE: this is a read only property
Allowed values: ACTIVE, CERTIFICATE_SIGNED, INACTIVE, NOTIFICATION_APP_REQ_ACK, NOTIFICATION_APP_REQ_SENT
Format: free
SDK attribute: bootstrapStatus
Status resulting from a manually triggered configuration reload operation on an NSG. This value only reflects the state for a manual action requested by the operator, not the automatic periodic configuration reload triggered by the NSG itself.
Allowed values: APPLIED, FAILED_TO_APPLY, PENDING, SENT, UNKNOWN
Default value: UNKNOWN
SDK attribute: configurationReloadState
NSG Configuration status represents the NSG update state following a query by the NSG to get the latest version of the infraconfig.json file. This status will be updated following a Bootstrap request or a Configuration Reload. Success means that the NSG was able to apply the changes included in the latest infraconfig.json file. A Failure response will be returned if the NSG was unable to apply the changes; this is normally accompanied with a rollback of the NSG to the previous configuration.
Allowed values: FAILURE, SUCCESS, UNKNOWN
Default value: UNKNOWN
SDK attribute: configurationStatus
The NSG Processor Type
Format: free
SDK attribute: CPUType
Identifier of the Gateway, based on the systemId
Format: free
SDK attribute: datapathID
Indicates the SSH Service state on a NSG. This value is derived based on the SSHService configuration on the NSG and the associated Gateway Template.
Allowed values: INHERITED_DISABLED, INHERITED_ENABLED, INSTANCE_DISABLED, INSTANCE_ENABLED, UNKNOWN
SDK attribute: derivedSSHServiceState
A description of the Gateway
Format: free
Max length: 255
SDK attribute: description
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
Format: free
SDK attribute: entityScope
External object ID. Used for integration with third party systems
Format: free
SDK attribute: externalID
The NSG Type
Allowed values: ANY, NSG_E, NSG_V
SDK attribute: family
Indicates the SSH Service state which is configured on the associated template instance.
Allowed values: DISABLED, ENABLED
Default value: ENABLED
SDK attribute: inheritedSSHServiceState
Time stamp of the last known configuration update of the NSG. This timestamp gets updated when a bootstrap is successful or when a configuration reload request triggered by VSD is successful.
Default value: -1
SDK attribute: lastConfigurationReloadTimestamp
ID of the user who last updated the object.
Format: free
SDK attribute: lastUpdatedBy
Transient representation of the same property on NSGInfo.
Format: free
SDK attribute: libraries
The NSGateway's Location. NOTE: this is a read only property, it can only be set through the location object
Format: free
SDK attribute: locationID
MAC Address of the NSG
Format: free
SDK attribute: MACAddress
Name of the Gateway
Format: free
Min length: 1
Max length: 255
SDK attribute: name
This attribute is deprecated in version 4.0.
Format: free
SDK attribute: NATTraversalEnabled
The NSG Version
Format: free
SDK attribute: NSGVersion
Operation mode of NSGateway
Format: free
SDK attribute: operationMode
Operation Status of NSGateway
Format: free
SDK attribute: operationStatus
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 - NSG, cannot be changed after creation.
Allowed values: DC7X50, HARDWARE_VTEP, NSG, NSGBR, NSGDUC, OTHER, VRSG, VSA, VSG
SDK attribute: personality
The Redundancy Gateway Group associated with this Gateway Instance. This is a read only attribute
Format: free
SDK attribute: redundancyGroupID
The NSG's serial number
Format: free
SDK attribute: serialNumber
The part number of the NSG
Format: free
SDK attribute: SKU
Indicates if SSH Service is enabled/disabled on a NSG. The value configured for this attribute is used only when instanceSSHOverride is allowed on the associated Gateway Template.
Allowed values: DISABLED, ENABLED, INHERITED
Default value: INHERITED
SDK attribute: SSHService
Identifier of the Gateway, cannot be modified after creation
Format: free
Min length: 1
Max length: 255
SDK attribute: systemID
Maximum Segment Size for TCP(min = 576, max = 7812).
Default value: 1330
Min value: 576
Max value: 7812
SDK attribute: TCPMaximumSegmentSize
Boolean flag to indicate whether MSS on TCP is enabled or not
Default value: false
SDK attribute: TCPMSSEnabled
The ID of the template that this Gateway was created from. This should be set when instantiating a Gateway
Format: free
SDK attribute: templateID
TPM Status of the NSG based on the information received by the device during bootstrapping or upgrade.
Allowed values: DISABLED, ENABLED_NOT_OPERATIONAL, ENABLED_OPERATIONAL, UNKNOWN
Default value: UNKNOWN
SDK attribute: TPMStatus
The Redhat UUID of the NSG
Format: free
SDK attribute: UUID