VSD

System Monitoring details for VSD. This is deprecated and no longer provided through the Nuage API. This information can now be gathered through the Monit API.

Overview

address string filterable  
alreadyMarkedForUnavailable boolean
averageCPUUsage float
averageMemoryUsage float
creationDate string read only   autogenerated   orderable  
currentCPUUsage float
currentMemoryUsage float
description string filterable  
disks list
embeddedMetadata list read only   autogenerated  
entityScope enum (ENTERPRISE | GLOBAL) autogenerated  
externalID string filterable   orderable   locally unique  
lastStateChange integer
lastUpdatedBy string autogenerated  
lastUpdatedDate string read only   autogenerated   orderable  
location string filterable   orderable  
managementIP string filterable  
messages list
mode enum (CLUSTER | STANDALONE)
name string filterable   orderable  
owner string autogenerated  
peakCPUUsage float
peakMemoryUsage float
peerAddresses string
productVersion string filterable   orderable  
status enum (ADMIN_DOWN | DOWN | UP) filterable   orderable  
unavailableTimestamp integer
URL string

API Resource

/vsds/id
get put

Parents

This object has no parents.

Children

/vsds/id/permissions
delete get post put
/vsds/id/metadatas
get post
/vsds/id/alarms
get
/vsds/id/globalmetadatas
get post put
/vsds/id/jobs
post
/vsds/id/components
get
/vsds/id/eventlogs
get

Members

This object has no members.

Attributes documentation

address string filterable  
Discussion

An optional IP to access this component.

Charateristics

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

alreadyMarkedForUnavailable boolean
Discussion

Flag to indicate that it is already marked a unavailable.

Charateristics

Format: free
SDK attribute: alreadyMarkedForUnavailable

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

creationDate string read only   autogenerated   orderable  
Discussion

Time stamp when this object was created.

Charateristics

SDK attribute: creationDate

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

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

SDK attribute: disks

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

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

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

lastUpdatedDate string read only   autogenerated   orderable  
Discussion

Time stamp when this object was last updated.

Charateristics

SDK attribute: lastUpdatedDate

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

An optional management IP to log into this component.

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

mode enum
Discussion

Standalone or cluster mode.

Charateristics

Allowed values: CLUSTER, STANDALONE
SDK attribute: mode

name string filterable   orderable  
Discussion

Identifies the entity with a name.

Charateristics

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

owner string autogenerated  
Discussion

Identifies the user that has created this object.

Charateristics

Format: free
SDK attribute: owner

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

peerAddresses string
Discussion

A comma separated list of peer addresses, if it is in cluster mode.

Charateristics

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

productVersion string filterable   orderable  
Discussion

Product version supported by this entity.

Charateristics

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

status enum filterable   orderable  
Discussion

Computed status of the entity.

Charateristics

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

unavailableTimestamp integer
Discussion

The duration the controller is unavailable (in millis).

Charateristics

Format: free
SDK attribute: unavailableTimestamp

URL string
Discussion

An optional web url for management.

Charateristics

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