ControllerVRSLink

System Monitoring details for VRS connected to VSC or HSC

Overview

clusterNodeRole enum (NONE | PRIMARY | SECONDARY) read only   filterable   orderable  
connections list read only  
controllerID string read only   filterable   orderable  
controllerType enum (HSC | VSC) read only   filterable   orderable  
creationDate string read only   autogenerated   orderable  
dynamic boolean read only   filterable   orderable  
embeddedMetadata list read only   autogenerated  
entityScope enum (ENTERPRISE | GLOBAL) autogenerated  
externalID string filterable   orderable   locally unique  
JSONRPCConnectionState enum (ADMIN_DOWN | DOWN | NONE | UP) read only   filterable   orderable  
lastUpdatedBy string autogenerated  
lastUpdatedDate string read only   autogenerated   orderable  
name string read only   filterable   orderable  
owner string autogenerated  
peer string read only   filterable   orderable  
role enum (MASTER | NONE | SLAVE) read only   filterable   orderable   locally unique  
status enum (ADMIN_DOWN | DOWN | UP) read only   filterable   orderable  
VRSID string read only   filterable   orderable  
VRSISSUFailureReason string read only  
VRSISSUState string read only  
VRSLastISSUState string read only  
VRSPersonality enum (HARDWARE_VTEP | NONE | NSG | NSGBR | NSGDUC | NUAGE_210_WBX_32_Q | NUAGE_210_WBX_48_S | VRS | VRSB | VRSG) read only   filterable   orderable  
VRSSystemId string read only  
VSCConfigState enum (PRIMARY | SECONDARY) read only   filterable   orderable  
VSCCurrentState enum (PRIMARY | SECONDARY) read only   filterable   orderable  

API Resource

/controllervrslinks/id
delete get put

Parents

/vrss/id/controllervrslinks
get
/hscs/id/controllervrslinks
get
/vscs/id/controllervrslinks
get

Children

/controllervrslinks/id/permissions
delete get post put
/controllervrslinks/id/metadatas
get post
/controllervrslinks/id/globalmetadatas
get post put
/controllervrslinks/id/vrss
get
/controllervrslinks/id/hscs
get
/controllervrslinks/id/vscs
get

Members

This object has no members.

Attributes documentation

clusterNodeRole enum read only   filterable   orderable  
Discussion

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

Charateristics

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

connections list read only  
Discussion

List of Connections for Controller VRS Link

Charateristics

SDK attribute: connections

controllerID string read only   filterable   orderable  
Discussion

ID of associated Controller

Charateristics

Format: free
SDK attribute: controllerID

controllerType enum read only   filterable   orderable  
Discussion

Type of associated Controller

Charateristics

Allowed values: HSC, VSC
SDK attribute: controllerType

creationDate string read only   autogenerated   orderable  
Discussion

Time stamp when this object was created.

Charateristics

SDK attribute: creationDate

dynamic boolean read only   filterable   orderable  
Discussion

Flag to indicate it is dynamically configured or not.

Charateristics

SDK attribute: dynamic

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

JSONRPCConnectionState enum read only   filterable   orderable  
Discussion

The current JSON RPC connection status.

Charateristics

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

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

name string read only   filterable   orderable  
Discussion

Name of the Controller-VRS link

Charateristics

Format: free
SDK attribute: name

owner string autogenerated  
Discussion

Identifies the user that has created this object.

Charateristics

Format: free
SDK attribute: owner

peer string read only   filterable   orderable  
Discussion

The redundant peer id for the current VRS.

Charateristics

Format: free
SDK attribute: peer

role enum read only   filterable   orderable   locally unique  
Discussion

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

Charateristics

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

status enum read only   filterable   orderable  
Discussion

Computed status of the entity.

Charateristics

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

VRSID string read only   filterable   orderable  
Discussion

ID of associated VRS

Charateristics

Format: free
SDK attribute: VRSID

VRSISSUFailureReason string read only  
Discussion

ISSU (In-Service Software Upgrade) failure reason of the associated VRS.

Charateristics

Format: free
Max length: 255
SDK attribute: VRSISSUFailureReason

VRSISSUState string read only  
Discussion

ISSU (In-Service Software Upgrade) state of the associated VRS.

Charateristics

Format: free
Max length: 255
SDK attribute: VRSISSUState

VRSLastISSUState string read only  
Discussion

Last ISSU (In-Service Software Upgrade) state of the associated VRS.

Charateristics

Format: free
Max length: 255
SDK attribute: VRSLastISSUState

VRSPersonality enum read only   filterable   orderable  
Discussion

Personality of associated VRS.

Charateristics

Allowed values: HARDWARE_VTEP, NONE, NSG, NSGBR, NSGDUC, NUAGE_210_WBX_32_Q, NUAGE_210_WBX_48_S, VRS, VRSB, VRSG
SDK attribute: VRSPersonality

VRSSystemId string read only  
Discussion

System ID of associated VRS

Charateristics

Format: free
Max length: 255
SDK attribute: VRSSystemId

VSCConfigState enum read only   filterable   orderable  
Discussion

Indicates the configured state of the VSC.

Charateristics

Allowed values: PRIMARY, SECONDARY
SDK attribute: VSCConfigState

VSCCurrentState enum read only   filterable   orderable  
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