VRS

System Monitoring details for VRS connected to VSC or HSC

Overview

address string filterable  
averageCPUUsage float
averageMemoryUsage float
clusterNodeRole enum (NONE | PRIMARY | SECONDARY)
currentCPUUsage float
currentMemoryUsage float
dbSynced boolean
description string filterable  
disks list
dynamic boolean
entityScope enum (ENTERPRISE | GLOBAL) autogenerated   filterable   orderable  
externalID string filterable   orderable   locally unique  
hypervisorConnectionState enum (ADMIN_DOWN | DOWN | UP)
hypervisorIdentifier string filterable  
hypervisorName string filterable  
hypervisorType string filterable  
isResilient boolean
JSONRPCConnectionState enum (ADMIN_DOWN | DOWN | UP) filterable   orderable  
lastEventName string
lastEventObject string
lastEventTimestamp integer
lastStateChange integer
lastUpdatedBy string autogenerated  
licensedState enum (LICENSED | UNLICENSED)
location string filterable   orderable  
managementIP string filterable  
messages list
multiNICVPortEnabled boolean
name string filterable   orderable  
numberOfBridgeInterfaces integer
numberOfContainers integer
numberOfHostInterfaces integer
numberOfVirtualMachines integer
parentIDs list
peakCPUUsage float
peakMemoryUsage float
peer string filterable  
personality enum (HARDWARE_VTEP | NONE | NSG | NUAGE_210_WBX_32_Q | NUAGE_210_WBX_48_S | VRS | VRSG) filterable   orderable  
primaryVSCConnectionLost boolean
productVersion string filterable   orderable  
revertBehaviorEnabled boolean
revertCompleted boolean
revertCount integer
revertFailedCount integer
role enum (MASTER | NONE | SLAVE)
status enum (ADMIN_DOWN | DOWN | UP) filterable   orderable  
uptime integer
vscConfigState enum (PRIMARY | SECONDARY)
vscCurrentState enum (PRIMARY | SECONDARY)

API Resource

/vrss/id
delete get put

Parents

/vscs/id/vrss
get
/vports/id/vrss
get
/hscs/id/vrss
get
/vms/id/vrss
get
/containers/id/vrss
get

Children

/vrss/id/metadatas
get post
/vrss/id/alarms
get
/vrss/id/globalmetadatas
get post put
/vrss/id/vms
get
/vrss/id/jobs
post
/vrss/id/monitoringports
get
/vrss/id/containers
get
/vrss/id/vports
get
/vrss/id/hscs
put
/vrss/id/vscs
put
/vrss/id/multinicvports
get
/vrss/id/eventlogs
get

Members

This object has no members.

Attributes documentation

address string filterable  
Discussion

The IP of the VRS entity


Charateristics

Format: free
Min length: 1
Max length: 50
SDK attribute: address

averageCPUUsage float
Discussion

Average CPU usage percentage.


Charateristics

Format: free
SDK attribute: averageCPUUsage

averageMemoryUsage float
Discussion

Average memory usage percentage.


Charateristics

Format: free
SDK attribute: averageMemoryUsage

clusterNodeRole enum
Discussion

Indicate that the controller associated is primary, secondary or unknown.


Charateristics

Allowed values: NONE, PRIMARY, SECONDARY
SDK attribute: clusterNodeRole

currentCPUUsage float
Discussion

Current CPU usage percentage.


Charateristics

Format: free
SDK attribute: currentCPUUsage

currentMemoryUsage float
Discussion

Current memory usage percentage.


Charateristics

Format: free
SDK attribute: currentMemoryUsage

dbSynced boolean
Discussion

Flag to indicate if the ovs database is synced between the NSG pair part of a redundant group


Charateristics

Format: free
SDK attribute: dbSynced

description string filterable  
Discussion

Description of the entity.


Charateristics

Format: free
Max length: 255
SDK attribute: description

disks list
Discussion

Set of disk usage details.


Charateristics

Format: free
SDK attribute: disks

dynamic boolean
Discussion

Flag to indicate it is dynamically configured or not.


Charateristics

Format: free
SDK attribute: dynamic

entityScope enum autogenerated   filterable   orderable  
Discussion

Specify if scope of entity is Data center or Enterprise level


Charateristics

Allowed values: ENTERPRISE, GLOBAL
Format: free
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

hypervisorConnectionState enum
Discussion

The VRS connection state with the hypervisor.


Charateristics

Allowed values: ADMIN_DOWN, DOWN, UP
SDK attribute: hypervisorConnectionState

hypervisorIdentifier string filterable  
Discussion

The hypervisor IP (or name) associated with the VRS.


Charateristics

Format: free
Min length: 1
Max length: 50
SDK attribute: hypervisorIdentifier

hypervisorName string filterable  
Discussion

The hypervisor name associated with the VRS.


Charateristics

Format: free
Min length: 1
Max length: 128
SDK attribute: hypervisorName

hypervisorType string filterable  
Discussion

The hypervisor type associated with the VRS.


Charateristics

Format: free
Min length: 1
Max length: 128
SDK attribute: hypervisorType

isResilient boolean
Discussion

