HSC

System Monitoring details for hardware service controllers.

Overview

address string filterable  
alreadyMarkedForUnavailable boolean
averageCPUUsage float
averageMemoryUsage float
currentCPUUsage float
currentMemoryUsage float
description string filterable  
disks list
entityScope enum (ENTERPRISE | GLOBAL) autogenerated  
externalID string filterable   orderable   locally unique  
lastStateChange integer
lastUpdatedBy string autogenerated  
location string filterable   orderable  
managementIP string filterable  
messages list
model string filterable  
name string filterable   orderable  
peakCPUUsage float
peakMemoryUsage float
productVersion string filterable   orderable  
status enum (ADMIN_DOWN | DOWN | UP) filterable   orderable  
type enum (DC7X50 | NONE | VSA | VSG) filterable   orderable  
unavailableTimestamp integer
vsds list

API Resource

/hscs/id
delete get put

Parents

/vsps/id/hscs
get
/vrss/id/hscs
put

Children

/hscs/id/metadatas
get post
/hscs/id/bgppeers
get
/hscs/id/alarms
get
/hscs/id/globalmetadatas
get post put
/hscs/id/jobs
post
/hscs/id/monitoringports
get
/hscs/id/vrss
get
/hscs/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

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

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

Format: free
SDK attribute: disks

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

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 VSC/HSC 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

model string filterable  
Discussion

The model of the hardware service controller

Charateristics

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

name string filterable   orderable  
Discussion

Identifies the entity with a name.

Charateristics

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

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

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. Possible values are UP, DOWN, ADMIN_DOWN, .

Charateristics

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

type enum filterable   orderable  
Discussion

The type of the hardware service controller.

Charateristics

Allowed values: DC7X50, NONE, VSA, VSG
SDK attribute: type

unavailableTimestamp integer
Discussion

The duration the controller is unavailable (in millis).

Charateristics

Format: free
SDK attribute: unavailableTimestamp

vsds list
Discussion

A collection of VSD id(s) which are identified by this controller.

Charateristics

Format: free
SDK attribute: vsds