NSGInfo

Device information coming from the NSG. That includes the hardware type of the NSG (CPU, memory, family), the version of BIOS, build information, and software application packages installed.

Overview

AARApplicationReleaseDate string read only   filterable   orderable  
AARApplicationVersion string read only   filterable   orderable  
associatedEntityType string read only  
associatedNSGatewayID string read only   autogenerated  
BIOSReleaseDate string filterable   orderable  
BIOSVersion string read only   filterable   orderable  
bootstrapStatus enum (ACTIVE | CERTIFICATE_SIGNED | INACTIVE | NOTIFICATION_APP_REQ_ACK | NOTIFICATION_APP_REQ_SENT) read only   autogenerated   filterable   orderable  
CACertificate object
certificate object
cmdDetailedStatus string read only  
cmdDetailedStatusCode integer read only   filterable   orderable  
cmdDownloadProgress object read only  
cmdID string read only  
cmdLastUpdatedDate time read only   filterable   orderable  
cmdStatus enum (ABANDONED | COMPLETED | FAILED | RUNNING | SKIPPED | STARTED | UNKNOWN) read only   filterable   orderable  
cmdType enum (NSG_DOWNLOAD_OS_IMAGE | NSG_UPGRADE_TO_IMAGE) read only   filterable   orderable  
CPUCoreAllocation string read only   filterable   orderable  
CPUType string read only   filterable   orderable  
enterpriseID string read only  
enterpriseName string read only   filterable   orderable  
entityScope enum (ENTERPRISE | GLOBAL) autogenerated  
externalID string filterable   orderable   locally unique  
family enum (ANY | NSG_AMI | NSG_AZ | NSG_C | NSG_DOCKER | NSG_E | NSG_E200 | NSG_E300 | NSG_V | NSG_X | NSG_X200) read only   filterable   orderable  
hugePageSetting string read only   filterable   orderable  
libraries string read only  
MACAddress string filterable   orderable  
name string read only   filterable   orderable  
NSGVersion string filterable   orderable  
patchesDetail string
personality enum (NSG | NSGBR | NSGDUC) read only   filterable   orderable  
productName string read only   filterable   orderable  
serialNumber string read only   filterable   orderable  
SKU string read only   filterable   orderable  
systemID string read only   filterable   orderable  
TPMStatus integer read only   filterable   orderable  
TPMVersion string read only   filterable   orderable  
UUID string read only   filterable   orderable  

API Resource

/nsginfos/id
get put

Parents

/nsginfos
get
/nsgateways/id/nsginfos
get

Children

This object has no children.

Members

This object has no members.

Attributes documentation

AARApplicationReleaseDate string read only   filterable   orderable  
Discussion

Release Date of the AAR Application

Charateristics

Format: free
SDK attribute: AARApplicationReleaseDate

AARApplicationVersion string read only   filterable   orderable  
Discussion

The AAR Application Version

Charateristics

Format: free
SDK attribute: AARApplicationVersion

associatedEntityType string read only  
Discussion

Object type of the associated entity.

Charateristics

Format: free
SDK attribute: associatedEntityType

associatedNSGatewayID string read only   autogenerated  
Discussion

The ID of the NSG from which the infomation was collected.

Charateristics

Format: free
SDK attribute: associatedNSGatewayID

BIOSReleaseDate string filterable   orderable  
Discussion

Release Date of the NSG BiOS

Charateristics

Format: free
SDK attribute: BIOSReleaseDate

BIOSVersion string read only   filterable   orderable  
Discussion

NSG BIOS Version as received from the NSG during bootstrap or a reboot. If the information exeeds 255 characters, the extra characters will be truncated.

Charateristics

Format: free
Max length: 255
SDK attribute: BIOSVersion

bootstrapStatus enum read only   autogenerated   filterable   orderable  
Discussion

The bootstrap status of the NSG from which the infomation was collected.

Charateristics

Allowed values: ACTIVE, CERTIFICATE_SIGNED, INACTIVE, NOTIFICATION_APP_REQ_ACK, NOTIFICATION_APP_REQ_SENT
SDK attribute: bootstrapStatus

CACertificate object
Discussion

The certficate metadata of NSG's certificate authority.

Charateristics

SDK attribute: CACertificate

certificate object
Discussion

The certificate metadata of NSG's current certficate.

Charateristics

SDK attribute: certificate

cmdDetailedStatus string read only  
Discussion

Detailed status of the current running or last run command.

Charateristics

Format: free
Max length: 255
SDK attribute: cmdDetailedStatus

