NSGatewayMonitor

This API can be used to gather read-only information about an NSG, including information on its state, system metrics, alarm counts, location and version. It is a single view of the full data available for an NSG.

Overview

nsginfo object read only  
nsgstate object read only  
nsgsummary object read only  
vrsinfo object read only   locally unique  
vscs list read only  

API Resource

/nsgatewaysmonitors/id
get

Parents

/nsgateways/id/nsgatewaysmonitors
get

Children

This object has no children.

Members

This object has no members.

Attributes documentation

nsginfo object read only  
Discussion

An embedded object from the nsinfo entity from VSD. Contains info such as software version, CPU type, BIOS version etc. The embedded object is returned in JSON format

Charateristics

SDK attribute: nsginfo

nsgstate object read only  
Discussion

Information from the NSGState object in VSD in JSON format. Contains information about connection status, TPM status, operation mode etc.

Charateristics

SDK attribute: nsgstate

nsgsummary object read only  
Discussion

NSG summary in JSON format - contains alarm counts, locality, bootstrap info etc.

Charateristics

SDK attribute: nsgsummary

vrsinfo object read only   locally unique  
Discussion

information about VRS reported from sysmon in JSON format. Has info about cpu usage, memory usage, physical interfaces etc.

Charateristics

SDK attribute: vrsinfo

vscs list read only  
Discussion

List of controllers associated with the nsg

Charateristics

SDK attribute: vscs