View Source XenAPI.Pool (XenAPI v0.2.0)

Link to this section Summary

Functions

Add the given value to the tags field of the given pool. If the value is already in that Set, then do nothing.

Add the given value to the tags field of the given pool. If the value is already in that Set, then do nothing. (Raise error on XMLRPC failure)

Add a key-value pair to the pool-wide guest agent configuration

Add a key-value pair to the pool-wide guest agent configuration (Raise error on XMLRPC failure)

Add the given key-value pair to the gui_config field of the given pool.

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

Add the given key-value pair to the health_check_config field of the given pool.

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

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

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

Apply an edition to all hosts in the pool

Apply an edition to all hosts in the pool (Raise error on XMLRPC failure)

Install an SSL certificate pool-wide.

Install an SSL certificate pool-wide. (Raise error on XMLRPC failure)

List all installed SSL certificates.

List all installed SSL certificates. (Raise error on XMLRPC failure)

Sync SSL certificates from master to slaves.

Sync SSL certificates from master to slaves. (Raise error on XMLRPC failure)

Remove an SSL certificate.

Remove an SSL certificate. (Raise error on XMLRPC failure)

Create a placeholder for a named binary blob of data that is associated with this pool

Create a placeholder for a named binary blob of data that is associated with this pool (Raise error on XMLRPC failure)

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.

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. (Raise error on XMLRPC failure)

Create a pool-wide VLAN by taking the PIF.

Create a pool-wide VLAN by taking the PIF. (Raise error on XMLRPC failure)

Install an SSL certificate revocation list, pool-wide.

Install an SSL certificate revocation list, pool-wide. (Raise error on XMLRPC failure)

List all installed SSL certificate revocation lists.

List all installed SSL certificate revocation lists. (Raise error on XMLRPC failure)

Remove an SSL certificate revocation list.

Remove an SSL certificate revocation list. (Raise error on XMLRPC failure)

Permanently deconfigures workload balancing monitoring on this pool

Permanently deconfigures workload balancing monitoring on this pool (Raise error on XMLRPC failure)

Perform an orderly handover of the role of master to the referenced host.

Perform an orderly handover of the role of master to the referenced host. (Raise error on XMLRPC failure)

This call asynchronously detects if the external authentication configuration in any slave is different from that in the master and raises appropriate alerts

This call asynchronously detects if the external authentication configuration in any slave is different from that in the master and raises appropriate alerts (Raise error on XMLRPC failure)

This call disables external authentication on all the hosts of the pool

This call disables external authentication on all the hosts of the pool (Raise error on XMLRPC failure)

Turn off High Availability mode

Turn off High Availability mode (Raise error on XMLRPC failure)

This call disables pool-wide local storage caching

This call disables pool-wide local storage caching (Raise error on XMLRPC failure)

Disable the redo log if in use, unless HA is enabled.

Disable the redo log if in use, unless HA is enabled. (Raise error on XMLRPC failure)

Sets ssl_legacy true on each host, pool-master last. See Host.ssl_legacy and Host.set_ssl_legacy.

Sets ssl_legacy true on each host, pool-master last. See Host.ssl_legacy and Host.set_ssl_legacy. (Raise error on XMLRPC failure)

Instruct a pool master to eject a host from the pool

Instruct a pool master to eject a host from the pool (Raise error on XMLRPC failure)

Instruct a slave already in a pool that the master has changed

Instruct a slave already in a pool that the master has changed (Raise error on XMLRPC failure)

Instruct host that's currently a slave to transition to being master

Instruct host that's currently a slave to transition to being master (Raise error on XMLRPC failure)

This call enables external authentication on all the hosts of the pool

This call enables external authentication on all the hosts of the pool (Raise error on XMLRPC failure)

Turn on High Availability mode (Raise error on XMLRPC failure)

This call attempts to enable pool-wide local storage caching

This call attempts to enable pool-wide local storage caching (Raise error on XMLRPC failure)

Enable the redo log on the given SR and start using it, unless HA is enabled.

Enable the redo log on the given SR and start using it, unless HA is enabled. (Raise error on XMLRPC failure)

Sets ssl_legacy true on each host, pool-master last. See Host.ssl_legacy and Host.set_ssl_legacy.

Sets ssl_legacy true on each host, pool-master last. See Host.ssl_legacy and Host.set_ssl_legacy. (Raise error on XMLRPC failure)

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

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

Return a map of pool references to pool records for all pools known to the system.

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

Get the allowed_operations field of the given pool.

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

Get the blobs field of the given pool.

Get the blobs field of the given pool. (Raise error on XMLRPC failure)

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

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

Get the cpu_info field of the given pool.

Get the cpu_info field of the given pool. (Raise error on XMLRPC failure)

Get the crash_dump_SR field of the given pool.

Get the crash_dump_SR field of the given pool. (Raise error on XMLRPC failure)

Get the current_operations field of the given pool.

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

Get the default_SR field of the given pool.

Get the default_SR field of the given pool. (Raise error on XMLRPC failure)

Get the guest_agent_config field of the given pool.

Get the guest_agent_config field of the given pool. (Raise error on XMLRPC failure)

Get the gui_config field of the given pool.

Get the gui_config field of the given pool. (Raise error on XMLRPC failure)

Get the ha_allow_overcommit field of the given pool.

Get the ha_allow_overcommit field of the given pool. (Raise error on XMLRPC failure)

Get the ha_cluster_stack field of the given pool.

Get the ha_cluster_stack field of the given pool. (Raise error on XMLRPC failure)

Get the ha_configuration field of the given pool.

Get the ha_configuration field of the given pool. (Raise error on XMLRPC failure)

Get the ha_enabled field of the given pool.

Get the ha_enabled field of the given pool. (Raise error on XMLRPC failure)

