NSGateway

Represents a Network Service Gateway.

Overview

associatedGatewaySecurityID string
associatedGatewaySecurityProfileID string
associatedNSGInfoID string
autoDiscGatewayID string
BIOSVersion string filterable   orderable  
bootstrapID string
bootstrapStatus enum (ACTIVE | CERTIFICATE_SIGNED | INACTIVE | NOTIFICATION_APP_REQ_ACK | NOTIFICATION_APP_REQ_SENT)
configurationReloadState enum (APPLIED | FAILED_TO_APPLY | PENDING | SENT | UNKNOWN)
configurationStatus enum (FAILURE | SUCCESS | UNKNOWN)
CPUType string filterable   orderable  
datapathID string
derivedSSHServiceState enum (INHERITED_DISABLED | INHERITED_ENABLED | INSTANCE_DISABLED | INSTANCE_ENABLED | UNKNOWN)
description string filterable   orderable  
enterpriseID string
entityScope enum (ENTERPRISE | GLOBAL) autogenerated   filterable   orderable  
externalID string filterable   orderable   locally unique  
family enum (ANY | NSG_E | NSG_V) filterable   orderable  
inheritedSSHServiceState enum (DISABLED | ENABLED) deprecated  
lastConfigurationReloadTimestamp integer
lastUpdatedBy string autogenerated  
libraries string
locationID string
MACAddress string filterable   orderable  
name string required   filterable   orderable  
NATTraversalEnabled boolean deprecated  
networkAcceleration enum (NONE | NORMAL | OPTIMAL | PERFORMANCE)
NSGVersion string filterable   orderable  
operationMode string filterable   orderable  
operationStatus string filterable   orderable  
pending boolean filterable  
permittedAction enum (ALL | DEPLOY | EXTEND | INSTANTIATE | READ | USE)
personality enum (DC7X50 | HARDWARE_VTEP | NSG | NSGBR | NSGDUC | OTHER | VRSG | VSA | VSG) creation only   filterable   orderable  
productName string filterable   orderable  
redundancyGroupID string
serialNumber string filterable   orderable  
SKU string filterable   orderable  
SSHService enum (DISABLED | ENABLED | INHERITED)
systemID string filterable   orderable  
TCPMaximumSegmentSize integer
TCPMSSEnabled boolean filterable   orderable  
templateID string required  
TPMStatus enum (DISABLED | ENABLED_NOT_OPERATIONAL | ENABLED_OPERATIONAL | UNKNOWN)
UUID string filterable   orderable  

API Resource

/nsgateways/id
delete get put

Parents

/enterprises/id/nsgateways
get post
/ducgroups/id/nsgateways
get put
/nsggroups/id/nsgateways
get put
/policyobjectgroups/id/nsgateways
get put
/nsgateways
get
/nsgredundancygroups/id/nsgateways
get put

Children

/nsgateways/id/gatewaysecurities
get
/nsgateways/id/permissions
get post
/nsgateways/id/metadatas
get post
/nsgateways/id/wirelessports
get post
/nsgateways/id/alarms
get
/nsgateways/id/globalmetadatas
get post put
/nsgateways/id/infraconfig
get put
/nsgateways/id/enterprisepermissions
get
/nsgateways/id/jobs
get post
/nsgateways/id/locations
get
/nsgateways/id/monitorscopes
get
/nsgateways/id/bootstraps
get
/nsgateways/id/bootstrapactivations
post
/nsgateways/id/uplinkconnections
get
/nsgateways/id/nsginfos
get
/nsgateways/id/nsports
get post put
/nsgateways/id/subnets
get
/nsgateways/id/eventlogs
get

Members

/nsgateways/id/patnatpools
get put

Attributes documentation

associatedGatewaySecurityID string
Discussion

Readonly Id of the associated gateway security object


Charateristics

Format: free
SDK attribute: associatedGatewaySecurityID

associatedGatewaySecurityProfileID string
Discussion

Readonly Id of the associated gateway security profile object


Charateristics

Format: free
SDK attribute: associatedGatewaySecurityProfileID

associatedNSGInfoID string
Discussion

Readonly Id of the associated nsg info object


Charateristics

Format: free
SDK attribute: associatedNSGInfoID

autoDiscGatewayID string
Discussion

The Auto Discovered Gateway associated with this Gateway Instance


Charateristics

Format: free
SDK attribute: autoDiscGatewayID

BIOSVersion string filterable   orderable  
Discussion

NSG BIOS Version


Charateristics

Format: free
Max length: 255
SDK attribute: BIOSVersion

bootstrapID string
Discussion

The bootstrap details associated with this NSGateway. NOTE: this is a read only property, it can only be set during creation of an NSG


Charateristics

Format: free
SDK attribute: bootstrapID

bootstrapStatus enum
Discussion