cmdDetailedStatusCode integer read only   filterable   orderable  
Discussion

Numerical value representing the code mapping to detailed status of the current or last command operation.

Charateristics

Max value: 65535
SDK attribute: cmdDetailedStatusCode

cmdDownloadProgress object read only  
Discussion

DownloadProgress object representing the progress of Gateway image download.

Charateristics

SDK attribute: cmdDownloadProgress

cmdID string read only  
Discussion

Identifier of the running or last Command.

Charateristics

Format: free
Max length: 255
SDK attribute: cmdID

cmdLastUpdatedDate time read only   filterable   orderable  
Discussion

Time stamp when the command was last updated.

Charateristics

SDK attribute: cmdLastUpdatedDate

cmdStatus enum read only   filterable   orderable  
Discussion

Status of the current or last command.

Charateristics

Allowed values: ABANDONED, COMPLETED, FAILED, RUNNING, SKIPPED, STARTED, UNKNOWN
SDK attribute: cmdStatus

cmdType enum read only   filterable   orderable  
Discussion

Specifies the type of command that is stated for execution on the system. A request for download or a request for upgrade.

Charateristics

Allowed values: NSG_DOWNLOAD_OS_IMAGE, NSG_UPGRADE_TO_IMAGE
SDK attribute: cmdType

CPUCoreAllocation string read only   filterable   orderable  
Discussion

Current CPU allocation for network accelerated gateways. Displays total number of cores and those isolated.

Charateristics

Format: free
Max length: 255
SDK attribute: CPUCoreAllocation

CPUType string read only   filterable   orderable  
Discussion

The NSG Processor Type based on information extracted during bootstrapping. This may refer to a type of processor manufactured by Intel, ARM, AMD, Cyrix, VIA, or others.

Charateristics

Format: free
SDK attribute: CPUType

enterpriseID string read only  
Discussion

The enterprise associated with this Gateway.

Charateristics

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

enterpriseName string read only   filterable   orderable  
Discussion

Name of the Enterprise associated with this Gateway.

Charateristics

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

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

The NSG Family type as it was returned by the NSG during bootstrapping.

Charateristics

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

hugePageSetting string read only   filterable   orderable  
Discussion

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.

Charateristics

Format: free
Max length: 255
SDK attribute: hugePageSetting

libraries string read only  
Discussion

Tracks RPM package installed for some libraries installed on the NSG.

Charateristics

Format: free
SDK attribute: libraries

MACAddress string filterable   orderable  
Discussion

A comma separated list of MAC Addresses associated to the NSG's interfaces (eg, port1, port2, port3).

Charateristics

Format: free
SDK attribute: MACAddress

name string read only   filterable   orderable  
Discussion

Name of the Gateway.

Charateristics

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

NSGVersion string filterable   orderable  
Discussion

The NSG Version as reported during a bootstrap or a reboot of the NSG.

Charateristics

Format: free
SDK attribute: NSGVersion

patchesDetail string
Discussion

Base64 Encoded JSON String of the extra details pertaining to each successfully installed patch

Charateristics

Format: free
SDK attribute: patchesDetail

personality enum read only   filterable   orderable  
Discussion

Personality of the Gateway.

Charateristics

Allowed values: NSG, NSGBR, NSGDUC
SDK attribute: personality

productName string read only   filterable   orderable  
Discussion

NSG Product Name as reported when the device bootstraps.

Charateristics

Format: free
SDK attribute: productName

serialNumber string read only   filterable   orderable  
Discussion

The NSG's serial number as it is stored in the system's CMOS (Motherboard)

Charateristics

Format: free
SDK attribute: serialNumber

SKU string read only   filterable   orderable  
Discussion

The part number of the NSG

Charateristics

Format: free
SDK attribute: SKU

systemID string read only   filterable   orderable  
Discussion

System identifier of the Gateway.

Charateristics

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

TPMStatus integer read only   filterable   orderable  
Discussion

TPM status code as reported by the NSG during bootstrapping. This informate indicates if TPM is being used in securing the private key/certificate of an NSG. Possible values are 0(Unknown), 1(Enabled_Not_Operational), 2(Enabled_Operational), 3(Disabled).

Charateristics

SDK attribute: TPMStatus

TPMVersion string read only   filterable   orderable  
Discussion

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

Charateristics

Format: free
Max length: 255
SDK attribute: TPMVersion

UUID string read only   filterable   orderable  
Discussion

The Redhat/CentOS UUID of the NSG

Charateristics

Format: free
SDK attribute: UUID