Flag to indicate that the VRS is part of a redundant group.


Charateristics

SDK attribute: isResilient

JSONRPCConnectionState enum filterable   orderable  
Discussion

The current JSON RPC connection status.


Charateristics

Allowed values: ADMIN_DOWN, DOWN, UP
SDK attribute: JSONRPCConnectionState

lastEventName string
Discussion

The last event name from the hypervisor.


Charateristics

Format: free
Min length: 1
Max length: 128
SDK attribute: lastEventName

lastEventObject string
Discussion

The last event object (including metadata) from the hypervisor.


Charateristics

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

lastEventTimestamp integer
Discussion

The last event timestamp from the hypervisor.


Charateristics

Format: free
SDK attribute: lastEventTimestamp

lastStateChange integer
Discussion

Last state change timestamp (in millis).


Charateristics

Format: free
SDK attribute: lastStateChange

lastUpdatedBy string autogenerated  
Discussion

ID of the user who last updated the object.


Charateristics

Format: free
SDK attribute: lastUpdatedBy

licensedState enum
Discussion

Licensed state.


Charateristics

Allowed values: LICENSED, UNLICENSED
SDK attribute: licensedState

location string filterable   orderable  
Discussion

Identifies the entity to be associated with a location.


Charateristics

Format: free
Max length: 128
SDK attribute: location

managementIP string filterable  
Discussion

The management IP of the VRS entity


Charateristics

Format: free
Min length: 1
Max length: 50
SDK attribute: managementIP

messages list
Discussion

An array of degraded messages.


Charateristics

Format: free
SDK attribute: messages

multiNICVPortEnabled boolean
Discussion

VRS is in Multi-NIC VPORT Mode


Charateristics

Format: free
SDK attribute: multiNICVPortEnabled

name string filterable   orderable  
Discussion

Identifies the entity with a name.


Charateristics

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

numberOfBridgeInterfaces integer
Discussion

Number of bridge interfaces defined in this VRS.


Charateristics

Format: free
SDK attribute: numberOfBridgeInterfaces

numberOfContainers integer
Discussion

Number of containers defined in this VRS.


Charateristics

Format: free
SDK attribute: numberOfContainers

numberOfHostInterfaces integer
Discussion

Number of host interfaces defined in this VRS.


Charateristics

Format: free
SDK attribute: numberOfHostInterfaces

numberOfVirtualMachines integer
Discussion

Number of VMs defined in this VRS.


Charateristics

Format: free
SDK attribute: numberOfVirtualMachines

parentIDs list
Discussion

Holds VRS controllers ids


Charateristics

Format: free
SDK attribute: parentIDs

peakCPUUsage float
Discussion

Peek CPU usage percentage.


Charateristics

Format: free
SDK attribute: peakCPUUsage

peakMemoryUsage float
Discussion

Peek memory usage percentage.


Charateristics

Format: free
SDK attribute: peakMemoryUsage

peer string filterable  
Discussion

The redundant peer id for the current VRS.


Charateristics

Format: free
Min length: 1
Max length: 50
SDK attribute: peer

personality enum filterable   orderable  
Discussion

VRS personality.


Charateristics

Allowed values: HARDWARE_VTEP, NONE, NSG, NUAGE_210_WBX_32_Q, NUAGE_210_WBX_48_S, VRS, VRSG
SDK attribute: personality

primaryVSCConnectionLost boolean
Discussion

Flag indicates whether the connection with the primary is lost, which will help trigger alarms.


Charateristics

SDK attribute: primaryVSCConnectionLost

productVersion string filterable   orderable  
Discussion

Product version supported by this entity.


Charateristics

Format: free
Min length: 1
Max length: 50
SDK attribute: productVersion

revertBehaviorEnabled boolean
Discussion

Flag to indicate if the revert behavior took place or not.


Charateristics

SDK attribute: revertBehaviorEnabled

revertCompleted boolean
Discussion

Flag indicates whether revert was completed successfully.


Charateristics

SDK attribute: revertCompleted

revertCount integer
Discussion

Indicates the number of retries for the revert to take place.


Charateristics

SDK attribute: revertCount

revertFailedCount integer
Discussion

This value indicates the number of failed attempts for the revert to happen successfully.


Charateristics

SDK attribute: revertFailedCount

role enum
Discussion

Flag to indicate that VRS-G redundancy state (active/standby/standalone). Only applicable for gateways.


Charateristics

Allowed values: MASTER, NONE, SLAVE
SDK attribute: role

status enum filterable   orderable  
Discussion

Computed status of the entity.


Charateristics

Allowed values: ADMIN_DOWN, DOWN, UP
SDK attribute: status

uptime integer
Discussion

How long the VRS was up.


Charateristics

Format: free
SDK attribute: uptime

vscConfigState enum
Discussion

Indicates the configured state of the VSC.


Charateristics

Allowed values: PRIMARY, SECONDARY
SDK attribute: vscConfigState

vscCurrentState enum
Discussion

Indicates the current state of the VSC, which may or maybe not be same as the configured state.


Charateristics

Allowed values: PRIMARY, SECONDARY
SDK attribute: vscCurrentState