Class: Clusterhost

Last published : Oct 01, 2026
Cluster member metadata
Related information
XenServer 8.4 Management API

Fields for class: Clusterhost

Field Type Qualifier Description
allowed_operations cluster_host_operation set RO/runtime list of the operations allowed in this state. This list is advisory only and the server state may have changed by the time this field is read by a client.
cluster Cluster ref RO/constructor Reference to the Cluster object
current_operations (string -> cluster_host_operation) map RO/runtime links each of the running tasks using this object (by reference) to a current_operation enum which describes the nature of the task.
enabled bool RO/runtime Whether the cluster host believes that clustering should be enabled on this host. This field can be altered by calling the enable/disable message on a cluster host. Only enabled members run the underlying cluster stack. Disabled members are still considered a member of the cluster (see joined), and can be re-enabled by the user.
host host ref RO/constructor Reference to the Host object
joined bool RO/runtime Whether the cluster host has joined the cluster. Contrary to enabled, a host that is not joined is not considered a member of the cluster, and hence enable and disable operations cannot be performed on this host.
last_update_live datetime RO/runtime Time when the live field was last updated based on information from the cluster stack
live bool RO/runtime Whether the underlying cluster stack thinks we are live. This field is set automatically based on updates from the cluster stack and cannot be altered by the user.
other_config (string -> string) map RO/constructor Additional configuration
PIF PIF ref RO/constructor Reference to the PIF object
uuid string RO/runtime Unique identifier/object reference

RPCs associated with class: Clusterhost

RPC name: create

Overview:
Add a new host to an existing cluster.
Signature:
Cluster_host ref create (session ref session_ref, Cluster ref cluster, host ref host, PIF ref pif)
Arguments:
Type Name Description
session ref session_ref Reference to a valid session
Cluster ref cluster Cluster to join
host ref host new cluster member
PIF ref pif Network interface to use for communication
Minimum Role: pool-operator
Return Type: Cluster_host ref
the newly created clusterhost object
Possible Error Codes: PIF_NOT_ATTACHED_TO_HOST, NO_CLUSTER_HOSTS_REACHABLE

RPC name: destroy

Overview:
Remove the host from an existing cluster. This operation is allowed even if a cluster host is not enabled.
Signature:
void destroy (session ref session_ref, Cluster_host ref self)
Arguments:
Type Name Description
session ref session_ref Reference to a valid session
Cluster_host ref self the cluster_host to remove from the cluster
Minimum Role: pool-operator
Return Type: void
Possible Error Codes: CLUSTER_STACK_IN_USE, CLUSTERING_DISABLED, CLUSTER_HOST_IS_LAST

RPC name: disable

Overview:
Disable cluster membership for an enabled cluster host.
Signature:
void disable (session ref session_ref, Cluster_host ref self)
Arguments:
Type Name Description
session ref session_ref Reference to a valid session
Cluster_host ref self the cluster_host to disable
Minimum Role: pool-operator
Return Type: void
Possible Error Codes: CLUSTER_STACK_IN_USE

RPC name: enable

Overview:
Enable cluster membership for a disabled cluster host.
Signature:
void enable (session ref session_ref, Cluster_host ref self)
Arguments:
Type Name Description
session ref session_ref Reference to a valid session
Cluster_host ref self the cluster_host to enable
Minimum Role: pool-operator
Return Type: void
Possible Error Codes: PIF_ALLOWS_UNPLUG, REQUIRED_PIF_IS_UNPLUGGED

RPC name: forcedestroy

Overview:
Remove a host from an existing cluster forcefully.
Signature:
void force_destroy (session ref session_ref, Cluster_host ref self)
Arguments:
Type Name Description
session ref session_ref Reference to a valid session
Cluster_host ref self the cluster_host to remove from the cluster
Minimum Role: pool-operator
Return Type: void
Possible Error Codes: CLUSTER_STACK_IN_USE

RPC name: getall

Overview:
Return a list of all the Clusterhosts known to the system.
Signature:
Cluster_host ref set get_all (session ref session_ref)
Arguments:
Type Name Description
session ref session_ref Reference to a valid session
Minimum Role: read-only
Return Type: Cluster_host ref set
references to all objects

RPC name: getallrecords

Overview:
Return a map of Clusterhost references to Clusterhost records for all Clusterhosts known to the system.
Signature:
(Cluster_host ref -> Cluster_host record) map get_all_records (session ref session_ref)
Arguments:
Type Name Description
session ref session_ref Reference to a valid session
Minimum Role: read-only
Return Type: (Cluster_host ref -> Cluster_host record) map
records of all objects

