/Classes/pool

Classes / pool / index.html

Pool-wide information

Fields

string uuid
Unique identifier/object reference
string name_label
Short name
string name_description
Description
host master
The host that is pool master
SR default_SR
Default SR for VDIs
SR suspend_image_SR
The SR in which VDIs for suspend images are created
SR crash_dump_SR
The SR in which VDIs for crash dumps are created
Map[string,string] other_config
additional configuration
bool ha_enabled
true if HA is enabled on the pool, false otherwise
Map[string,string] ha_configuration
The current HA configuration
Set[string] ha_statefiles
HA statefile VDIs in use
int ha_host_failures_to_tolerate
Number of host failures to tolerate before the Pool is declared to be overcommitted
int ha_plan_exists_for
Number of future host failures we have managed to find a plan for. Once this reaches zero any future host failures will cause the failure of protected VMs.
bool ha_allow_overcommit
If set to false then operations which would cause the Pool to become overcommitted will be blocked.
bool ha_overcommitted
True if the Pool is considered to be overcommitted i.e. if there exist insufficient physical resources to tolerate the configured number of host failures
Map[string,blob] blobs
Binary blobs associated with this pool
Set[string] tags
user-specified tags for categorization purposes
Map[string,string] gui_config
gui-specific configuration for pool
string wlb_url
Url for the configured workload balancing host
string wlb_username
Username for accessing the workload balancing host
secret wlb_password
Password for accessing the workload balancing host
bool wlb_enabled
true if workload balancing is enabled on the pool, false otherwise
bool wlb_verify_cert
true if communication with the WLB server should enforce SSL certificate verification.
bool redo_log_enabled
true a redo-log is to be used other than when HA is enabled, false otherwise
VDI redo_log_vdi
indicates the VDI to use for the redo-log other than when HA is enabled
string vswitch_controller
address of the vswitch controller
Map[string,string] restrictions
Pool-wide restrictions currently in effect

Implicit messages

Record[pool] get_record (session session_id, pool self)
Get a record containing the current state of the given pool.
pool get_by_uuid (session session_id, string uuid)
Get a reference to the pool instance with the specified UUID.
Set[pool] get_all (session session_id)
Return a list of all the pools known to the system.
Map[pool,Record[pool]] get_all_records (session session_id)
Return a map of pool references to pool records for all pools known to the system.

Explicit messages

void join (session session_id, string master_address, string master_username, string master_password)
Instruct host to join a new pool
void join_force (session session_id, string master_address, string master_username, string master_password)
Instruct host to join a new pool
void eject (session session_id, host host)
Instruct a pool master to eject a host from the pool
void emergency_transition_to_master (session session_id)
Instruct host that's currently a slave to transition to being master
void emergency_reset_master (session session_id, string master_address)
Instruct a slave already in a pool that the master has changed
Set[host] recover_slaves (session session_id)
Instruct a pool master, M, to try and contact its slaves and, if slaves are in emergency mode, reset their master address to M.
Set[PIF] create_VLAN (session session_id, string device, network network, int VLAN)
Create PIFs, mapping a network to the same physical interface/VLAN on each host. This call is deprecated: use Pool.create_VLAN_from_PIF instead.
Set[PIF] create_VLAN_from_PIF (session session_id, PIF pif, network network, int VLAN)
Create a pool-wide VLAN by taking the PIF.
void enable_ha (session session_id, Set[SR] heartbeat_srs, Map[string,string] configuration)
Turn on High Availability mode
void disable_ha (session session_id)
Turn off High Availability mode
void sync_database (session session_id)
Forcibly synchronise the database now
void designate_new_master (session session_id, host host)
Perform an orderly handover of the role of master to the referenced host.
void ha_prevent_restarts_for (session session_id, int seconds)
When this call returns the VM restart logic will not run for the requested number of seconds. If the argument is zero then the restart thread is immediately unblocked
bool ha_failover_plan_exists (session session_id, int n)
Returns true if a VM failover plan exists for up to 'n' host failures
int ha_compute_max_host_failures_to_tolerate (session session_id)
Returns the maximum number of host failures we could tolerate before we would be unable to restart configured VMs
int ha_compute_hypothetical_max_host_failures_to_tolerate (session session_id, Map[VM,string] configuration)
Returns the maximum number of host failures we could tolerate before we would be unable to restart the provided VMs
Map[VM,Map[string,string]] ha_compute_vm_failover_plan (session session_id, Set[host] failed_hosts, Set[VM] failed_vms)
Return a VM failover plan assuming a given subset of hosts fail
void set_ha_host_failures_to_tolerate (session session_id, pool self, int value)
Set the maximum number of host failures to consider in the HA VM restart planner
blob create_new_blob (session session_id, pool pool, string name, string mime_type)
Create a placeholder for a named binary blob of data that is associated with this pool
void enable_external_auth (session session_id, pool pool, Map[string,string] config, string service_name, string auth_type)
This call enables external authentication on all the hosts of the pool
void disable_external_auth (session session_id, pool pool, Map[string,string] config)
This call disables external authentication on all the hosts of the pool
void detect_nonhomogeneous_external_auth (session session_id, pool pool)
This call asynchronously detects if the external authentication configuration in any slave is different from that in the master and raises appropriate alerts
void initialize_wlb (session session_id, string wlb_url, string wlb_username, string wlb_password, string xenserver_username, string xenserver_password)
Initializes workload balancing monitoring on this pool with the specified wlb server
void deconfigure_wlb (session session_id)
Permanently deconfigures workload balancing monitoring on this pool
void send_wlb_configuration (session session_id, Map[string,string] config)
Sets the pool optimization criteria for the workload balancing server
Map[string,string] retrieve_wlb_configuration (session session_id)
Retrieves the pool optimization criteria from the workload balancing server
Map[VM,Set[string]] retrieve_wlb_recommendations (session session_id)
Retrieves vm migrate recommendations for the pool from the workload balancing server
string send_test_post (session session_id, string host, int port, string body)
Send the given body to the given host and port, using HTTPS, and print the response. This is used for debugging the SSL layer.
void certificate_install (session session_id, string name, string cert)
Install an SSL certificate pool-wide.
void certificate_uninstall (session session_id, string name)
Remove an SSL certificate.
Set[string] certificate_list (session session_id)
List all installed SSL certificates.
void crl_install (session session_id, string name, string cert)
Install an SSL certificate revocation list, pool-wide.
void crl_uninstall (session session_id, string name)
Remove an SSL certificate revocation list.
Set[string] crl_list (session session_id)
List all installed SSL certificate revocation lists.
void certificate_sync (session session_id)
Sync SSL certificates from master to slaves.
void enable_redo_log (session session_id, SR sr)
Enable the redo log on the given SR and start using it, unless HA is enabled.
void disable_redo_log (session session_id)
Disable the redo log if in use, unless HA is enabled.
void set_vswitch_controller (session session_id, string address)
Set the IP address of the vswitch controller.
string test_archive_target (session session_id, pool self, Map[string,string] config)
This call tests if a location is valid
void enable_local_storage_caching (session session_id, pool self)
This call attempts to enable pool-wide local storage caching
void disable_local_storage_caching (session session_id, pool self)
This call disables pool-wide local storage caching