Get the ha_host_failures_to_tolerate field of the given pool.

Get the ha_host_failures_to_tolerate field of the given pool. (Raise error on XMLRPC failure)

Get the ha_overcommitted field of the given pool.

Get the ha_overcommitted field of the given pool. (Raise error on XMLRPC failure)

Get the ha_plan_exists_for field of the given pool.

Get the ha_plan_exists_for field of the given pool. (Raise error on XMLRPC failure)

Get the ha_statefiles field of the given pool.

Get the ha_statefiles field of the given pool. (Raise error on XMLRPC failure)

Get the health_check_config field of the given pool.

Get the health_check_config field of the given pool. (Raise error on XMLRPC failure)

Get the igmp_snooping_enabled field of the given pool.

Get the igmp_snooping_enabled field of the given pool. (Raise error on XMLRPC failure)

This call returns the license state for the pool

This call returns the license state for the pool (Raise error on XMLRPC failure)

Get the live_patching_disabled field of the given pool.

Get the live_patching_disabled field of the given pool. (Raise error on XMLRPC failure)

Get the master field of the given pool.

Get the master field of the given pool. (Raise error on XMLRPC failure)

Get the metadata_VDIs field of the given pool.

Get the metadata_VDIs field of the given pool. (Raise error on XMLRPC failure)

Get the name_description field of the given pool.

Get the name_description field of the given pool. (Raise error on XMLRPC failure)

Get the name_label field of the given pool.

Get the name_label field of the given pool. (Raise error on XMLRPC failure)

Get the other_config field of the given pool.

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

Get the policy_no_vendor_device field of the given pool.

Get the policy_no_vendor_device field of the given pool. (Raise error on XMLRPC failure)

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

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

Get the redo_log_enabled field of the given pool.

Get the redo_log_enabled field of the given pool. (Raise error on XMLRPC failure)

Get the redo_log_vdi field of the given pool.

Get the redo_log_vdi field of the given pool. (Raise error on XMLRPC failure)

Get the restrictions field of the given pool.

Get the restrictions field of the given pool. (Raise error on XMLRPC failure)

Get the suspend_image_SR field of the given pool.

Get the suspend_image_SR field of the given pool. (Raise error on XMLRPC failure)

Get the tags field of the given pool.

Get the tags field of the given pool. (Raise error on XMLRPC failure)

Get the uefi_certificates field of the given pool.

Get the uefi_certificates field of the given pool. (Raise error on XMLRPC failure)

Get the uuid field of the given pool.

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

Get the vswitch_controller field of the given pool.

Get the vswitch_controller field of the given pool. (Raise error on XMLRPC failure)

Get the wlb_enabled field of the given pool.

Get the wlb_enabled field of the given pool. (Raise error on XMLRPC failure)

Get the wlb_url field of the given pool.

Get the wlb_url field of the given pool. (Raise error on XMLRPC failure)

Get the wlb_username field of the given pool.

Get the wlb_username field of the given pool. (Raise error on XMLRPC failure)

Get the wlb_verify_cert field of the given pool.

Get the wlb_verify_cert field of the given pool. (Raise error on XMLRPC failure)

Returns the maximum number of host failures we could tolerate before we would be unable to restart the provided VMs

Returns the maximum number of host failures we could tolerate before we would be unable to restart the provided VMs (Raise error on XMLRPC failure)

Returns the maximum number of host failures we could tolerate before we would be unable to restart configured VMs

Returns the maximum number of host failures we could tolerate before we would be unable to restart configured VMs (Raise error on XMLRPC failure)

Return a VM failover plan assuming a given subset of hosts fail

Return a VM failover plan assuming a given subset of hosts fail (Raise error on XMLRPC failure)

Returns true if a VM failover plan exists for up to 'n' host failures

Returns true if a VM failover plan exists for up to 'n' host failures (Raise error on XMLRPC failure)

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

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 (Raise error on XMLRPC failure)

Return true if the extension is available on the pool

Return true if the extension is available on the pool (Raise error on XMLRPC failure)

Initializes workload balancing monitoring on this pool with the specified wlb server

Initializes workload balancing monitoring on this pool with the specified wlb server (Raise error on XMLRPC failure)

Instruct host to join a new pool (Raise error on XMLRPC failure)

Instruct host to join a new pool (Raise error on XMLRPC failure)

Reconfigure the management network interface for all Hosts in the Pool

Reconfigure the management network interface for all Hosts in the Pool (Raise error on XMLRPC failure)

Instruct a pool master, M, to try and contact its slaves and, if slaves are in emergency mode, reset their master address to M.

Instruct a pool master, M, to try and contact its slaves and, if slaves are in emergency mode, reset their master address to M. (Raise error on XMLRPC failure)

Remove a key-value pair from the pool-wide guest agent configuration

Remove a key-value pair from the pool-wide guest agent configuration (Raise error on XMLRPC failure)

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

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

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

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

Remove the given key and its corresponding value from the other_config field of the given pool. 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 pool. If the key is not in that Map, then do nothing. (Raise error on XMLRPC failure)

Remove the given value from the tags field of the given pool. If the value is not in that Set, then do nothing.

Remove the given value from the tags field of the given pool. If the value is not in that Set, then do nothing. (Raise error on XMLRPC failure)

Retrieves the pool optimization criteria from the workload balancing server

Retrieves the pool optimization criteria from the workload balancing server (Raise error on XMLRPC failure)

Retrieves vm migrate recommendations for the pool from the workload balancing server

Retrieves vm migrate recommendations for the pool from the workload balancing server (Raise error on XMLRPC failure)

Send the given body to the given host and port, using HTTPS, and print the response. This is used for debugging the SSL layer.

