Xapi Project Docs

Class: Cluster_host

Cluster member metadata

Prototyped in:	XenServer 7.5 (kolkata)
Published in:	XenServer 7.6 (lima)

Enums

cluster_host_operation

Values:	enable	enabling cluster membership on a particular host
	disable	disabling cluster membership on a particular host
	destroy	completely destroying a cluster host

Fields

PIF ref PIF [RO/constructor]

Reference to the PIF object

Default value:	OpaqueRef:NULL
Prototyped in:	XenServer 7.5 (kolkata)
Published in:	XenServer 7.6 (lima)

enum cluster_host_operation set allowed_operations [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.

Default value:	{}
Published in:	XenServer 4.0 (rio)	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 ref cluster [RO/constructor]

Reference to the Cluster object

Default value:	OpaqueRef:NULL
Prototyped in:	XenServer 7.5 (kolkata)
Published in:	XenServer 7.6 (lima)

(string → enum cluster_host_operation) map current_operations [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.

Default value:	{}
Published in:	XenServer 4.0 (rio)	links each of the running tasks using this object (by reference) to a current_operation enum which describes the nature of the task.

bool enabled [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.

Default value:	false
Prototyped in:	XenServer 7.5 (kolkata)
Published in:	XenServer 7.6 (lima)

host ref host [RO/constructor]

Reference to the Host object

Default value:	OpaqueRef:NULL
Prototyped in:	XenServer 7.5 (kolkata)
Published in:	XenServer 7.6 (lima)

bool joined [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.

Default value:	true
Prototyped in:	XenServer 7.5 (kolkata)
Published in:	XenServer 7.6 (lima)

Prototype

datetime last_update_live [RO/runtime]

Time when the live field was last updated based on information from the cluster stack

Default value:	19700101T00:00:00Z
Prototyped in:	XAPI 24.3.0 (24.3.0)

Prototype

bool live [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.

Default value:	false
Prototyped in:	XAPI 24.3.0 (24.3.0)

(string → string) map other_config [RO/constructor]

Additional configuration

Default value:	{}
Prototyped in:	XenServer 7.5 (kolkata)
Published in:	XenServer 7.6 (lima)

string uuid [RO/runtime]

Unique identifier/object reference

Prototyped in:	XenServer 7.5 (kolkata)
Published in:	XenServer 7.6 (lima)

Messages

Cluster_host ref create (session ref, Cluster ref, host ref, PIF ref)

Add a new host to an existing cluster.

Parameters:	session ref session_id	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
Result:	the newly created cluster_host object
Errors:	PIF_NOT_ATTACHED_TO_HOST	Cluster_host creation failed as the PIF provided is not attached to the host.
	NO_CLUSTER_HOSTS_REACHABLE	No other cluster host was reachable when joining
Prototyped in:	XenServer 7.5 (kolkata)
Published in:	XenServer 7.6 (lima)

void destroy (session ref, Cluster_host ref)

Remove the host from an existing cluster. This operation is allowed even if a cluster host is not enabled.

Parameters:	session ref session_id	Reference to a valid session
	Cluster_host ref self	the cluster_host to remove from the cluster
Minimum role:	pool-operator
Errors:	CLUSTER_STACK_IN_USE	The cluster stack is still in use by at least one plugged PBD.
	CLUSTERING_DISABLED	An operation was attempted while clustering was disabled on the cluster_host.
	CLUSTER_HOST_IS_LAST	The last cluster host cannot be destroyed. Destroy the cluster instead
Prototyped in:	XenServer 7.5 (kolkata)
Published in:	XenServer 7.6 (lima)

void disable (session ref, Cluster_host ref)

Disable cluster membership for an enabled cluster host.

Parameters:	session ref session_id	Reference to a valid session
	Cluster_host ref self	the cluster_host to disable
Minimum role:	pool-operator
Errors:	CLUSTER_STACK_IN_USE	The cluster stack is still in use by at least one plugged PBD.
Prototyped in:	XenServer 7.5 (kolkata)
Published in:	XenServer 7.6 (lima)

void enable (session ref, Cluster_host ref)

Enable cluster membership for a disabled cluster host.

Parameters:	session ref session_id	Reference to a valid session
	Cluster_host ref self	the cluster_host to enable
Minimum role:	pool-operator
Errors:	PIF_ALLOWS_UNPLUG	The operation you requested cannot be performed because the specified PIF allows unplug.
	REQUIRED_PIF_IS_UNPLUGGED	The operation you requested cannot be performed because the specified PIF is currently unplugged.
Prototyped in:	XenServer 7.5 (kolkata)
Published in:	XenServer 7.6 (lima)

void force_destroy (session ref, Cluster_host ref)

Remove a host from an existing cluster forcefully.

Parameters:	session ref session_id	Reference to a valid session
	Cluster_host ref self	the cluster_host to remove from the cluster
Minimum role:	pool-operator
Errors:	CLUSTER_STACK_IN_USE	The cluster stack is still in use by at least one plugged PBD.
Prototyped in:	XenServer 7.5 (kolkata)
Published in:	XenServer 7.6 (lima)

PIF ref get_PIF (session ref, Cluster_host ref)

Get the PIF field of the given Cluster_host.

Parameters:	session ref session_id	Reference to a valid session
	Cluster_host ref self	reference to the object
Minimum role:	read-only
Result:	value of the field
Prototyped in:	XenServer 7.5 (kolkata)
Published in:	XenServer 7.6 (lima)

Cluster_host ref set get_all (session ref)

Return a list of all the Cluster_hosts known to the system.

Parameters:	session ref session_id	Reference to a valid session
Minimum role:	read-only
Result:	references to all objects
Prototyped in:	XenServer 7.5 (kolkata)
Published in:	XenServer 7.6 (lima)

(Cluster_host ref → Cluster_host record) map get_all_records (session ref)

Return a map of Cluster_host references to Cluster_host records for all Cluster_hosts known to the system.

Parameters:	session ref session_id	Reference to a valid session
Minimum role:	read-only
Result:	records of all objects
Prototyped in:	XenServer 7.5 (kolkata)
Published in:	XenServer 7.6 (lima)

enum cluster_host_operation set get_allowed_operations (session ref, Cluster_host ref)

Get the allowed_operations field of the given Cluster_host.

Parameters:	session ref session_id	Reference to a valid session
	Cluster_host ref self	reference to the object
Minimum role:	read-only
Result:	value of the field
Published in:	XenServer 4.0 (rio)	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_host ref get_by_uuid (session ref, string)

Get a reference to the Cluster_host instance with the specified UUID.

Parameters:	session ref session_id	Reference to a valid session
	string uuid	UUID of object to return
Minimum role:	read-only
Result:	reference to the object
Prototyped in:	XenServer 7.5 (kolkata)
Published in:	XenServer 7.6 (lima)

Cluster ref get_cluster (session ref, Cluster_host ref)

Get the cluster field of the given Cluster_host.

Parameters:	session ref session_id	Reference to a valid session
	Cluster_host ref self	reference to the object
Minimum role:	read-only
Result:	value of the field
Prototyped in:	XenServer 7.5 (kolkata)
Published in:	XenServer 7.6 (lima)

(string → enum cluster_host_operation) map get_current_operations (session ref, Cluster_host ref)

Get the current_operations field of the given Cluster_host.

Parameters:	session ref session_id	Reference to a valid session
	Cluster_host ref self	reference to the object
Minimum role:	read-only
Result:	value of the field
Published in:	XenServer 4.0 (rio)	links each of the running tasks using this object (by reference) to a current_operation enum which describes the nature of the task.

bool get_enabled (session ref, Cluster_host ref)

Get the enabled field of the given Cluster_host.

Parameters:	session ref session_id	Reference to a valid session
	Cluster_host ref self	reference to the object
Minimum role:	read-only
Result:	value of the field
Prototyped in:	XenServer 7.5 (kolkata)
Published in:	XenServer 7.6 (lima)

host ref get_host (session ref, Cluster_host ref)

Get the host field of the given Cluster_host.

Parameters:	session ref session_id	Reference to a valid session
	Cluster_host ref self	reference to the object
Minimum role:	read-only
Result:	value of the field
Prototyped in:	XenServer 7.5 (kolkata)
Published in:	XenServer 7.6 (lima)

bool get_joined (session ref, Cluster_host ref)

Get the joined field of the given Cluster_host.

Parameters:	session ref session_id	Reference to a valid session
	Cluster_host ref self	reference to the object
Minimum role:	read-only
Result:	value of the field
Prototyped in:	XenServer 7.5 (kolkata)
Published in:	XenServer 7.6 (lima)

Prototype

datetime get_last_update_live (session ref, Cluster_host ref)

Get the last_update_live field of the given Cluster_host.

Parameters:	session ref session_id	Reference to a valid session
	Cluster_host ref self	reference to the object
Minimum role:	read-only
Result:	value of the field
Prototyped in:	XAPI 24.3.0 (24.3.0)

Prototype

bool get_live (session ref, Cluster_host ref)

Get the live field of the given Cluster_host.

Parameters:	session ref session_id	Reference to a valid session
	Cluster_host ref self	reference to the object
Minimum role:	read-only
Result:	value of the field
Prototyped in:	XAPI 24.3.0 (24.3.0)

(string → string) map get_other_config (session ref, Cluster_host ref)

Get the other_config field of the given Cluster_host.

Parameters:	session ref session_id	Reference to a valid session
	Cluster_host ref self	reference to the object
Minimum role:	read-only
Result:	value of the field
Prototyped in:	XenServer 7.5 (kolkata)
Published in:	XenServer 7.6 (lima)

Cluster_host record get_record (session ref, Cluster_host ref)

Get a record containing the current state of the given Cluster_host.

Parameters:	session ref session_id	Reference to a valid session
	Cluster_host ref self	reference to the object
Minimum role:	read-only
Result:	all fields from the object
Prototyped in:	XenServer 7.5 (kolkata)
Published in:	XenServer 7.6 (lima)

string get_uuid (session ref, Cluster_host ref)

Get the uuid field of the given Cluster_host.

Parameters:	session ref session_id	Reference to a valid session
	Cluster_host ref self	reference to the object
Minimum role:	read-only
Result:	value of the field
Prototyped in:	XenServer 7.5 (kolkata)
Published in:	XenServer 7.6 (lima)

Class: Cluster_host

Enums

Fields

Messages Hide implicit

Classes

Messages