cluster.status

Retrieves the cluster status of the node, including whether it is a member of a highly available cluster, whether it is the active node, and whether it is in maintenance, standby, or unclean state.

JSON-RPC Request

{"jsonrpc": "2.0","id": 1,"method": "cluster.status"}

JSON-RPC Response

{
    "jsonrpc": "2.0",
    "id": 1,
    "result": {
        "ha_cluster": boolean,
        "hostname": "string",
        "active_node": true,
        "maintenance": false,
        "standby": false,
        "unclean": false,
        "last_checked": "Wed Sep 25 3:11:20 am 2024 UTC"
    }
}

Response parameters

Parameter	Type	Description
`ha_cluster`	Boolean	Whether the node is a member of a cluster.
`hostname`	String	The hostname of the node.
`active_node`	Boolean	Whether or not the node is the primary node in the cluster.
`maintenance`	Boolean	Whether or not the cluster the node is a member of is in maintenance mode.
`standby`	Boolean	Whether or not the node is in standby mode, according to Pacemaker. When a node is in `standby` mode, no new resources are placed on the node.
`unclean`	Boolean	Whether or not the node is in an unclean status. When a node is unclean, it means the node exited the cluster in an unexpected way.
`last_checked`	String	The timestamp indicating the last time the cluster status was checked.

CLI Example

rvc cluster status

Response

Ha Cluster..: true
Hostname....: sit0002red0
Active Node.: true 
Maintenance.: false 
Standby.....: false 
Unclean.....: false 
Last Checked: Wed Sep 25 3:12:26 am 2024 UTC