The bootstrap status of this NSGateway. 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

configurationReloadState enum
Discussion

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.


Charateristics

Allowed values: APPLIED, FAILED_TO_APPLY, PENDING, SENT, UNKNOWN
Default value: UNKNOWN
SDK attribute: configurationReloadState

configurationStatus enum
Discussion

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.


Charateristics

Allowed values: FAILURE, SUCCESS, UNKNOWN
Default value: UNKNOWN
SDK attribute: configurationStatus

CPUType string filterable   orderable  
Discussion

The NSG Processor Type


Charateristics

Format: free
SDK attribute: CPUType

datapathID string
Discussion

Identifier of the Gateway, based on the systemId


Charateristics

Format: free
SDK attribute: datapathID

derivedSSHServiceState enum
Discussion

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.


Charateristics

Allowed values: INHERITED_DISABLED, INHERITED_ENABLED, INSTANCE_DISABLED, INSTANCE_ENABLED, UNKNOWN
SDK attribute: derivedSSHServiceState

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

family enum filterable   orderable  
Discussion

The NSG Type


Charateristics

Allowed values: ANY, NSG_E, NSG_V
SDK attribute: family

inheritedSSHServiceState enum deprecated  
Discussion

Indicates the SSH Service state which is configured on the associated template instance.


Charateristics

Allowed values: DISABLED, ENABLED
Default value: ENABLED
SDK attribute: inheritedSSHServiceState

lastConfigurationReloadTimestamp integer
Discussion

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.


Charateristics

Default value: -1
SDK attribute: lastConfigurationReloadTimestamp

lastUpdatedBy string autogenerated  
Discussion

ID of the user who last updated the object.


Charateristics

Format: free
SDK attribute: lastUpdatedBy

libraries string
Discussion

Transient representation of the same property on NSGInfo.


Charateristics

Format: free
SDK attribute: libraries

locationID string
Discussion

The NSGateway's Location. NOTE: this is a read only property, it can only be set through the location object


Charateristics

Format: free
SDK attribute: locationID

MACAddress string filterable   orderable  
Discussion

MAC Address of the NSG


Charateristics

Format: free
SDK attribute: MACAddress

name string required   filterable   orderable  
Discussion

Name of the Gateway


Charateristics

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

NATTraversalEnabled boolean deprecated  
Discussion

This attribute is deprecated in version 4.0.


Charateristics

Format: free
SDK attribute: NATTraversalEnabled

networkAcceleration enum
Discussion

Network Acceleration type to be used when network acceleration is enabled


Charateristics

Allowed values: NONE, NORMAL, OPTIMAL, PERFORMANCE
Default value: NONE
SDK attribute: networkAcceleration

NSGVersion string filterable   orderable  
Discussion

The NSG Version


Charateristics

Format: free
SDK attribute: NSGVersion

operationMode string filterable   orderable  
Discussion

Operation mode of NSGateway


Charateristics

Format: free
SDK attribute: operationMode

operationStatus string filterable   orderable  
Discussion

Operation Status of NSGateway


Charateristics

Format: free
SDK attribute: operationStatus

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 - NSG, cannot be changed after creation.


Charateristics

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

productName string filterable   orderable  
Discussion

NSG Product Name


Charateristics

Format: free
Max length: 255
SDK attribute: productName

redundancyGroupID string
Discussion

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


Charateristics

Format: free
SDK attribute: redundancyGroupID

serialNumber string filterable   orderable  
Discussion

The NSG's serial number


Charateristics

Format: free
SDK attribute: serialNumber

SKU string filterable   orderable  
Discussion

The part number of the NSG


Charateristics

Format: free
SDK attribute: SKU

SSHService enum
Discussion

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.


Charateristics

Allowed values: DISABLED, ENABLED, INHERITED
Default value: INHERITED
SDK attribute: SSHService

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

TCPMaximumSegmentSize integer
Discussion

Maximum Segment Size for TCP(min = 576, max = 7812).


Charateristics

Default value: 1330
Min value: 576
Max value: 7812
SDK attribute: TCPMaximumSegmentSize

TCPMSSEnabled boolean filterable   orderable  
Discussion

Boolean flag to indicate whether MSS on TCP is enabled or not


Charateristics

Default value: false
SDK attribute: TCPMSSEnabled

templateID string required  
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

TPMStatus enum
Discussion

TPM Status of the NSG based on the information received by the device during bootstrapping or upgrade.


Charateristics

Allowed values: DISABLED, ENABLED_NOT_OPERATIONAL, ENABLED_OPERATIONAL, UNKNOWN
Default value: UNKNOWN
SDK attribute: TPMStatus

UUID string filterable   orderable  
Discussion

The Redhat UUID of the NSG


Charateristics

Format: free
SDK attribute: UUID