View Source XenAPI.Cluster (XenAPI v0.2.0)

Link to this section Summary

Functions

Add the given key-value pair to the other_config field of the given Cluster.

Add the given key-value pair to the other_config field of the given Cluster. (Raise error on XMLRPC failure)

Creates a Cluster object and one Cluster_host object as its first member

Creates a Cluster object and one Cluster_host object as its first member (Raise error on XMLRPC failure)

Destroys a Cluster object and the one remaining Cluster_host member

Destroys a Cluster object and the one remaining Cluster_host member (Raise error on XMLRPC failure)

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

Return a list of all the Clusters known to the system. (Raise error on XMLRPC failure)

Return a map of Cluster references to Cluster records for all Clusters known to the system.

Return a map of Cluster references to Cluster records for all Clusters known to the system. (Raise error on XMLRPC failure)

Get the allowed_operations field of the given Cluster.

Get the allowed_operations field of the given Cluster. (Raise error on XMLRPC failure)

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

Get a reference to the Cluster instance with the specified UUID. (Raise error on XMLRPC failure)

Get the cluster_config field of the given Cluster.

Get the cluster_config field of the given Cluster. (Raise error on XMLRPC failure)

Get the cluster_hosts field of the given Cluster.

Get the cluster_hosts field of the given Cluster. (Raise error on XMLRPC failure)

Get the cluster_stack field of the given Cluster.

Get the cluster_stack field of the given Cluster. (Raise error on XMLRPC failure)

Get the cluster_token field of the given Cluster.

Get the cluster_token field of the given Cluster. (Raise error on XMLRPC failure)

Get the current_operations field of the given Cluster.

Get the current_operations field of the given Cluster. (Raise error on XMLRPC failure)

Returns the network used by the cluster for inter-host communication, i.e. the network shared by all cluster host PIFs

Returns the network used by the cluster for inter-host communication, i.e. the network shared by all cluster host PIFs (Raise error on XMLRPC failure)

Get the other_config field of the given Cluster.

Get the other_config field of the given Cluster. (Raise error on XMLRPC failure)

Get the pending_forget field of the given Cluster.

Get the pending_forget field of the given Cluster. (Raise error on XMLRPC failure)

Get the pool_auto_join field of the given Cluster.

Get the pool_auto_join field of the given Cluster. (Raise error on XMLRPC failure)

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

Get a record containing the current state of the given Cluster. (Raise error on XMLRPC failure)

Get the token_timeout field of the given Cluster.

Get the token_timeout field of the given Cluster. (Raise error on XMLRPC failure)

Get the token_timeout_coefficient field of the given Cluster.

Get the token_timeout_coefficient field of the given Cluster. (Raise error on XMLRPC failure)

Get the uuid field of the given Cluster.

Get the uuid field of the given Cluster. (Raise error on XMLRPC failure)

Attempt to create a Cluster from the entire pool (Raise error on XMLRPC failure)

Attempt to destroy the Cluster_host objects for all hosts in the pool and then destroy the Cluster.

Attempt to destroy the Cluster_host objects for all hosts in the pool and then destroy the Cluster. (Raise error on XMLRPC failure)

Attempt to force destroy the Cluster_host objects, and then destroy the Cluster.

Attempt to force destroy the Cluster_host objects, and then destroy the Cluster. (Raise error on XMLRPC failure)

Resynchronise the cluster_host objects across the pool. Creates them where they need creating and then plugs them

Resynchronise the cluster_host objects across the pool. Creates them where they need creating and then plugs them (Raise error on XMLRPC failure)

Remove the given key and its corresponding value from the other_config field of the given Cluster. If the key is not in that Map, then do nothing.

Remove the given key and its corresponding value from the other_config field of the given Cluster. If the key is not in that Map, then do nothing. (Raise error on XMLRPC failure)

Set the other_config field of the given Cluster.

Set the other_config field of the given Cluster. (Raise error on XMLRPC failure)

Link to this section Functions

Link to this function