Send the given body to the given host and port, using HTTPS, and print the response. This is used for debugging the SSL layer. (Raise error on XMLRPC failure)

Sets the pool optimization criteria for the workload balancing server

Sets the pool optimization criteria for the workload balancing server (Raise error on XMLRPC failure)

Set the crash_dump_SR field of the given pool.

Set the crash_dump_SR field of the given pool. (Raise error on XMLRPC failure)

Set the default_SR field of the given pool.

Set the default_SR field of the given pool. (Raise error on XMLRPC failure)

Set the gui_config field of the given pool.

Set the gui_config field of the given pool. (Raise error on XMLRPC failure)

Set the ha_allow_overcommit field of the given pool.

Set the ha_allow_overcommit field of the given pool. (Raise error on XMLRPC failure)

Set the maximum number of host failures to consider in the HA VM restart planner

Set the maximum number of host failures to consider in the HA VM restart planner (Raise error on XMLRPC failure)

Set the health_check_config field of the given pool.

Set the health_check_config field of the given pool. (Raise error on XMLRPC failure)

Enable or disable IGMP Snooping on the pool.

Enable or disable IGMP Snooping on the pool. (Raise error on XMLRPC failure)

Set the live_patching_disabled field of the given pool.

Set the live_patching_disabled field of the given pool. (Raise error on XMLRPC failure)

Set the name_description field of the given pool.

Set the name_description field of the given pool. (Raise error on XMLRPC failure)

Set the name_label field of the given pool.

Set the name_label field of the given pool. (Raise error on XMLRPC failure)

Set the other_config field of the given pool.

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

Set the policy_no_vendor_device field of the given pool.

Set the policy_no_vendor_device field of the given pool. (Raise error on XMLRPC failure)

Set the suspend_image_SR field of the given pool.

Set the suspend_image_SR field of the given pool. (Raise error on XMLRPC failure)

Set the tags field of the given pool.

Set the tags field of the given pool. (Raise error on XMLRPC failure)

Set the uefi_certificates field of the given pool.

Set the uefi_certificates field of the given pool. (Raise error on XMLRPC failure)

Set the IP address of the vswitch controller.

Set the IP address of the vswitch controller. (Raise error on XMLRPC failure)

Set the wlb_enabled field of the given pool.

Set the wlb_enabled field of the given pool. (Raise error on XMLRPC failure)

Set the wlb_verify_cert field of the given pool.

Set the wlb_verify_cert field of the given pool. (Raise error on XMLRPC failure)

Forcibly synchronise the database now

Forcibly synchronise the database now (Raise error on XMLRPC failure)

This call tests if a location is valid

This call tests if a location is valid (Raise error on XMLRPC failure)

Link to this section Functions

Link to this function

add_tags(xen_session, pool_ref, value)

View Source

Add the given value to the tags field of the given pool. If the value is already in that Set, then do nothing.

Link to this function

add_tags!(xen_session, pool_ref, value)

View Source

Add the given value to the tags field of the given pool. If the value is already in that Set, then do nothing. (Raise error on XMLRPC failure)

Link to this function

add_to_guest_agent_config(xen_session, pool_ref, key, value)

View Source

Add a key-value pair to the pool-wide guest agent configuration

Link to this function

add_to_guest_agent_config!(xen_session, pool_ref, key, value)

View Source

Add a key-value pair to the pool-wide guest agent configuration (Raise error on XMLRPC failure)

Link to this function

add_to_gui_config(xen_session, pool_ref, key, value)

View Source

Add the given key-value pair to the gui_config field of the given pool.

Link to this function

add_to_gui_config!(xen_session, pool_ref, key, value)

View Source

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

Link to this function

add_to_health_check_config(xen_session, pool_ref, key, value)

View Source

Add the given key-value pair to the health_check_config field of the given pool.

Link to this function

add_to_health_check_config!(xen_session, pool_ref, key, value)

View Source

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

Link to this function

add_to_other_config(xen_session, pool_ref, key, value)

View Source

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

Link to this function

add_to_other_config!(xen_session, pool_ref, key, value)

View Source

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

Link to this function

apply_edition(xen_session, pool_ref, edition)

View Source

Apply an edition to all hosts in the pool

Link to this function

apply_edition!(xen_session, pool_ref, edition)

View Source

Apply an edition to all hosts in the pool (Raise error on XMLRPC failure)

Link to this function

certificate_install(xen_session, name, cert)

View Source

Install an SSL certificate pool-wide.

Link to this function

certificate_install!(xen_session, name, cert)

View Source

Install an SSL certificate pool-wide. (Raise error on XMLRPC failure)

Link to this function

certificate_list(xen_session)

View Source

List all installed SSL certificates.

Link to this function

certificate_list!(xen_session)

View Source

List all installed SSL certificates. (Raise error on XMLRPC failure)

Link to this function

certificate_sync(xen_session)

View Source

Sync SSL certificates from master to slaves.

Link to this function

certificate_sync!(xen_session)

View Source

Sync SSL certificates from master to slaves. (Raise error on XMLRPC failure)

Link to this function

certificate_uninstall(xen_session, name)

View Source

Remove an SSL certificate.

Link to this function

certificate_uninstall!(xen_session, name)

View Source

Remove an SSL certificate. (Raise error on XMLRPC failure)

Link to this function

create_new_blob(xen_session, pool, name, mime_type, public)

View Source

Create a placeholder for a named binary blob of data that is associated with this pool

Link to this function

create_new_blob!(xen_session, pool, name, mime_type, public)

View Source

Create a placeholder for a named binary blob of data that is associated with this pool (Raise error on XMLRPC failure)

Link to this function

create_VLAN(xen_session, device, network, arg)

View Source

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.

Link to this function

create_VLAN!(xen_session, device, network, arg)

