VSDComponent

System Monitoring details for components of VSD system.

Overview

address string filterable  
description string filterable  
entityScope enum (ENTERPRISE | GLOBAL) autogenerated  
externalID string filterable   orderable   locally unique  
location string filterable   orderable  
managementIP string filterable  
name string filterable   orderable  
productVersion string filterable   orderable  
status enum (ADMIN_DOWN | DOWN | UP) filterable   orderable  
type enum (EJABBERD | JBOSS | MEDIATOR | PERCONA | STATSCOLLECTOR | STATSSERVER | TCA) filterable  

API Resource

/components/id

Parents

/vsds/id/components
get

Children

/components/id/metadatas
get post
/components/id/globalmetadatas
get post put

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

description string filterable  
Discussion

Description of the entity.


Charateristics

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

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

location string filterable   orderable  
Discussion

Identifies the entity to be associated with a location.


Charateristics

Format: free
Min length: 1
Max length: 255
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

name string filterable   orderable  
Discussion

Identifies the entity with a name.


Charateristics

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

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

Current 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  
Discussion

Type of the component.


Charateristics

Allowed values: EJABBERD, JBOSS, MEDIATOR, PERCONA, STATSCOLLECTOR, STATSSERVER, TCA
SDK attribute: type