NSGateway

Network Services Gateways are a policy enforcement end-points responsible for the delivery of networking services. NSG access ports/VLANs may be attached to existing host or bridge VPorts.

Overview

AARApplicationReleaseDate string read only  
AARApplicationVersion string read only  
associatedGatewaySecurityID string read only  
associatedGatewaySecurityProfileID string read only  
associatedNSGInfoID string read only  
associatedNSGUpgradeProfileID string
associatedOverlayManagementProfileID string
autoDiscGatewayID string read only  
BIOSReleaseDate string
BIOSVersion string
bootstrapID string read only  
bootstrapStatus enum (ACTIVE | CERTIFICATE_SIGNED | INACTIVE | NOTIFICATION_APP_REQ_ACK | NOTIFICATION_APP_REQ_SENT) read only  
configurationReloadState enum (APPLIED | FAILED_TO_APPLY | PENDING | SENT | UNKNOWN)
configurationStatus enum (FAILURE | SUCCESS | UNKNOWN)
controlTrafficCOSValue integer filterable   orderable  
controlTrafficDSCPValue integer filterable   orderable  
CPUType string
datapathID string read only  
derivedSSHServiceState enum (INHERITED_DISABLED | INHERITED_ENABLED | INSTANCE_DISABLED | INSTANCE_ENABLED | UNKNOWN)
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)
functions list (GATEWAY | UBR)
gatewayConnected boolean read only  
inheritedSSHServiceState enum (DISABLED | ENABLED) deprecated  
lastConfigurationReloadTimestamp integer read only  
lastUpdatedBy string autogenerated  
libraries string
locationID string read only  
MACAddress string
name string required   filterable   orderable  
NATTraversalEnabled boolean deprecated  
networkAcceleration enum (NONE | PERFORMANCE) filterable  
NSGVersion string
operationMode string
operationStatus string
pending boolean filterable  
permittedAction enum (ALL | DEPLOY | EXTEND | INSTANTIATE | READ | USE)
personality enum (NSG | NSGBR | NSGDUC) creation only   filterable   orderable  
productName string
redundancyGroupID string read only  
serialNumber string
SKU string
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)
TPMVersion string read only  
UUID string
VSDAARApplicationVersion string read only  
ZFBMatchAttribute enum (HOSTNAME | IP_ADDRESS | MAC_ADDRESS | NONE | NSGATEWAY_ID | SERIAL_NUMBER | UUID)
ZFBMatchValue string

API Resource

/nsgateways/id
delete get put

Parents

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

Children

/nsgateways/id/patches
get
/nsgateways/id/gatewaysecurities
get
/nsgateways/id/permissions
get post
/nsgateways/id/metadatas
get post
/nsgateways/id/wirelessports
get post put
/nsgateways/id/alarms
get
/nsgateways/id/globalmetadatas
get post put
/nsgateways/id/vnfs
get
/nsgateways/id/infraconfig
get put
/nsgateways/id/enterprisepermissions
get post
/nsgateways/id/jobs
get post
/nsgateways/id/locations
get
/nsgateways/id/commands
get post
/nsgateways/id/bootstraps
get
/nsgateways/id/bootstrapactivations
post
/nsgateways/id/portinfos
get
/nsgateways/id/uplinkconnections
get
/nsgateways/id/nsgatewaysmonitors
get
/nsgateways/id/nsgatewayssummaries
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

AARApplicationReleaseDate string read only  
Discussion

Release Date of the AAR Application

Charateristics

Format: free
SDK attribute: AARApplicationReleaseDate

AARApplicationVersion string read only  
Discussion

The AAR Application Version

Charateristics

Format: free
SDK attribute: AARApplicationVersion

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

Read only ID of the associated gateway security profile object

Charateristics

Format: free
SDK attribute: associatedGatewaySecurityProfileID

associatedNSGInfoID string read only  
Discussion

Read only ID of the associated NSG info object

Charateristics

Format: free
SDK attribute: associatedNSGInfoID

associatedNSGUpgradeProfileID string
Discussion

The UUID of the NSG Upgrade Profile associated to this NSG instance.

Charateristics

Format: free
SDK attribute: associatedNSGUpgradeProfileID

associatedOverlayManagementProfileID string
Discussion

The ID of the associated Overlay Management Profile

Charateristics

Format: free
SDK attribute: associatedOverlayManagementProfileID

autoDiscGatewayID string read only  
Discussion

The Auto Discovered Gateway associated with this Gateway Instance

Charateristics

Format: free
SDK attribute: autoDiscGatewayID

BIOSReleaseDate string
Discussion

Release Date of the NSG BiOS

Charateristics

Format: free
SDK attribute: BIOSReleaseDate

BIOSVersion string
Discussion

NSG BIOS Version

Charateristics

Format: free
Max length: 255
SDK attribute: BIOSVersion

bootstrapID string read only  
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 read only  
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
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

controlTrafficCOSValue integer filterable   orderable  
Discussion

CoS Value for Self Generated Traffic (Control Traffic). Min is 0 and Max is 7

Charateristics

Default value: 7
Max value: 7
SDK attribute: controlTrafficCOSValue

controlTrafficDSCPValue integer filterable   orderable  
Discussion

DSCP Value for Self Generated Traffic (Control Traffic). Min is 0 and Max is 63

Charateristics

Default value: 56
Max value: 63
SDK attribute: controlTrafficDSCPValue

CPUType string
Discussion

The NSG Processor Type as reported during bootstrapping.

Charateristics

Format: free
SDK attribute: CPUType

datapathID string read only  
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 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
Discussion

The NSG Family type.

Charateristics

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

functions list
Discussion

List of supported functions

Charateristics

Allowed values: GATEWAY, UBR
Default value: UBR
SDK attribute: functions

gatewayConnected boolean read only  
Discussion

Indicates status of this gateway

Charateristics

Default value: false
SDK attribute: gatewayConnected

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 read only  
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 read only  
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
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 filterable  
Discussion

Attribute that enables or disables Network Acceleration (DPDK) on the NSGateway instance. Changing the value of this field will cause the device to restart at the next configuration reload.

Charateristics

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

NSGVersion string
Discussion

The NSG Version (software) as reported during bootstrapping or following an upgrade.

Charateristics

Format: free
SDK attribute: NSGVersion

operationMode string
Discussion

Operation mode of NSGateway

Charateristics

Format: free
SDK attribute: operationMode

operationStatus string
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: NSG, NSGBR, NSGDUC
SDK attribute: personality

productName string
Discussion

NSG Product Name as reported during bootstrapping.

Charateristics

Format: free
Max length: 255
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
Discussion

The NSG's serial number

Charateristics

Format: free
SDK attribute: serialNumber

SKU string
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

TPMVersion string read only  
Discussion

TPM (Trusted Platform Module) version as reported by the NSG.

Charateristics

Format: free
Max length: 255
SDK attribute: TPMVersion

UUID string
Discussion

The Redhat UUID of the NSG

Charateristics

Format: free
SDK attribute: UUID

VSDAARApplicationVersion string read only  
Discussion

Version of the latest imported Application Signatures.

Charateristics

Format: free
SDK attribute: VSDAARApplicationVersion

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, NSGATEWAY_ID, 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