View Source

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. (Raise error on XMLRPC failure)

Link to this function

create_VLAN_from_PIF(xen_session, pif, network, arg)

View Source

Create a pool-wide VLAN by taking the PIF.

Link to this function

create_VLAN_from_PIF!(xen_session, pif, network, arg)

View Source

Create a pool-wide VLAN by taking the PIF. (Raise error on XMLRPC failure)

Link to this function

crl_install(xen_session, name, cert)

View Source

Install an SSL certificate revocation list, pool-wide.

Link to this function

crl_install!(xen_session, name, cert)

View Source

Install an SSL certificate revocation list, pool-wide. (Raise error on XMLRPC failure)

List all installed SSL certificate revocation lists.

List all installed SSL certificate revocation lists. (Raise error on XMLRPC failure)

Link to this function

crl_uninstall(xen_session, name)

View Source

Remove an SSL certificate revocation list.

Link to this function

crl_uninstall!(xen_session, name)

View Source

Remove an SSL certificate revocation list. (Raise error on XMLRPC failure)

Link to this function

deconfigure_wlb(xen_session)

View Source

Permanently deconfigures workload balancing monitoring on this pool

Link to this function

deconfigure_wlb!(xen_session)

View Source

Permanently deconfigures workload balancing monitoring on this pool (Raise error on XMLRPC failure)

Link to this function

designate_new_master(xen_session, host)

View Source

Perform an orderly handover of the role of master to the referenced host.

Link to this function

designate_new_master!(xen_session, host)

View Source

Perform an orderly handover of the role of master to the referenced host. (Raise error on XMLRPC failure)

Link to this function

detect_nonhomogeneous_external_auth(xen_session, pool)

View Source

This call asynchronously detects if the external authentication configuration in any slave is different from that in the master and raises appropriate alerts

Link to this function

detect_nonhomogeneous_external_auth!(xen_session, pool)

View Source

This call asynchronously detects if the external authentication configuration in any slave is different from that in the master and raises appropriate alerts (Raise error on XMLRPC failure)

Link to this function

disable_external_auth(xen_session, pool, config)

View Source

This call disables external authentication on all the hosts of the pool

Link to this function

disable_external_auth!(xen_session, pool, config)

View Source

This call disables external authentication on all the hosts of the pool (Raise error on XMLRPC failure)

Turn off High Availability mode

Link to this function

disable_ha!(xen_session)

View Source

Turn off High Availability mode (Raise error on XMLRPC failure)

Link to this function

disable_local_storage_caching(xen_session, pool_ref)

View Source

This call disables pool-wide local storage caching

Link to this function

disable_local_storage_caching!(xen_session, pool_ref)

View Source

This call disables pool-wide local storage caching (Raise error on XMLRPC failure)

Link to this function

disable_redo_log(xen_session)

View Source

Disable the redo log if in use, unless HA is enabled.

Link to this function

disable_redo_log!(xen_session)

View Source

Disable the redo log if in use, unless HA is enabled. (Raise error on XMLRPC failure)

Link to this function

disable_ssl_legacy(xen_session, pool_ref)

View Source

Sets ssl_legacy true on each host, pool-master last. See Host.ssl_legacy and Host.set_ssl_legacy.

Link to this function

disable_ssl_legacy!(xen_session, pool_ref)

View Source

Sets ssl_legacy true on each host, pool-master last. See Host.ssl_legacy and Host.set_ssl_legacy. (Raise error on XMLRPC failure)

Link to this function

eject(xen_session, host)

View Source

Instruct a pool master to eject a host from the pool

Link to this function

eject!(xen_session, host)

View Source

Instruct a pool master to eject a host from the pool (Raise error on XMLRPC failure)

Link to this function

emergency_reset_master(xen_session, master_address)

View Source

Instruct a slave already in a pool that the master has changed

Link to this function

emergency_reset_master!(xen_session, master_address)

View Source

Instruct a slave already in a pool that the master has changed (Raise error on XMLRPC failure)

Link to this function

emergency_transition_to_master(xen_session)

View Source

Instruct host that's currently a slave to transition to being master

Link to this function

emergency_transition_to_master!(xen_session)

View Source

Instruct host that's currently a slave to transition to being master (Raise error on XMLRPC failure)

Link to this function

enable_external_auth(xen_session, pool, config, service_name, auth_type)

View Source

This call enables external authentication on all the hosts of the pool

Link to this function

enable_external_auth!(xen_session, pool, config, service_name, auth_type)

View Source

This call enables external authentication on all the hosts of the pool (Raise error on XMLRPC failure)

Link to this function

enable_ha(xen_session, heartbeat_srs, configuration)

View Source

Turn on High Availability mode

Link to this function

enable_ha!(xen_session, heartbeat_srs, configuration)

View Source

Turn on High Availability mode (Raise error on XMLRPC failure)

Link to this function

enable_local_storage_caching(xen_session, pool_ref)

View Source

This call attempts to enable pool-wide local storage caching

Link to this function

enable_local_storage_caching!(xen_session, pool_ref)

View Source

This call attempts to enable pool-wide local storage caching (Raise error on XMLRPC failure)

Link to this function

enable_redo_log(xen_session, sr)

View Source

Enable the redo log on the given SR and start using it, unless HA is enabled.

Link to this function

enable_redo_log!(xen_session, sr)

View Source

Enable the redo log on the given SR and start using it, unless HA is enabled. (Raise error on XMLRPC failure)

Link to this function

enable_ssl_legacy(xen_session, pool_ref)

View Source

Sets ssl_legacy true on each host, pool-master last. See Host.ssl_legacy and Host.set_ssl_legacy.

Link to this function

enable_ssl_legacy!(xen_session, pool_ref)

View Source