add_to_other_config(xen_session, cluster_ref, key, value)

View Source

Add the given key-value pair to the other_config field of the given Cluster.

Link to this function

add_to_other_config!(xen_session, cluster_ref, key, value)

View Source

Add the given key-value pair to the other_config field of the given Cluster. (Raise error on XMLRPC failure)

Link to this function

create(xen_session, arg, cluster_stack, pool_auto_join, token_timeout, token_timeout_coefficient)

View Source

Creates a Cluster object and one Cluster_host object as its first member

Link to this function

create!(xen_session, arg, cluster_stack, pool_auto_join, token_timeout, token_timeout_coefficient)

View Source

Creates a Cluster object and one Cluster_host object as its first member (Raise error on XMLRPC failure)

Link to this function

destroy(xen_session, cluster_ref)

View Source

Destroys a Cluster object and the one remaining Cluster_host member

Link to this function

destroy!(xen_session, cluster_ref)

View Source

Destroys a Cluster object and the one remaining Cluster_host member (Raise error on XMLRPC failure)

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

Return a list of all the Clusters known to the system. (Raise error on XMLRPC failure)

Link to this function

get_all_records(xen_session)

View Source

Return a map of Cluster references to Cluster records for all Clusters known to the system.

Link to this function

get_all_records!(xen_session)

View Source

Return a map of Cluster references to Cluster records for all Clusters known to the system. (Raise error on XMLRPC failure)

Link to this function

get_allowed_operations(xen_session, cluster_ref)

View Source

Get the allowed_operations field of the given Cluster.

Link to this function

get_allowed_operations!(xen_session, cluster_ref)

View Source

Get the allowed_operations field of the given Cluster. (Raise error on XMLRPC failure)

Link to this function

get_by_uuid(xen_session, uuid)

View Source

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

Link to this function

get_by_uuid!(xen_session, uuid)

View Source

Get a reference to the Cluster instance with the specified UUID. (Raise error on XMLRPC failure)

Link to this function

get_cluster_config(xen_session, cluster_ref)

View Source

Get the cluster_config field of the given Cluster.

Link to this function

get_cluster_config!(xen_session, cluster_ref)

View Source

Get the cluster_config field of the given Cluster. (Raise error on XMLRPC failure)

Link to this function

get_cluster_hosts(xen_session, cluster_ref)

View Source

Get the cluster_hosts field of the given Cluster.

Link to this function

get_cluster_hosts!(xen_session, cluster_ref)

View Source

Get the cluster_hosts field of the given Cluster. (Raise error on XMLRPC failure)

Link to this function

get_cluster_stack(xen_session, cluster_ref)

View Source

Get the cluster_stack field of the given Cluster.

Link to this function

get_cluster_stack!(xen_session, cluster_ref)

View Source

Get the cluster_stack field of the given Cluster. (Raise error on XMLRPC failure)

Link to this function

get_cluster_token(xen_session, cluster_ref)

View Source

Get the cluster_token field of the given Cluster.

Link to this function

get_cluster_token!(xen_session, cluster_ref)

View Source

Get the cluster_token field of the given Cluster. (Raise error on XMLRPC failure)

Link to this function

get_current_operations(xen_session, cluster_ref)

View Source

Get the current_operations field of the given Cluster.

Link to this function

get_current_operations!(xen_session, cluster_ref)

View Source

Get the current_operations field of the given Cluster. (Raise error on XMLRPC failure)

Link to this function

get_network(xen_session, cluster_ref)

View Source

Returns the network used by the cluster for inter-host communication, i.e. the network shared by all cluster host PIFs

Link to this function

get_network!(xen_session, cluster_ref)

View Source

Returns the network used by the cluster for inter-host communication, i.e. the network shared by all cluster host PIFs (Raise error on XMLRPC failure)

Link to this function

get_other_config(xen_session, cluster_ref)

View Source

Get the other_config field of the given Cluster.

Link to this function

get_other_config!(xen_session, cluster_ref)

View Source

