Previous Topic: msg ObjectNext Topic: util Object


ha Object

Use this object to verify the HA (High Availability State) of a VDC.

Method

Description

info

Retrieve high availability information

check

Perform high availability check

info Method (ha Object)
Description

Retrieve high availability information

Syntax
/api/v2/ha/info?vdc=controller-name 
Arguments
vdc

Name of the target virtual data center

Transaction Type

synchronous

Request Type

GET

Examples

Retrieve high availability information.

GET http://192.168.123.200/api/v2/ha/info?vdc=mygrid 
Sample Output
XML:
<message>state = ok
state_apps = ok
state_controller = ok
state_backbone = disabled
state_external = disabled
</message> 
JSON:
{
"message" : "state = ok\nstate_apps = ok\nstate_controller = ok\nstate_backbone = disabled\nstate_external = disabled\n"
} 

check Method (ha Object)
Description

Perform high availability check

Syntax
/api/v2/ha/check?vdc=controller-name 
Arguments
vdc

Name of the target virtual data center

Transaction Type

asynchronous

Request Type

GET

Examples

Perform high availability check.

GET http://192.168.123.200/api/v2/ha/check?vdc=mygrid 
Sample Output
XML:
<job>be805915-76b2-48c8-b8a0-b881cca66da6</job>
JSON:
{
   "job" : "be805915-76b2-48c8-b8a0-b881cca66da6"
}