Sets ssl_legacy true on each host, pool-master last. See Host.ssl_legacy and Host.set_ssl_legacy. (Raise error on XMLRPC failure)

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

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

Link to this function

get_all_records(xen_session)

View Source

Return a map of pool references to pool records for all pools known to the system.

Link to this function

get_all_records!(xen_session)

View Source

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

Link to this function

get_allowed_operations(xen_session, pool_ref)

View Source

Get the allowed_operations field of the given pool.

Link to this function

get_allowed_operations!(xen_session, pool_ref)

View Source

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

Link to this function

get_blobs(xen_session, pool_ref)

View Source

Get the blobs field of the given pool.

Link to this function

get_blobs!(xen_session, pool_ref)

View Source

Get the blobs field of the given pool. (Raise error on XMLRPC failure)

Link to this function

get_by_uuid(xen_session, uuid)

View Source

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

Link to this function

get_by_uuid!(xen_session, uuid)

View Source

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

Link to this function

get_cpu_info(xen_session, pool_ref)

View Source

Get the cpu_info field of the given pool.

Link to this function

get_cpu_info!(xen_session, pool_ref)

View Source

Get the cpu_info field of the given pool. (Raise error on XMLRPC failure)

Link to this function

get_crash_dump_SR(xen_session, pool_ref)

View Source

Get the crash_dump_SR field of the given pool.

Link to this function

get_crash_dump_SR!(xen_session, pool_ref)

View Source

Get the crash_dump_SR field of the given pool. (Raise error on XMLRPC failure)

Link to this function

get_current_operations(xen_session, pool_ref)

View Source

Get the current_operations field of the given pool.

Link to this function

get_current_operations!(xen_session, pool_ref)

View Source

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

Link to this function

get_default_SR(xen_session, pool_ref)

View Source

Get the default_SR field of the given pool.

Link to this function

get_default_SR!(xen_session, pool_ref)

View Source

Get the default_SR field of the given pool. (Raise error on XMLRPC failure)

Link to this function

get_guest_agent_config(xen_session, pool_ref)

View Source

Get the guest_agent_config field of the given pool.

Link to this function

get_guest_agent_config!(xen_session, pool_ref)

View Source

Get the guest_agent_config field of the given pool. (Raise error on XMLRPC failure)

Link to this function

get_gui_config(xen_session, pool_ref)

View Source

Get the gui_config field of the given pool.

Link to this function

get_gui_config!(xen_session, pool_ref)

View Source

Get the gui_config field of the given pool. (Raise error on XMLRPC failure)

Link to this function

get_ha_allow_overcommit(xen_session, pool_ref)

View Source

Get the ha_allow_overcommit field of the given pool.

Link to this function

get_ha_allow_overcommit!(xen_session, pool_ref)

View Source

Get the ha_allow_overcommit field of the given pool. (Raise error on XMLRPC failure)

Link to this function

get_ha_cluster_stack(xen_session, pool_ref)

View Source

Get the ha_cluster_stack field of the given pool.

Link to this function

get_ha_cluster_stack!(xen_session, pool_ref)

View Source

Get the ha_cluster_stack field of the given pool. (Raise error on XMLRPC failure)

Link to this function

get_ha_configuration(xen_session, pool_ref)

View Source

Get the ha_configuration field of the given pool.

Link to this function

get_ha_configuration!(xen_session, pool_ref)

View Source

Get the ha_configuration field of the given pool. (Raise error on XMLRPC failure)

Link to this function

get_ha_enabled(xen_session, pool_ref)

View Source

Get the ha_enabled field of the given pool.

Link to this function

get_ha_enabled!(xen_session, pool_ref)

View Source

Get the ha_enabled field of the given pool. (Raise error on XMLRPC failure)

Link to this function

get_ha_host_failures_to_tolerate(xen_session, pool_ref)

View Source

Get the ha_host_failures_to_tolerate field of the given pool.

Link to this function

get_ha_host_failures_to_tolerate!(xen_session, pool_ref)

View Source

Get the ha_host_failures_to_tolerate field of the given pool. (Raise error on XMLRPC failure)

Link to this function

get_ha_overcommitted(xen_session, pool_ref)

View Source

Get the ha_overcommitted field of the given pool.

Link to this function

get_ha_overcommitted!(xen_session, pool_ref)

View Source

Get the ha_overcommitted field of the given pool. (Raise error on XMLRPC failure)

Link to this function

get_ha_plan_exists_for(xen_session, pool_ref)

View Source

Get the ha_plan_exists_for field of the given pool.

Link to this function

get_ha_plan_exists_for!(xen_session, pool_ref)

View Source

Get the ha_plan_exists_for field of the given pool. (Raise error on XMLRPC failure)

Link to this function

get_ha_statefiles(xen_session, pool_ref)

View Source

Get the ha_statefiles field of the given pool.

Link to this function

get_ha_statefiles!(xen_session, pool_ref)

View Source

Get the ha_statefiles field of the given pool. (Raise error on XMLRPC failure)

Link to this function

get_health_check_config(xen_session, pool_ref)

View Source

Get the health_check_config field of the given pool.

Link to this function

get_health_check_config!(xen_session, pool_ref)

View Source

Get the health_check_config field of the given pool. (Raise error on XMLRPC failure)

Link to this function

get_igmp_snooping_enabled(xen_session, pool_ref)

View Source

Get the igmp_snooping_enabled field of the given pool.

Link to this function

get_igmp_snooping_enabled!(xen_session, pool_ref)

View Source

Get the igmp_snooping_enabled field of the given pool. (Raise error on XMLRPC failure)

Link to this function

get_license_state(xen_session, pool_ref)

View Source

This call returns the license state for the pool

Link to this function

get_license_state!(xen_session, pool_ref)

View Source

