Cluster

Description

API


    PUT /api/cluster
    GET /api/cluster

CLI


    configure cluster
    show cluster

Data

Cluster

uuid

Type
string
Category
required
Description

name

Type
string
Category
required
Description

virtual_ip

Type
IpAddr
Category
optional
Description
A virtual IP address. This IP address will be dynamically reconfigured so that it always is the IP of the cluster leader.

nodes

Type
ClusterNode
Category
repeated
Description

tenant_ref

Type
Reference to Tenant
Category
optional
Description

IpAddr

addr

Type
string
Category
required
Description
IP address

type

Type
enum
Category
required
Description
Choices
V4, DNS

ClusterNode

name

Type
string
Category
optional
Description
Default
node

ip

Type
IpAddr
Category
required
Description
IP address of controller VM.

vm_uuid

Type
string
Category
optional
Description
UUID on the controller VM

vm_name

Type
string
Category
optional
Description
Name of the controller VM

vm_mor

Type
string
Category
optional
Description
Managed object reference of this controller VM

vm_hostname

Type
string
Category
optional
Description
hostname assigned to this controller VM

References

Tenant

Sub Objects

ClusterState

Description

API


    GET /api/cluster/runtime/&ltkey>

CLI


    show cluster status

Data

ClusterState

cluster_state

Type
ClusterOperationalStatus
Category
required
Description

node_states

Type
ClusterNodeState
Category
repeated
Description

service_states

Type
ClusterServiceState
Category
repeated
Description

ClusterOperationalStatus

state

Type
enum
Category
optional
Description
Choices
CLUSTER_STARTING_UP, CLUSTER_UP_NO_HA, CLUSTER_REBOOTING, CLUSTER_UP_HA_COMPROMISED, CLUSTER_PROCESSING, CLUSTER_UP_HA_NOT_READY, CLUSTER_UP_HA_ACTIVE

reason

Type
string
Category
repeated
Description

reason_code

Type
uint64
Category
optional
Description

last_changed_time

Type
TimeStamp
Category
optional
Description

up_since

Type
string
Category
optional
Description

progress

Type
uint64
Category
optional
Description

TimeStamp

secs

Type
Unknown
Category
required
Description

usecs

Type
Unknown
Category
required
Description

ClusterNodeState

name

Type
string
Category
required
Description

role

Type
enum
Category
required
Description
Choices
CLUSTER_LEADER, CLUSTER_FOLLOWER

state

Type
enum
Category
required
Description
Choices
CLUSTER_COLD_REBOOT, CLUSTER_WARM_REBOOT, CLUSTER_WAITING, CLUSTER_FAILURE, CLUSTER_CLEAN_REBOOT, CLUSTER_STARTING, CLUSTER_INACTIVE, CLUSTER_ACTIVE

up_since

Type
string
Category
optional
Description

ClusterServiceState

name

Type
string
Category
required
Description

state

Type
enum
Category
required
Description
Choices
CLUSTER_COLD_REBOOT, CLUSTER_WARM_REBOOT, CLUSTER_WAITING, CLUSTER_FAILURE, CLUSTER_CLEAN_REBOOT, CLUSTER_STARTING, CLUSTER_INACTIVE, CLUSTER_ACTIVE

cluster_nodes

Type
ClusterNode
Category
repeated
Description
Nodes participating in the service.

roles

Type
enum
Category
repeated
Description
Role of each node participating in the service.
Choices
SERVICE_ROLE_LEADER, SERVICE_ROLE_FOLLOWER