Get the other_config field of the given Cluster. (Raise error on XMLRPC failure)

Link to this function

get_pending_forget(xen_session, cluster_ref)

View Source

Get the pending_forget field of the given Cluster.

Link to this function

get_pending_forget!(xen_session, cluster_ref)

View Source

Get the pending_forget field of the given Cluster. (Raise error on XMLRPC failure)

Link to this function

get_pool_auto_join(xen_session, cluster_ref)

View Source

Get the pool_auto_join field of the given Cluster.

Link to this function

get_pool_auto_join!(xen_session, cluster_ref)

View Source

Get the pool_auto_join field of the given Cluster. (Raise error on XMLRPC failure)

Link to this function

get_record(xen_session, cluster_ref)

View Source

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

Link to this function

get_record!(xen_session, cluster_ref)

View Source

Get a record containing the current state of the given Cluster. (Raise error on XMLRPC failure)

Link to this function

get_token_timeout(xen_session, cluster_ref)

View Source

Get the token_timeout field of the given Cluster.

Link to this function

get_token_timeout!(xen_session, cluster_ref)

View Source

Get the token_timeout field of the given Cluster. (Raise error on XMLRPC failure)

Link to this function

get_token_timeout_coefficient(xen_session, cluster_ref)

View Source

Get the token_timeout_coefficient field of the given Cluster.

Link to this function

get_token_timeout_coefficient!(xen_session, cluster_ref)

View Source

Get the token_timeout_coefficient field of the given Cluster. (Raise error on XMLRPC failure)

Link to this function

get_uuid(xen_session, cluster_ref)

View Source

Get the uuid field of the given Cluster.

Link to this function

get_uuid!(xen_session, cluster_ref)

View Source

Get the uuid field of the given Cluster. (Raise error on XMLRPC failure)

Link to this function

pool_create(xen_session, network, cluster_stack, token_timeout, token_timeout_coefficient)

View Source

Attempt to create a Cluster from the entire pool

Link to this function

pool_create!(xen_session, network, cluster_stack, token_timeout, token_timeout_coefficient)

View Source

Attempt to create a Cluster from the entire pool (Raise error on XMLRPC failure)

Link to this function

pool_destroy(xen_session, cluster_ref)

View Source

Attempt to destroy the Cluster_host objects for all hosts in the pool and then destroy the Cluster.

Link to this function

pool_destroy!(xen_session, cluster_ref)

View Source

Attempt to destroy the Cluster_host objects for all hosts in the pool and then destroy the Cluster. (Raise error on XMLRPC failure)

Link to this function

pool_force_destroy(xen_session, cluster_ref)

View Source

Attempt to force destroy the Cluster_host objects, and then destroy the Cluster.

Link to this function

pool_force_destroy!(xen_session, cluster_ref)

View Source

Attempt to force destroy the Cluster_host objects, and then destroy the Cluster. (Raise error on XMLRPC failure)

Link to this function

pool_resync(xen_session, cluster_ref)

View Source

Resynchronise the cluster_host objects across the pool. Creates them where they need creating and then plugs them

Link to this function

pool_resync!(xen_session, cluster_ref)

View Source

Resynchronise the cluster_host objects across the pool. Creates them where they need creating and then plugs them (Raise error on XMLRPC failure)

Link to this function

remove_from_other_config(xen_session, cluster_ref, key)

View Source

Remove the given key and its corresponding value from the other_config field of the given Cluster. If the key is not in that Map, then do nothing.

Link to this function

remove_from_other_config!(xen_session, cluster_ref, key)

View Source

Remove the given key and its corresponding value from the other_config field of the given Cluster. If the key is not in that Map, then do nothing. (Raise error on XMLRPC failure)

Link to this function

set_other_config(xen_session, cluster_ref, value)

View Source

Set the other_config field of the given Cluster.

Link to this function

set_other_config!(xen_session, cluster_ref, value)

View Source

Set the other_config field of the given Cluster. (Raise error on XMLRPC failure)