This call returns the license state for the pool (Raise error on XMLRPC failure)

Link to this function

get_live_patching_disabled(xen_session, pool_ref)

View Source

Get the live_patching_disabled field of the given pool.

Link to this function

get_live_patching_disabled!(xen_session, pool_ref)

View Source

Get the live_patching_disabled field of the given pool. (Raise error on XMLRPC failure)

Link to this function

get_master(xen_session, pool_ref)

View Source

Get the master field of the given pool.

Link to this function

get_master!(xen_session, pool_ref)

View Source

Get the master field of the given pool. (Raise error on XMLRPC failure)

Link to this function

get_metadata_VDIs(xen_session, pool_ref)

View Source

Get the metadata_VDIs field of the given pool.

Link to this function

get_metadata_VDIs!(xen_session, pool_ref)

View Source

Get the metadata_VDIs field of the given pool. (Raise error on XMLRPC failure)

Link to this function

get_name_description(xen_session, pool_ref)

View Source

Get the name_description field of the given pool.

Link to this function

get_name_description!(xen_session, pool_ref)

View Source

Get the name_description field of the given pool. (Raise error on XMLRPC failure)

Link to this function

get_name_label(xen_session, pool_ref)

View Source

Get the name_label field of the given pool.

Link to this function

get_name_label!(xen_session, pool_ref)

View Source

Get the name_label field of the given pool. (Raise error on XMLRPC failure)

Link to this function

get_other_config(xen_session, pool_ref)

View Source

Get the other_config field of the given pool.

Link to this function

get_other_config!(xen_session, pool_ref)

View Source

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

Link to this function

get_policy_no_vendor_device(xen_session, pool_ref)

View Source

Get the policy_no_vendor_device field of the given pool.

Link to this function

get_policy_no_vendor_device!(xen_session, pool_ref)

View Source

Get the policy_no_vendor_device field of the given pool. (Raise error on XMLRPC failure)

Link to this function

get_record(xen_session, pool_ref)

View Source

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

Link to this function

get_record!(xen_session, pool_ref)

View Source

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

Link to this function

get_redo_log_enabled(xen_session, pool_ref)

View Source

Get the redo_log_enabled field of the given pool.

Link to this function

get_redo_log_enabled!(xen_session, pool_ref)

View Source

Get the redo_log_enabled field of the given pool. (Raise error on XMLRPC failure)

Link to this function

get_redo_log_vdi(xen_session, pool_ref)

View Source

Get the redo_log_vdi field of the given pool.

Link to this function

get_redo_log_vdi!(xen_session, pool_ref)

View Source

Get the redo_log_vdi field of the given pool. (Raise error on XMLRPC failure)

Link to this function

get_restrictions(xen_session, pool_ref)

View Source

Get the restrictions field of the given pool.

Link to this function

get_restrictions!(xen_session, pool_ref)

View Source

Get the restrictions field of the given pool. (Raise error on XMLRPC failure)

Link to this function

get_suspend_image_SR(xen_session, pool_ref)

View Source

Get the suspend_image_SR field of the given pool.

Link to this function

get_suspend_image_SR!(xen_session, pool_ref)

View Source

Get the suspend_image_SR field of the given pool. (Raise error on XMLRPC failure)

Link to this function

get_tags(xen_session, pool_ref)

View Source

Get the tags field of the given pool.

Link to this function

get_tags!(xen_session, pool_ref)

View Source

Get the tags field of the given pool. (Raise error on XMLRPC failure)

Link to this function

get_uefi_certificates(xen_session, pool_ref)

View Source

Get the uefi_certificates field of the given pool.

Link to this function

get_uefi_certificates!(xen_session, pool_ref)

View Source

Get the uefi_certificates field of the given pool. (Raise error on XMLRPC failure)

Link to this function

get_uuid(xen_session, pool_ref)

View Source

Get the uuid field of the given pool.

Link to this function

get_uuid!(xen_session, pool_ref)

View Source

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

Link to this function

get_vswitch_controller(xen_session, pool_ref)

View Source

Get the vswitch_controller field of the given pool.

Link to this function

get_vswitch_controller!(xen_session, pool_ref)

View Source

Get the vswitch_controller field of the given pool. (Raise error on XMLRPC failure)

Link to this function

get_wlb_enabled(xen_session, pool_ref)

View Source

Get the wlb_enabled field of the given pool.

Link to this function

get_wlb_enabled!(xen_session, pool_ref)

View Source

Get the wlb_enabled field of the given pool. (Raise error on XMLRPC failure)

Link to this function

get_wlb_url(xen_session, pool_ref)

View Source

Get the wlb_url field of the given pool.

Link to this function

get_wlb_url!(xen_session, pool_ref)

View Source

Get the wlb_url field of the given pool. (Raise error on XMLRPC failure)

Link to this function

get_wlb_username(xen_session, pool_ref)

View Source

Get the wlb_username field of the given pool.

Link to this function

get_wlb_username!(xen_session, pool_ref)

View Source

Get the wlb_username field of the given pool. (Raise error on XMLRPC failure)

Link to this function

get_wlb_verify_cert(xen_session, pool_ref)

View Source

Get the wlb_verify_cert field of the given pool.

Link to this function

get_wlb_verify_cert!(xen_session, pool_ref)

View Source

Get the wlb_verify_cert field of the given pool. (Raise error on XMLRPC failure)

Link to this function

ha_compute_hypothetical_max_host_failures_to_tolerate(xen_session, configuration)

View Source

Returns the maximum number of host failures we could tolerate before we would be unable to restart the provided VMs

Link to this function

ha_compute_hypothetical_max_host_failures_to_tolerate!(xen_session, configuration)

View Source

Returns the maximum number of host failures we could tolerate before we would be unable to restart the provided VMs (Raise error on XMLRPC failure)

