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.
Release Date of the AAR Application
Format: free
SDK attribute: AARApplicationReleaseDate
The AAR Application Version
Format: free
SDK attribute: AARApplicationVersion
Read only ID of the associated gateway security object.
Format: free
SDK attribute: associatedGatewaySecurityID
Read only ID of the associated gateway security profile object
Format: free
SDK attribute: associatedGatewaySecurityProfileID
Read only ID of the associated NSG info object
Format: free
SDK attribute: associatedNSGInfoID
The ID of the migration profile associated to this NSG.
Format: free
Max length: 255
SDK attribute: associatedNSGMigrationProfileID
The UUID of the NSG Upgrade Profile associated to this NSG instance.
Format: free
SDK attribute: associatedNSGUpgradeProfileID
The ID of the associated Overlay Management Profile
Format: free
SDK attribute: associatedOverlayManagementProfileID
The Auto Discovered Gateway associated with this Gateway Instance
Format: free
SDK attribute: autoDiscGatewayID
Release Date of the NSG BiOS
Format: free
SDK attribute: BIOSReleaseDate
NSG BIOS Version
Format: free
Max length: 255
SDK attribute: BIOSVersion
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, MIGRATING, NOTIFICATION_APP_REQ_ACK, NOTIFICATION_APP_REQ_SENT, QUARANTINED, REVOKED
SDK attribute: bootstrapStatus
The number of days for which the NSG's certificate is valid.
Max value: 2147483647
SDK attribute: certValidityDays
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
Describes whether the load balancing behavior used for Fc's in inherited from enterprise or disabled.
Allowed values: DISABLED, INHERITED
Default value: INHERITED
SDK attribute: configureLoadBalancing
CoS Value for Self Generated Traffic (Control Traffic). Min is 0 and Max is 7
Default value: 7
Max value: 7
SDK attribute: controlTrafficCOSValue
DSCP Value for Self Generated Traffic (Control Traffic). Min is 0 and Max is 63
Default value: 56
Max value: 63
SDK attribute: controlTrafficDSCPValue
Current CPU allocation for network accelerated gateways. Displays total number of cores and those isolated.
Format: free
Max length: 255
SDK attribute: CPUCoreAllocation
The NSG Processor Type as reported during bootstrapping.
Format: free
SDK attribute: CPUType
Time stamp when this object was created.
SDK attribute: creationDate
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
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 NSG Family type.
Allowed values: ANY, NSG_AMI, NSG_AZ, NSG_C, NSG_E, NSG_E200, NSG_E300, NSG_V, NSG_X, NSG_X200
SDK attribute: family
List of supported functions. This is only relevant for NSG-UBR and will be set to UBR by default in case an NSG-UBR is created. For a regular NSG, this will be set to null.
Allowed values: GATEWAY, HUB, UBR
SDK attribute: functions
Release version of NSG, which is used to determine the feature capabilties of NSG.
Format: free
Max length: 255
SDK attribute: gatewayConfigRawVersion
Interpreted version of NSG, which is used to determine the feature capabilities of NSG.
Format: free
Max length: 255
SDK attribute: gatewayConfigVersion
Indicates status of this gateway
Default value: false
SDK attribute: gatewayConnected
The size and number of huge pages for an NSG that is running in network accelerated mode. Hugepage values states the portion of memory reserved for network accelerated services.
Format: free
Max length: 255
SDK attribute: hugePageSetting
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
Time stamp when this object was last updated.
SDK attribute: lastUpdatedDate
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
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.
Allowed values: NONE, PERFORMANCE, SESSION_OPTIMIZED, TP_AWARE, VNF_AWARE, WIFI_OPTIMIZED, WIFI_TP_AWARE, WIFI_VNF_AWARE
Default value: NONE
SDK attribute: networkAcceleration
The NSG Version (software) as reported during bootstrapping or following an upgrade.
Format: free
SDK attribute: NSGVersion
Operation mode of NSGateway
Format: free
SDK attribute: operationMode
Operation Status of NSGateway
Format: free
SDK attribute: operationStatus
Identifies the user that has created this object.
Format: free
SDK attribute: owner
Boolean flag to indicate whether Path MTU Discovery is enabled or not.
Default value: true
SDK attribute: pathMTUDiscovery
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: NSG, NSGBR, NSGDUC
SDK attribute: personality
NSG Product Name as reported during bootstrapping.
Format: free
Max length: 255
SDK attribute: productName
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
Indicates if Security Group Tag Propagation is enabled on Network Accelerated NSG and Network Accelerated UBR with HUB or HUB and DUC function(s).
Default value: false
SDK attribute: SGTPropagationEnabled
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
Statistics Profile to which this NSGateway is associated to.
Format: free
Max length: 255
SDK attribute: statsProfileID
The minimal logging level of the messages the NSG will be reporting to the external syslog server that has been configured on the Infrastructure Gateway Profile.
Allowed values: ALERT, CRITICAL, EMERGENCY, ERROR, INFO, NOTICE, WARNING
Default value: INFO
SDK attribute: syslogLevel
Identifier of the Gateway, cannot be modified after creation
Format: free
Min length: 1
Max length: 255
SDK attribute: systemID
Maximum TCP segment size (min = 576, max = 7812); value 0 indicates the use of dynamically computed MSS.
Default value: 1330
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
Indicates if Threat Prevention capability enabled on NSG.
Default value: false
SDK attribute: threatPreventionEnabled
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
TPM (Trusted Platform Module) version as reported by the NSG.
Format: free
Max length: 255
SDK attribute: TPMVersion
Indicates if the UBR will perform tunnel shaping to the NSG when a tunnel shaper is associated to the NSG.
Allowed values: DISABLED, ENABLED
Default value: DISABLED
SDK attribute: tunnelShaping
The Redhat UUID of the NSG
Format: free
SDK attribute: UUID
Version of the latest imported Application Signatures.
Format: free
SDK attribute: VSDAARApplicationVersion
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, NSGATEWAY_ID, 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