NSGatewaySummary

Summary information such as alarm counts, location, version, boostrap status for Network Services Gateway

Overview

address string read only  
bootstrapStatus enum (ACTIVE | CERTIFICATE_SIGNED | INACTIVE | NOTIFICATION_APP_REQ_ACK | NOTIFICATION_APP_REQ_SENT) read only  
country string read only  
criticalAlarmsCount integer read only  
embeddedMetadata list read only   autogenerated  
enterpriseID string read only  
entityScope enum (ENTERPRISE | GLOBAL) autogenerated  
externalID string filterable   orderable   locally unique  
gatewayID string read only  
gatewayName string read only  
gatewayType string read only  
infoAlarmsCount integer read only  
lastUpdatedBy string autogenerated  
latitude float read only  
locality string read only  
longitude float read only  
majorAlarmsCount integer read only  
minorAlarmsCount integer read only  
NSGVersion string read only  
redundantGroupID string read only   filterable   orderable  
state string read only  
systemID string read only  
timezoneID string read only  

API Resource

/nsgatewayssummaries/id
get

Parents

/enterprises/id/nsgatewayssummaries
get
/domains/id/nsgatewayssummaries
get
/l2domains/id/nsgatewayssummaries
get
/nsgateways/id/nsgatewayssummaries
get
/aggregateddomains/id/nsgatewayssummaries
get

Children

/nsgatewayssummaries/id/metadatas
get post
/nsgatewayssummaries/id/globalmetadatas
get post put

Members

This object has no members.

Attributes documentation

address string read only  
Discussion

Formatted address including property number, street name, suite or office number of the NSG

Charateristics

Format: free
SDK attribute: address

bootstrapStatus enum read only  
Discussion

Bootstrap status of the NSG

Charateristics

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

country string read only  
Discussion

Country in which the NSG is located

Charateristics

Format: free
SDK attribute: country

criticalAlarmsCount integer read only  
Discussion

Total number of alarms with CRITICAL severity

Charateristics

SDK attribute: criticalAlarmsCount

embeddedMetadata list read only   autogenerated  
Discussion

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.

Charateristics

SDK attribute: embeddedMetadata

enterpriseID string read only  
Discussion

The enterprise associated with this NSG

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

gatewayID string read only  
Discussion

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

Charateristics

Format: free
SDK attribute: gatewayID

gatewayName string read only  
Discussion

The name of the gateway

Charateristics

Format: free
SDK attribute: gatewayName

gatewayType string read only  
Discussion

Details on the type of gateway for which the summary is given. For NSGs, the value would be NSGateway.

Charateristics

SDK attribute: gatewayType

infoAlarmsCount integer read only  
Discussion

Total number of alarms with INFO severity

Charateristics

Format: free
SDK attribute: infoAlarmsCount

lastUpdatedBy string autogenerated  
Discussion

ID of the user who last updated the object.

Charateristics

Format: free
SDK attribute: lastUpdatedBy

latitude float read only  
Discussion

The latitude of the location of the NSG

Charateristics

SDK attribute: latitude

locality string read only  
Discussion

Locality/City/County of the NSG

Charateristics

Format: free
SDK attribute: locality

longitude float read only  
Discussion

The longitude of the location of the NSG

Charateristics

SDK attribute: longitude

majorAlarmsCount integer read only  
Discussion

Total number of alarms with MAJOR severity

Charateristics

SDK attribute: majorAlarmsCount

minorAlarmsCount integer read only  
Discussion

Total number of alarms with MINOR severity

Charateristics

SDK attribute: minorAlarmsCount

NSGVersion string read only  
Discussion

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

Charateristics

Format: free
SDK attribute: NSGVersion

redundantGroupID string read only   filterable   orderable  
Discussion

The ID of the Redundant Group which has this gateway

Charateristics

Format: free
Max length: 255
SDK attribute: redundantGroupID

state string read only  
Discussion

State/Province/Region

Charateristics

Format: free
SDK attribute: state

systemID string read only  
Discussion

Identifier of the gateway

Charateristics

Format: free
SDK attribute: systemID

timezoneID string read only  
Discussion

Time zone in which the Gateway is located. This can be in the form of a UTC/GMT offset, continent/city location, or country/region. The available time zones can be found in /usr/share/zoneinfo on a Linux machine or retrieved with TimeZone.getAvailableIDs() in Java. Refer to the IANA (Internet Assigned Numbers Authority) for a list of time zones. URL : http://www.iana.org/time-zones Default value is UTC (translating to Etc/Zulu)

Charateristics

Format: free
SDK attribute: timezoneID