Link to this function

ha_compute_max_host_failures_to_tolerate(xen_session)

View Source

Returns the maximum number of host failures we could tolerate before we would be unable to restart configured VMs

Link to this function

ha_compute_max_host_failures_to_tolerate!(xen_session)

View Source

Returns the maximum number of host failures we could tolerate before we would be unable to restart configured VMs (Raise error on XMLRPC failure)

Link to this function

ha_compute_vm_failover_plan(xen_session, failed_hosts, failed_vms)

View Source

Return a VM failover plan assuming a given subset of hosts fail

Link to this function

ha_compute_vm_failover_plan!(xen_session, failed_hosts, failed_vms)

View Source

Return a VM failover plan assuming a given subset of hosts fail (Raise error on XMLRPC failure)

Link to this function

ha_failover_plan_exists(xen_session, n)

View Source

Returns true if a VM failover plan exists for up to 'n' host failures

Link to this function

ha_failover_plan_exists!(xen_session, n)

View Source

Returns true if a VM failover plan exists for up to 'n' host failures (Raise error on XMLRPC failure)

Link to this function

ha_prevent_restarts_for(xen_session, seconds)

View Source

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

Link to this function

ha_prevent_restarts_for!(xen_session, seconds)

View Source

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 (Raise error on XMLRPC failure)

Link to this function

has_extension(xen_session, pool_ref, name)

View Source

Return true if the extension is available on the pool

Link to this function

has_extension!(xen_session, pool_ref, name)

View Source

Return true if the extension is available on the pool (Raise error on XMLRPC failure)

Link to this function

initialize_wlb(xen_session, wlb_url, wlb_username, wlb_password, xenserver_username, xenserver_password)

View Source

Initializes workload balancing monitoring on this pool with the specified wlb server

Link to this function

initialize_wlb!(xen_session, wlb_url, wlb_username, wlb_password, xenserver_username, xenserver_password)

View Source

Initializes workload balancing monitoring on this pool with the specified wlb server (Raise error on XMLRPC failure)

Link to this function

join(xen_session, master_address, master_username, master_password)

View Source

Instruct host to join a new pool

Link to this function

join!(xen_session, master_address, master_username, master_password)

View Source

Instruct host to join a new pool (Raise error on XMLRPC failure)

Link to this function

join_force(xen_session, master_address, master_username, master_password)

View Source

Instruct host to join a new pool

Link to this function

join_force!(xen_session, master_address, master_username, master_password)

View Source

Instruct host to join a new pool (Raise error on XMLRPC failure)

Link to this function

management_reconfigure(xen_session, network)

View Source

Reconfigure the management network interface for all Hosts in the Pool

Link to this function

management_reconfigure!(xen_session, network)

View Source

Reconfigure the management network interface for all Hosts in the Pool (Raise error on XMLRPC failure)

Link to this function

recover_slaves(xen_session)

View Source

Instruct a pool master, M, to try and contact its slaves and, if slaves are in emergency mode, reset their master address to M.

Link to this function

recover_slaves!(xen_session)

View Source

Instruct a pool master, M, to try and contact its slaves and, if slaves are in emergency mode, reset their master address to M. (Raise error on XMLRPC failure)

Link to this function

remove_from_guest_agent_config(xen_session, pool_ref, key)

View Source

Remove a key-value pair from the pool-wide guest agent configuration

Link to this function

remove_from_guest_agent_config!(xen_session, pool_ref, key)

View Source

Remove a key-value pair from the pool-wide guest agent configuration (Raise error on XMLRPC failure)

Link to this function

remove_from_gui_config(xen_session, pool_ref, key)

View Source

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

Link to this function

remove_from_gui_config!(xen_session, pool_ref, key)

View Source

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

Link to this function

remove_from_health_check_config(xen_session, pool_ref, key)

View Source

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

Link to this function

remove_from_health_check_config!(xen_session, pool_ref, key)

View Source

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

Link to this function

remove_from_other_config(xen_session, pool_ref, key)

View Source

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

Link to this function

remove_from_other_config!(xen_session, pool_ref, key)

View Source

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

Link to this function

remove_tags(xen_session, pool_ref, value)

View Source

Remove the given value from the tags field of the given pool. If the value is not in that Set, then do nothing.

Link to this function

remove_tags!(xen_session, pool_ref, value)

View Source

Remove the given value from the tags field of the given pool. If the value is not in that Set, then do nothing. (Raise error on XMLRPC failure)

Link to this function

retrieve_wlb_configuration(xen_session)

View Source

Retrieves the pool optimization criteria from the workload balancing server

Link to this function

retrieve_wlb_configuration!(xen_session)

View Source

Retrieves the pool optimization criteria from the workload balancing server (Raise error on XMLRPC failure)

Link to this function

retrieve_wlb_recommendations(xen_session)

View Source

Retrieves vm migrate recommendations for the pool from the workload balancing server

Link to this function

retrieve_wlb_recommendations!(xen_session)

View Source

Retrieves vm migrate recommendations for the pool from the workload balancing server (Raise error on XMLRPC failure)

Link to this function

send_test_post(xen_session, host, port, body)

View Source

Send the given body to the given host and port, using HTTPS, and print the response. This is used for debugging the SSL layer.

Link to this function

send_test_post!(xen_session, host, port, body)

View Source

Send the given body to the given host and port, using HTTPS, and print the response. This is used for debugging the SSL layer. (Raise error on XMLRPC failure)

Link to this function

send_wlb_configuration(xen_session, config)

View Source

Sets the pool optimization criteria for the workload balancing server

Link to this function

send_wlb_configuration!(xen_session, config)

View Source

Sets the pool optimization criteria for the workload balancing server (Raise error on XMLRPC failure)