RPC name: getallowedoperations

Overview:
Get the allowedoperations field of the given Clusterhost.
Signature:
cluster_host_operation set get_allowed_operations (session ref session_ref, Cluster_host ref self)
Arguments:
Type Name Description
session ref session_ref Reference to a valid session
Cluster_host ref self reference to the object
Minimum Role: read-only
Return Type: cluster_host_operation set
value of the field

RPC name: getbyuuid

Overview:
Get a reference to the Clusterhost instance with the specified UUID.
Signature:
Cluster_host ref get_by_uuid (session ref session_ref, string uuid)
Arguments:
Type Name Description
session ref session_ref Reference to a valid session
string uuid UUID of object to return
Minimum Role: read-only
Return Type: Cluster_host ref
reference to the object

RPC name: getcluster

Overview:
Get the cluster field of the given Clusterhost.
Signature:
Cluster ref get_cluster (session ref session_ref, Cluster_host ref self)
Arguments:
Type Name Description
session ref session_ref Reference to a valid session
Cluster_host ref self reference to the object
Minimum Role: read-only
Return Type: Cluster ref
value of the field

RPC name: getcurrentoperations

Overview:
Get the currentoperations field of the given Clusterhost.
Signature:
(string -> cluster_host_operation) map get_current_operations (session ref session_ref, Cluster_host ref self)
Arguments:
Type Name Description
session ref session_ref Reference to a valid session
Cluster_host ref self reference to the object
Minimum Role: read-only
Return Type: (string -> cluster_host_operation) map
value of the field

RPC name: getenabled

Overview:
Get the enabled field of the given Clusterhost.
Signature:
bool get_enabled (session ref session_ref, Cluster_host ref self)
Arguments:
Type Name Description
session ref session_ref Reference to a valid session
Cluster_host ref self reference to the object
Minimum Role: read-only
Return Type: bool
value of the field

RPC name: gethost

Overview:
Get the host field of the given Clusterhost.
Signature:
host ref get_host (session ref session_ref, Cluster_host ref self)
Arguments:
Type Name Description
session ref session_ref Reference to a valid session
Cluster_host ref self reference to the object
Minimum Role: read-only
Return Type: host ref
value of the field

RPC name: getjoined

Overview:
Get the joined field of the given Clusterhost.
Signature:
bool get_joined (session ref session_ref, Cluster_host ref self)
Arguments:
Type Name Description
session ref session_ref Reference to a valid session
Cluster_host ref self reference to the object
Minimum Role: read-only
Return Type: bool
value of the field

RPC name: getlastupdatelive

Overview:
Get the lastupdatelive field of the given Clusterhost.
Signature:
datetime get_last_update_live (session ref session_ref, Cluster_host ref self)
Arguments:
Type Name Description
session ref session_ref Reference to a valid session
Cluster_host ref self reference to the object
Minimum Role: read-only
Return Type: datetime
value of the field

RPC name: getlive

Overview:
Get the live field of the given Clusterhost.
Signature:
bool get_live (session ref session_ref, Cluster_host ref self)
Arguments:
Type Name Description
session ref session_ref Reference to a valid session
Cluster_host ref self reference to the object
Minimum Role: read-only
Return Type: bool
value of the field

RPC name: getotherconfig

Overview:
Get the otherconfig field of the given Clusterhost.
Signature:
(string -> string) map get_other_config (session ref session_ref, Cluster_host ref self)
Arguments:
Type Name Description
session ref session_ref Reference to a valid session
Cluster_host ref self reference to the object
Minimum Role: read-only
Return Type: (string -> string) map
value of the field

RPC name: getPIF

Overview:
Get the PIF field of the given Clusterhost.
Signature:
PIF ref get_PIF (session ref session_ref, Cluster_host ref self)
Arguments:
Type Name Description
session ref session_ref Reference to a valid session
Cluster_host ref self reference to the object
Minimum Role: read-only
Return Type: PIF ref
value of the field

RPC name: getrecord

Overview:
Get a record containing the current state of the given Clusterhost.
Signature:
Cluster_host record get_record (session ref session_ref, Cluster_host ref self)
Arguments:
Type Name Description
session ref session_ref Reference to a valid session
Cluster_host ref self reference to the object
Minimum Role: read-only
Return Type: Cluster_host record
all fields from the object

RPC name: getuuid

Overview:
Get the uuid field of the given Clusterhost.
Signature:
string get_uuid (session ref session_ref, Cluster_host ref self)
Arguments:
Type Name Description
session ref session_ref Reference to a valid session
Cluster_host ref self reference to the object
Minimum Role: read-only
Return Type: string
value of the field