Link to this function

set_crash_dump_SR(xen_session, pool_ref, value)

View Source

Set the crash_dump_SR field of the given pool.

Link to this function

set_crash_dump_SR!(xen_session, pool_ref, value)

View Source

Set the crash_dump_SR field of the given pool. (Raise error on XMLRPC failure)

Link to this function

set_default_SR(xen_session, pool_ref, value)

View Source

Set the default_SR field of the given pool.

Link to this function

set_default_SR!(xen_session, pool_ref, value)

View Source

Set the default_SR field of the given pool. (Raise error on XMLRPC failure)

Link to this function

set_gui_config(xen_session, pool_ref, value)

View Source

Set the gui_config field of the given pool.

Link to this function

set_gui_config!(xen_session, pool_ref, value)

View Source

Set the gui_config field of the given pool. (Raise error on XMLRPC failure)

Link to this function

set_ha_allow_overcommit(xen_session, pool_ref, value)

View Source

Set the ha_allow_overcommit field of the given pool.

Link to this function

set_ha_allow_overcommit!(xen_session, pool_ref, value)

View Source

Set the ha_allow_overcommit field of the given pool. (Raise error on XMLRPC failure)

Link to this function

set_ha_host_failures_to_tolerate(xen_session, pool_ref, value)

View Source

Set the maximum number of host failures to consider in the HA VM restart planner

Link to this function

set_ha_host_failures_to_tolerate!(xen_session, pool_ref, value)

View Source

Set the maximum number of host failures to consider in the HA VM restart planner (Raise error on XMLRPC failure)

Link to this function

set_health_check_config(xen_session, pool_ref, value)

View Source

Set the health_check_config field of the given pool.

Link to this function

set_health_check_config!(xen_session, pool_ref, value)

View Source

Set the health_check_config field of the given pool. (Raise error on XMLRPC failure)

Link to this function

set_igmp_snooping_enabled(xen_session, pool_ref, value)

View Source

Enable or disable IGMP Snooping on the pool.

Link to this function

set_igmp_snooping_enabled!(xen_session, pool_ref, value)

View Source

Enable or disable IGMP Snooping on the pool. (Raise error on XMLRPC failure)

Link to this function

set_live_patching_disabled(xen_session, pool_ref, value)

View Source

Set the live_patching_disabled field of the given pool.

Link to this function

set_live_patching_disabled!(xen_session, pool_ref, value)

View Source

Set the live_patching_disabled field of the given pool. (Raise error on XMLRPC failure)

Link to this function

set_name_description(xen_session, pool_ref, value)

View Source

Set the name_description field of the given pool.

Link to this function

set_name_description!(xen_session, pool_ref, value)

View Source

Set the name_description field of the given pool. (Raise error on XMLRPC failure)

Link to this function

set_name_label(xen_session, pool_ref, value)

View Source

Set the name_label field of the given pool.

Link to this function

set_name_label!(xen_session, pool_ref, value)

View Source

Set the name_label field of the given pool. (Raise error on XMLRPC failure)

Link to this function

set_other_config(xen_session, pool_ref, value)

View Source

Set the other_config field of the given pool.

Link to this function

set_other_config!(xen_session, pool_ref, value)

View Source

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

Link to this function

set_policy_no_vendor_device(xen_session, pool_ref, value)

View Source

Set the policy_no_vendor_device field of the given pool.

Link to this function

set_policy_no_vendor_device!(xen_session, pool_ref, value)

View Source

Set the policy_no_vendor_device field of the given pool. (Raise error on XMLRPC failure)

Link to this function

set_suspend_image_SR(xen_session, pool_ref, value)

View Source

Set the suspend_image_SR field of the given pool.

Link to this function

set_suspend_image_SR!(xen_session, pool_ref, value)

View Source

Set the suspend_image_SR field of the given pool. (Raise error on XMLRPC failure)

Link to this function

set_tags(xen_session, pool_ref, value)

View Source

Set the tags field of the given pool.

Link to this function

set_tags!(xen_session, pool_ref, value)

View Source

Set the tags field of the given pool. (Raise error on XMLRPC failure)

Link to this function

set_uefi_certificates(xen_session, pool_ref, value)

View Source

Set the uefi_certificates field of the given pool.

Link to this function

set_uefi_certificates!(xen_session, pool_ref, value)

View Source

Set the uefi_certificates field of the given pool. (Raise error on XMLRPC failure)

Link to this function

set_vswitch_controller(xen_session, address)

View Source

Set the IP address of the vswitch controller.

Link to this function

set_vswitch_controller!(xen_session, address)

View Source

Set the IP address of the vswitch controller. (Raise error on XMLRPC failure)

Link to this function

set_wlb_enabled(xen_session, pool_ref, value)

View Source

Set the wlb_enabled field of the given pool.

Link to this function

set_wlb_enabled!(xen_session, pool_ref, value)

View Source

Set the wlb_enabled field of the given pool. (Raise error on XMLRPC failure)

Link to this function

set_wlb_verify_cert(xen_session, pool_ref, value)

View Source

Set the wlb_verify_cert field of the given pool.

Link to this function

set_wlb_verify_cert!(xen_session, pool_ref, value)

View Source

Set the wlb_verify_cert field of the given pool. (Raise error on XMLRPC failure)

Link to this function

sync_database(xen_session)

View Source

Forcibly synchronise the database now

Link to this function

sync_database!(xen_session)

View Source

Forcibly synchronise the database now (Raise error on XMLRPC failure)

Link to this function

test_archive_target(xen_session, pool_ref, config)

View Source

This call tests if a location is valid

Link to this function

test_archive_target!(xen_session, pool_ref, config)

View Source

This call tests if a location is valid (Raise error on XMLRPC failure)