Class: pool
Pool-wide information
| Published in: | XenServer 4.0 (rio) | Pool-wide information |
Enums
pool_allowed_operations
| Values: | ha_enable | Indicates this pool is in the process of enabling HA |
| ha_disable | Indicates this pool is in the process of disabling HA | |
| cluster_create | Indicates this pool is in the process of creating a cluster | |
| designate_new_master | Indicates this pool is in the process of changing master | |
| configure_repositories | Indicates this pool is in the process of configuring repositories | |
| sync_updates | Indicates this pool is in the process of syncing updates | |
| sync_bundle | Indicates this pool is in the process of syncing bundle | |
| get_updates | Indicates this pool is in the process of getting updates | |
| apply_updates | Indicates this pool is in the process of applying updates | |
| tls_verification_enable | Indicates this pool is in the process of enabling TLS verification | |
| cert_refresh | A certificate refresh and distribution is in progress | |
| exchange_certificates_on_join | Indicates this pool is exchanging internal certificates with a new joiner | |
| exchange_ca_certificates_on_join | Indicates this pool is exchanging ca certificates with a new joiner | |
| copy_primary_host_certs | Indicates the primary host is sending its certificates to another host | |
| eject | Ejection of a host from the pool is under way |
telemetry_frequency
| Values: | daily | Run telemetry task daily |
| weekly | Run telemetry task weekly | |
| monthly | Run telemetry task monthly |
update_sync_frequency
| Values: | daily | The update synchronizations happen every day |
| weekly | The update synchronizations happen every week on the chosen day |
pool_guest_secureboot_readiness
| Values: | ready | Pool is ready for SecureBoot, all auth files are present |
| ready_no_dbx | Pool is ready for SecureBoot, but there is no dbx auth file | |
| not_ready | Pool is not ready for SecureBoot, mandatory auth files are missing |
Fields
enum pool_allowed_operations 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. |
(string → blob ref) map
blobs
[RO/runtime]
Binary blobs associated with this pool
| Default value: | {} | |
| Published in: | XenServer 5.0 (orlando) | Binary blobs associated with this pool |
bool
client_certificate_auth_enabled
[RO/runtime]
True if authentication by TLS client certificates is enabled
| Default value: | false | |
| Published in: | XAPI 1.318.0 (1.318.0) | |
string
client_certificate_auth_name
[RO/runtime]
The name (CN/SAN) that an incoming client certificate must have to allow authentication
| Default value: | "" | |
| Published in: | XAPI 1.318.0 (1.318.0) | |
bool
coordinator_bias
[RW]
true if bias against pool master when scheduling vms is enabled, false otherwise
| Default value: | true | |
| Prototyped in: | XAPI 22.37.0 (22.37.0) | |
| Published in: | XenServer 4.0 (rio) | true if bias against pool master when scheduling vms is enabled, false otherwise |
(string → string) map
cpu_info
[RO/runtime]
Details about the physical CPUs on the pool
| Default value: | {} | |
| Published in: | XenServer 7.0 (dundee) | Details about the physical CPUs on the pool |
SR ref
crash_dump_SR
[RW]
The SR in which VDIs for crash dumps are created
| Published in: | XenServer 4.0 (rio) | The SR in which VDIs for crash dumps are created |
(string → enum pool_allowed_operations) 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. |
Prototype
string
custom_uefi_certificates
[RO/constructor]
Custom UEFI certificates allowing Secure Boot
| Default value: | "" | |
| Prototyped in: | XAPI 24.0.0 (24.0.0) | |
SR ref
default_SR
[RW]
Default SR for VDIs
| Published in: | XenServer 4.0 (rio) | Default SR for VDIs |
Prototype
int
ext_auth_max_threads
[RO/constructor]
Maximum number of threads to use for external (AD) authentication
| Default value: | 1 | |
| Prototyped in: | XAPI 23.27.0 (23.27.0) | |
(string → string) map
guest_agent_config
[RO/runtime]
Pool-wide guest agent configuration information
| Default value: | {} | |
| Published in: | XenServer 7.0 (dundee) | Pool-wide guest agent configuration information |
(string → string) map
gui_config
[RW]
gui-specific configuration for pool
| Default value: | {} | |
| Published in: | XenServer 5.0 (orlando) | gui-specific configuration for pool |
bool
ha_allow_overcommit
[RW]
If set to false then operations which would cause the Pool to become overcommitted will be blocked.
| Default value: | false | |
| Published in: | XenServer 5.0 (orlando) | If set to false then operations which would cause the Pool to become overcommitted will be blocked. |
string
ha_cluster_stack
[RO/runtime]
The HA cluster stack that is currently in use. Only valid when HA is enabled.
| Default value: | "" | |
| Published in: | XenServer 7.0 (dundee) | The HA cluster stack that is currently in use. Only valid when HA is enabled. |
(string → string) map
ha_configuration
[RO/runtime]
The current HA configuration
| Default value: | {} | |
| Published in: | XenServer 5.0 (orlando) | The current HA configuration |
bool
ha_enabled
[RO/runtime]
true if HA is enabled on the pool, false otherwise
| Default value: | false | |
| Published in: | XenServer 5.0 (orlando) | true if HA is enabled on the pool, false otherwise |
int
ha_host_failures_to_tolerate
[RO/runtime]
Number of host failures to tolerate before the Pool is declared to be overcommitted
| Default value: | 0 | |
| Published in: | XenServer 5.0 (orlando) | Number of host failures to tolerate before the Pool is declared to be overcommitted |
bool
ha_overcommitted
[RO/runtime]
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
| Default value: | false | |
| Published in: | XenServer 5.0 (orlando) | 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 |
int
ha_plan_exists_for
[RO/runtime]
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.
| Default value: | 0 | |
| Published in: | XenServer 5.0 (orlando) | 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. |
string set
ha_statefiles
[RO/runtime]
HA statefile VDIs in use
| Default value: | {} | |
| Published in: | XenServer 5.0 (orlando) | HA statefile VDIs in use |
(string → string) map
health_check_config
[RW]
Configuration for the automatic health check feature
| Default value: | {} | |
| Published in: | XenServer 7.0 (dundee) | Configuration for the automatic health check feature |
bool
igmp_snooping_enabled
[RO/runtime]
true if IGMP snooping is enabled in the pool, false otherwise.
| Default value: | false | |
| Published in: | XenServer 7.3 (inverness) | true if IGMP snooping is enabled in the pool, false otherwise. |
bool
is_psr_pending
[RW]
True if either a PSR is running or we are waiting for a PSR to be re-run
| Default value: | false | |
| Published in: | Citrix Hypervisor 8.2 Hotfix 2 (stockholm_psr) | True if either a PSR is running or we are waiting for a PSR to be re-run |
Prototype
datetime
last_update_sync
[RO/runtime]
time of the last update sychronization
| Default value: | 19700101T00:00:00Z | |
| Prototyped in: | XAPI 23.18.0 (23.18.0) | |
bool
live_patching_disabled
[RW]
The pool-wide flag to show if the live patching feauture is disabled or not.
| Default value: | false | |
| Published in: | XenServer 7.1 (ely) | The pool-wide flag to show if the live patching feauture is disabled or not. |
Prototype
int
local_auth_max_threads
[RO/constructor]
Maximum number of threads to use for PAM authentication
| Default value: | 8 | |
| Prototyped in: | XAPI 23.27.0 (23.27.0) | |
host ref
master
[RO/runtime]
The host that is pool master
| Published in: | XenServer 4.0 (rio) | The host that is pool master |
VDI ref set
metadata_VDIs
[RO/runtime]
The set of currently known metadata VDIs for this pool
| Published in: | XenServer 6.0 (boston) | The set of currently known metadata VDIs for this pool |
Prototype
bool
migration_compression
[RW]
Default behaviour during migration, True if stream compression should be used
| Default value: | false | |
| Prototyped in: | XAPI 22.33.0 (22.33.0) | |
string
name_description
[RW]
Description
| Published in: | XenServer 4.0 (rio) | Description |
string
name_label
[RW]
Short name
| Published in: | XenServer 4.0 (rio) | Short name |
(string → string) map
other_config
[RW]
additional configuration
| Published in: | XenServer 4.0 (rio) | additional configuration |
Deprecated
bool
policy_no_vendor_device
[RW]
This field was consulted when VM.create did not specify a value for 'has_vendor_device'; VM.create now uses a simple default and no longer consults this value.
| Default value: | false | |
| Published in: | XenServer 7.0 (dundee) | |
| Deprecated in: | XAPI 24.14.0 (24.14.0) | No longer considered by VM.create |
Prototype
(string → string) map
recommendations
[RO/runtime]
The recommended pool properties for clients to respect for optimal performance. e.g. max-vm-group=5
| Default value: | {} | |
| Prototyped in: | XAPI 24.19.1 (24.19.1) | |
bool
redo_log_enabled
[RO/runtime]
true a redo-log is to be used other than when HA is enabled, false otherwise
| Default value: | false | |
| Published in: | XenServer 5.6 (midnight-ride) | true a redo-log is to be used other than when HA is enabled, false otherwise |
VDI ref
redo_log_vdi
[RO/runtime]
indicates the VDI to use for the redo-log other than when HA is enabled
| Default value: | OpaqueRef:NULL | |
| Published in: | XenServer 5.6 (midnight-ride) | indicates the VDI to use for the redo-log other than when HA is enabled |
Repository ref set
repositories
[RO/runtime]
The set of currently enabled repositories
| Default value: | {} | |
| Published in: | XAPI 1.301.0 (1.301.0) | The set of currently enabled repositories |
secret ref
repository_proxy_password
[RO/runtime]
Password for the authentication of the proxy used in syncing with the enabled repositories
| Default value: | OpaqueRef:NULL | |
| Published in: | XAPI 21.3.0 (21.3.0) | |
| Changed in: | XAPI 23.9.0 (23.9.0) | Changed internal_only to false |
string
repository_proxy_url
[RO/runtime]
Url of the proxy used in syncing with the enabled repositories
| Default value: | "" | |
| Published in: | XAPI 21.3.0 (21.3.0) | Url of the proxy used in syncing with the enabled repositories |
string
repository_proxy_username
[RO/runtime]
Username for the authentication of the proxy used in syncing with the enabled repositories
| Default value: | "" | |
| Published in: | XAPI 21.3.0 (21.3.0) | Username for the authentication of the proxy used in syncing with the enabled repositories |
(string → string) map
restrictions
[RO/runtime]
Pool-wide restrictions currently in effect
| Default value: | {} | |
| Published in: | XenServer 5.6 (midnight-ride) | Pool-wide restrictions currently in effect |
SR ref
suspend_image_SR
[RW]
The SR in which VDIs for suspend images are created
| Published in: | XenServer 4.0 (rio) | The SR in which VDIs for suspend images are created |
string set
tags
[RW]
user-specified tags for categorization purposes
| Default value: | {} | |
| Published in: | XenServer 5.0 (orlando) | user-specified tags for categorization purposes |
Prototype
enum telemetry_frequency
telemetry_frequency
[RO/runtime]
How often the telemetry collection will be carried out
| Default value: | weekly | |
| Prototyped in: | XAPI 23.9.0 (23.9.0) | |
Prototype
datetime
telemetry_next_collection
[RO/runtime]
The earliest timestamp (in UTC) when the next round of telemetry collection can be carried out
| Default value: | 19700101T00:00:00Z | |
| Prototyped in: | XAPI 23.9.0 (23.9.0) | |
Prototype
secret ref
telemetry_uuid
[RO/runtime]
The UUID of the pool for identification of telemetry data
| Default value: | OpaqueRef:NULL | |
| Prototyped in: | XAPI 23.9.0 (23.9.0) | |
bool
tls_verification_enabled
[RO/runtime]
True iff TLS certificate verification is enabled
| Default value: | false | |
| Published in: | XAPI 1.290.0 (1.290.0) | |
string
uefi_certificates
[RO/constructor]
The UEFI certificates allowing Secure Boot
| Default value: | "" | |
| Published in: | Citrix Hypervisor 8.1 (quebec) | The UEFI certificates allowing Secure Boot |
| Changed in: | XAPI 22.16.0 (22.16.0) | Became StaticRO to be editable through new method |
Prototype
int
update_sync_day
[RO/runtime]
The day of the week the update synchronizations will be scheduled, based on pool's local timezone. Ignored when update_sync_frequency is daily
| Default value: | 0 | |
| Prototyped in: | XAPI 23.18.0 (23.18.0) | |
Prototype
bool
update_sync_enabled
[RO/runtime]
Whether periodic update synchronization is enabled or not
| Default value: | false | |
| Prototyped in: | XAPI 23.18.0 (23.18.0) | |
Prototype
enum update_sync_frequency
update_sync_frequency
[RO/runtime]
The frequency at which updates are synchronized from a remote CDN: daily or weekly.
| Default value: | weekly | |
| Prototyped in: | XAPI 23.18.0 (23.18.0) | |
string
uuid
[RO/runtime]
Unique identifier/object reference
| Published in: | XenServer 4.0 (rio) | Unique identifier/object reference |
Deprecated
string
vswitch_controller
[RO/runtime]
address of the vswitch controller
| Default value: | "" | |
| Published in: | XenServer 5.6 (midnight-ride) | the IP address of the vswitch controller. |
| Deprecated in: | XenServer 7.2 (falcon) | Deprecated: set the IP address of the vswitch controller in SDN_controller instead. |
bool
wlb_enabled
[RW]
true if workload balancing is enabled on the pool, false otherwise
| Default value: | false | |
| Published in: | XenServer 5.5 (george) | true if workload balancing is enabled on the pool, false otherwise |
string
wlb_url
[RO/runtime]
Url for the configured workload balancing host
| Default value: | "" | |
| Published in: | XenServer 5.5 (george) | Url for the configured workload balancing host |
string
wlb_username
[RO/runtime]
Username for accessing the workload balancing host
| Default value: | "" | |
| Published in: | XenServer 5.5 (george) | Username for accessing the workload balancing host |
Deprecated
bool
wlb_verify_cert
[RW]
true if communication with the WLB server should enforce TLS certificate verification.
| Default value: | false | |
| Published in: | XenServer 5.5 (george) | |
| Deprecated in: | XAPI 1.290.0 (1.290.0) | Deprecated: to enable TLS verification use Pool.enable_tls_verification instead |
Messages
void
add_repository
(session ref, pool ref, Repository ref)
Add a repository to the enabled set
| Parameters: | session ref session_id | Reference to a valid session |
| pool ref self | The pool | |
| Repository ref value | The repository to be added to the enabled set | |
| Minimum role: | client-cert | |
| Published in: | XAPI 1.301.0 (1.301.0) | Add a repository to the enabled set |
void
add_tags
(session ref, pool ref, string)
Add the given value to the tags field of the given pool. If the value is already in that Set, then do nothing.
| Parameters: | session ref session_id | Reference to a valid session |
| pool ref self | reference to the object | |
| string value | New value to add | |
| Minimum role: | vm-operator | |
| Published in: | XenServer 5.0 (orlando) | user-specified tags for categorization purposes |
void
add_to_guest_agent_config
(session ref, pool ref, string, string)
Add a key-value pair to the pool-wide guest agent configuration
| Parameters: | session ref session_id | Reference to a valid session |
| pool ref self | The pool | |
| string key | The key to add | |
| string value | The value to add | |
| Minimum role: | pool-admin | |
| Published in: | XenServer 7.0 (dundee) | Add a key-value pair to the pool-wide guest agent configuration |
void
add_to_gui_config
(session ref, pool ref, string, string)
Add the given key-value pair to the gui_config field of the given pool.
| Parameters: | session ref session_id | Reference to a valid session |
| pool ref self | reference to the object | |
| string key | Key to add | |
| string value | Value to add | |
| Minimum role: | vm-operator | |
| Published in: | XenServer 5.0 (orlando) | gui-specific configuration for pool |
void
add_to_health_check_config
(session ref, pool ref, string, string)
Add the given key-value pair to the health_check_config field of the given pool.
| Parameters: | session ref session_id | Reference to a valid session |
| pool ref self | reference to the object | |
| string key | Key to add | |
| string value | Value to add | |
| Minimum role: | pool-operator | |
| Published in: | XenServer 7.0 (dundee) | Configuration for the automatic health check feature |
void
add_to_other_config
(session ref, pool ref, string, string)
Add the given key-value pair to the other_config field of the given pool.
| Parameters: | session ref session_id | Reference to a valid session |
| pool ref self | reference to the object | |
| string key | Key to add | |
| string value | Value to add | |
| Minimum role: | pool-operator | |
| Published in: | XenServer 4.0 (rio) | additional configuration |
void
apply_edition
(session ref, pool ref, string)
Apply an edition to all hosts in the pool
| Parameters: | session ref session_id | Reference to a valid session |
| pool ref self | Reference to the pool | |
| string edition | The requested edition | |
| Minimum role: | pool-operator | |
| Published in: | XenServer 6.2 (clearwater) | Apply an edition to all hosts in the pool |
Deprecated
void
certificate_install
(session ref, string, string)
Install a TLS CA certificate, pool-wide.
| Parameters: | session ref session_id | Reference to a valid session |
| string name | A name to give the certificate | |
| string cert | The certificate in PEM format | |
| Minimum role: | pool-operator | |
| Published in: | XenServer 5.5 (george) | Install TLS CA certificate |
| Deprecated in: | XAPI 1.290.0 (1.290.0) | Use Pool.install_ca_certificate instead |
Deprecated
string set
certificate_list
(session ref)
List the names of all installed TLS CA certificates.
| Parameters: | session ref session_id | Reference to a valid session |
| Minimum role: | pool-operator | |
| Result: | All installed certificates | |
| Published in: | XenServer 5.5 (george) | List installed TLS CA certificate |
| Deprecated in: | XAPI 1.290.0 (1.290.0) | Use openssl to inspect certificate |
void
certificate_sync
(session ref)
Copy the TLS CA certificates and CRLs of the master to all slaves.
| Parameters: | session ref session_id | Reference to a valid session |
| Minimum role: | pool-operator | |
| Published in: | XenServer 5.5 (george) | Copy the TLS CA certificates and CRLs of the master to all slaves. |
Deprecated
void
certificate_uninstall
(session ref, string)
Remove a pool-wide TLS CA certificate.
| Parameters: | session ref session_id | Reference to a valid session |
| string name | The certificate name | |
| Minimum role: | pool-operator | |
| Published in: | XenServer 5.5 (george) | Install TLS CA certificate |
| Deprecated in: | XAPI 1.290.0 (1.290.0) | Use Pool.uninstall_ca_certificate instead |
string set set
check_update_readiness
(session ref, pool ref, bool)
Check if the pool is ready to be updated. If not, report the reasons.
| Parameters: | session ref session_id | Reference to a valid session |
| pool ref self | The pool | |
| bool requires_reboot | Assume that the update will require host reboots | |
| Minimum role: | client-cert | |
| Result: | A set of error codes with arguments, if the pool is not ready to update. An empty list means the pool can be updated. | |
| Published in: | XAPI 1.304.0 (1.304.0) | |
void
configure_repository_proxy
(session ref, pool ref, string, string, string)
Configure proxy for RPM package repositories.
| Parameters: | session ref session_id | Reference to a valid session |
| pool ref self | The pool | |
| string url | The URL of the proxy server | |
| string username | The username used to authenticate with the proxy server | |
| string password | The password used to authenticate with the proxy server | |
| Minimum role: | client-cert | |
| Published in: | XAPI 21.3.0 (21.3.0) | Configure proxy for RPM package repositories. |
Prototype
void
configure_update_sync
(session ref, pool ref, enum update_sync_frequency, int)
Configure periodic update synchronization to sync updates from a remote CDN
| Parameters: | session ref session_id | Reference to a valid session |
| pool ref self | The pool | |
| enum update_sync_frequency update_sync_frequency | The frequency at which updates are synchronized from a remote CDN: daily or weekly. | |
| int update_sync_day | The day of the week the update synchronization will happen, based on pool's local timezone. Valid values are 0 to 6, 0 being Sunday. For 'daily' schedule, the value is ignored. | |
| Minimum role: | pool-operator | |
| Prototyped in: | XAPI 23.18.0 (23.18.0) | |
PIF ref set
create_VLAN
(session ref, string, network ref, int)
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.
| Parameters: | session ref session_id | Reference to a valid session |
| string device | physical interface on which to create the VLAN interface | |
| network ref network | network to which this interface should be connected | |
| int VLAN | VLAN tag for the new interface | |
| Minimum role: | pool-operator | |
| Result: | The references of the created PIF objects | |
| Errors: | VLAN_TAG_INVALID | You tried to create a VLAN, but the tag you gave was invalid -- it must be between 0 and 4094. The parameter echoes the VLAN tag you gave. |
| Published in: | XenServer 4.0 (rio) | 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. |
PIF ref set
create_VLAN_from_PIF
(session ref, PIF ref, network ref, int)
Create a pool-wide VLAN by taking the PIF.
| Parameters: | session ref session_id | Reference to a valid session |
| PIF ref pif | physical interface on any particular host, that identifies the PIF on which to create the (pool-wide) VLAN interface | |
| network ref network | network to which this interface should be connected | |
| int VLAN | VLAN tag for the new interface | |
| Minimum role: | pool-operator | |
| Result: | The references of the created PIF objects | |
| Errors: | VLAN_TAG_INVALID | You tried to create a VLAN, but the tag you gave was invalid -- it must be between 0 and 4094. The parameter echoes the VLAN tag you gave. |
| Published in: | XenServer 4.0 (rio) | Create a pool-wide VLAN by taking the PIF. |
blob ref
create_new_blob
(session ref, pool ref, string, string, bool)
Create a placeholder for a named binary blob of data that is associated with this pool
| Parameters: | session ref session_id | Reference to a valid session |
| pool ref pool | The pool | |
| string name | The name associated with the blob | |
| string mime_type | The mime type for the data. Empty string translates to application/octet-stream | |
| bool public | True if the blob should be publicly available | |
| Minimum role: | pool-operator | |
| Result: | The reference of the blob, needed for populating its data | |
| Published in: | XenServer 5.0 (orlando) | Create a placeholder for a named binary blob of data that is associated with this pool |
void
crl_install
(session ref, string, string)
Install a TLS CA-issued Certificate Revocation List, pool-wide.
| Parameters: | session ref session_id | Reference to a valid session |
| string name | A name to give the CRL | |
| string cert | The CRL | |
| Minimum role: | pool-operator | |
| Published in: | XenServer 5.5 (george) | Install a TLS CA-issued Certificate Revocation List, pool-wide. |
string set
crl_list
(session ref)
List the names of all installed TLS CA-issued Certificate Revocation Lists.
| Parameters: | session ref session_id | Reference to a valid session |
| Minimum role: | pool-operator | |
| Result: | The names of all installed CRLs | |
| Published in: | XenServer 5.5 (george) | List the names of all installed TLS CA-issued Certificate Revocation Lists. |
void
crl_uninstall
(session ref, string)
Remove a pool-wide TLS CA-issued Certificate Revocation List.
| Parameters: | session ref session_id | Reference to a valid session |
| string name | The CRL name | |
| Minimum role: | pool-operator | |
| Published in: | XenServer 5.5 (george) | Remove a pool-wide TLS CA-issued Certificate Revocation List. |
void
deconfigure_wlb
(session ref)
Permanently deconfigures workload balancing monitoring on this pool
| Parameters: | session ref session_id | Reference to a valid session |
| Minimum role: | pool-operator | |
| Published in: | XenServer 5.5 (george) | Permanently deconfigures workload balancing monitoring on this pool |
void
designate_new_master
(session ref, host ref)
Perform an orderly handover of the role of master to the referenced host.
| Parameters: | session ref session_id | Reference to a valid session |
| host ref host | The host who should become the new master | |
| Minimum role: | pool-operator | |
| Published in: | XenServer 4.1 (miami) | Perform an orderly handover of the role of master to the referenced host. |
void
detect_nonhomogeneous_external_auth
(session ref, pool ref)
This call asynchronously detects if the external authentication configuration in any slave is different from that in the master and raises appropriate alerts
| Parameters: | session ref session_id | Reference to a valid session |
| pool ref pool | The pool where to detect non-homogeneous external authentication configuration | |
| Minimum role: | pool-operator | |
| Published in: | XenServer 5.5 (george) | This call asynchronously detects if the external authentication configuration in any slave is different from that in the master and raises appropriate alerts |
void
disable_client_certificate_auth
(session ref, pool ref)
Disable client certificate authentication on the pool
| Parameters: | session ref session_id | Reference to a valid session |
| pool ref self | The pool | |
| Minimum role: | client-cert | |
| Published in: | XAPI 1.318.0 (1.318.0) | |
void
disable_external_auth
(session ref, pool ref, (string → string) map)
This call disables external authentication on all the hosts of the pool
| Parameters: | session ref session_id | Reference to a valid session |
| pool ref pool | The pool whose external authentication should be disabled | |
| (string → string) map config | Optional parameters as a list of key-values containing the configuration data | |
| Minimum role: | pool-admin | |
| Published in: | XenServer 5.5 (george) | This call disables external authentication on all the hosts of the pool |
void
disable_ha
(session ref)
Turn off High Availability mode
| Parameters: | session ref session_id | Reference to a valid session |
| Minimum role: | client-cert | |
| Published in: | XenServer 4.1 (miami) | Turn off High Availability mode |
void
disable_local_storage_caching
(session ref, pool ref)
This call disables pool-wide local storage caching
| Parameters: | session ref session_id | Reference to a valid session |
| pool ref self | Reference to the pool | |
| Minimum role: | pool-operator | |
| Published in: | XenServer 5.6 FP1 (cowley) | This call disables pool-wide local storage caching |
void
disable_redo_log
(session ref)
Disable the redo log if in use, unless HA is enabled.
| Parameters: | session ref session_id | Reference to a valid session |
| Minimum role: | pool-operator | |
| Published in: | XenServer 5.6 (midnight-ride) | Disable the redo log if in use, unless HA is enabled. |
void
disable_repository_proxy
(session ref, pool ref)
Disable the proxy for RPM package repositories.
| Parameters: | session ref session_id | Reference to a valid session |
| pool ref self | The pool | |
| Minimum role: | client-cert | |
| Published in: | XAPI 21.4.0 (21.4.0) | Disable the proxy for RPM package repositories. |
Deprecated
void
disable_ssl_legacy
(session ref, pool ref)
Sets ssl_legacy false on each host, pool-master last. See Host.ssl_legacy and Host.set_ssl_legacy.
| Parameters: | session ref session_id | Reference to a valid session |
| pool ref self | (ignored) | |
| Minimum role: | pool-operator | |
| Published in: | XenServer 7.0 (dundee) | |
| Deprecated in: | Citrix Hypervisor 8.2 (stockholm) | Legacy SSL no longer supported |
void
eject
(session ref, host ref)
Instruct a pool master to eject a host from the pool
| Parameters: | session ref session_id | Reference to a valid session |
| host ref host | The host to eject | |
| Minimum role: | pool-operator | |
| Published in: | XenServer 4.0 (rio) | Instruct a pool master to eject a host from the pool |
void
emergency_reset_master
(session ref, string)
Instruct a slave already in a pool that the master has changed
| Parameters: | session ref session_id | Reference to a valid session |
| string master_address | The hostname of the master | |
| Minimum role: | pool-operator | |
| Published in: | XenServer 4.0 (rio) | Instruct a slave already in a pool that the master has changed |
void
emergency_transition_to_master
(session ref)
Instruct host that's currently a slave to transition to being master
| Parameters: | session ref session_id | Reference to a valid session |
| Minimum role: | pool-operator | |
| Published in: | XenServer 4.0 (rio) | Instruct host that's currently a slave to transition to being master |
void
enable_client_certificate_auth
(session ref, pool ref, string)
Enable client certificate authentication on the pool
| Parameters: | session ref session_id | Reference to a valid session |
| pool ref self | The pool | |
| string name | The name (CN/SAN) that an incoming client certificate must have to allow authentication | |
| Minimum role: | client-cert | |
| Published in: | XAPI 1.318.0 (1.318.0) | |
void
enable_external_auth
(session ref, pool ref, (string → string) map, string, string)
This call enables external authentication on all the hosts of the pool
| Parameters: | session ref session_id | Reference to a valid session |
| pool ref pool | The pool whose external authentication should be enabled | |
| (string → string) map config | A list of key-values containing the configuration data | |
| string service_name | The name of the service | |
| string auth_type | The type of authentication (e.g. AD for Active Directory) | |
| Minimum role: | pool-admin | |
| Published in: | XenServer 5.5 (george) | This call enables external authentication on all the hosts of the pool |
void
enable_ha
(session ref, SR ref set, (string → string) map)
Turn on High Availability mode
| Parameters: | session ref session_id | Reference to a valid session |
| SR ref set heartbeat_srs | Set of SRs to use for storage heartbeating | |
| (string → string) map configuration | Detailed HA configuration to apply | |
| Minimum role: | client-cert | |
| Published in: | XenServer 4.1 (miami) | Turn on High Availability mode |
void
enable_local_storage_caching
(session ref, pool ref)
This call attempts to enable pool-wide local storage caching
| Parameters: | session ref session_id | Reference to a valid session |
| pool ref self | Reference to the pool | |
| Minimum role: | pool-operator | |
| Published in: | XenServer 5.6 FP1 (cowley) | This call attempts to enable pool-wide local storage caching |
void
enable_redo_log
(session ref, SR ref)
Enable the redo log on the given SR and start using it, unless HA is enabled.
| Parameters: | session ref session_id | Reference to a valid session |
| SR ref sr | SR to hold the redo log. | |
| Minimum role: | pool-operator | |
| Published in: | XenServer 5.6 (midnight-ride) | Enable the redo log on the given SR and start using it, unless HA is enabled. |
Removed
void
enable_ssl_legacy
(session ref, pool ref)
Sets ssl_legacy true on each host, pool-master last. See Host.ssl_legacy and Host.set_ssl_legacy.
| Parameters: | session ref session_id | Reference to a valid session |
| pool ref self | (ignored) | |
| Minimum role: | pool-operator | |
| Published in: | XenServer 7.0 (dundee) | |
| Deprecated in: | XenServer 7.0 (dundee) | Legacy SSL will soon cease to be supported |
| Removed in: | Citrix Hypervisor 8.2 (stockholm) | Legacy SSL no longer supported |
void
enable_tls_verification
(session ref)
Enable TLS server certificate verification
| Parameters: | session ref session_id | Reference to a valid session |
| Minimum role: | pool-admin | |
| Published in: | XAPI 1.290.0 (1.290.0) | |
pool ref set
get_all
(session ref)
Return a list of all the pools known to the system.
| Parameters: | session ref session_id | Reference to a valid session |
| Minimum role: | read-only | |
| Result: | references to all objects | |
| Published in: | XenServer 4.0 (rio) | Pool-wide information |
(pool ref → pool record) map
get_all_records
(session ref)
Return a map of pool references to pool records for all pools known to the system.
| Parameters: | session ref session_id | Reference to a valid session |
| Minimum role: | read-only | |
| Result: | records of all objects | |
| Published in: | XenServer 4.0 (rio) | Pool-wide information |
enum pool_allowed_operations set
get_allowed_operations
(session ref, pool ref)
Get the allowed_operations field of the given pool.
| Parameters: | session ref session_id | Reference to a valid session |
| pool 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. |
(string → blob ref) map
get_blobs
(session ref, pool ref)
Get the blobs field of the given pool.
| Parameters: | session ref session_id | Reference to a valid session |
| pool ref self | reference to the object | |
| Minimum role: | read-only | |
| Result: | value of the field | |
| Published in: | XenServer 5.0 (orlando) | Binary blobs associated with this pool |
pool ref
get_by_uuid
(session ref, string)
Get a reference to the pool 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 | |
| Published in: | XenServer 4.0 (rio) | Pool-wide information |
bool
get_client_certificate_auth_enabled
(session ref, pool ref)
Get the client_certificate_auth_enabled field of the given pool.
| Parameters: | session ref session_id | Reference to a valid session |
| pool ref self | reference to the object | |
| Minimum role: | read-only | |
| Result: | value of the field | |
| Published in: | XAPI 1.318.0 (1.318.0) | |
string
get_client_certificate_auth_name
(session ref, pool ref)
Get the client_certificate_auth_name field of the given pool.
| Parameters: | session ref session_id | Reference to a valid session |
| pool ref self | reference to the object | |
| Minimum role: | read-only | |
| Result: | value of the field | |
| Published in: | XAPI 1.318.0 (1.318.0) | |
bool
get_coordinator_bias
(session ref, pool ref)
Get the coordinator_bias field of the given pool.
| Parameters: | session ref session_id | Reference to a valid session |
| pool ref self | reference to the object | |
| Minimum role: | read-only | |
| Result: | value of the field | |
| Prototyped in: | XAPI 22.37.0 (22.37.0) | |
| Published in: | XenServer 4.0 (rio) | true if bias against pool master when scheduling vms is enabled, false otherwise |
(string → string) map
get_cpu_info
(session ref, pool ref)
Get the cpu_info field of the given pool.
| Parameters: | session ref session_id | Reference to a valid session |
| pool ref self | reference to the object | |
| Minimum role: | read-only | |
| Result: | value of the field | |
| Published in: | XenServer 7.0 (dundee) | Details about the physical CPUs on the pool |
SR ref
get_crash_dump_SR
(session ref, pool ref)
Get the crash_dump_SR field of the given pool.
| Parameters: | session ref session_id | Reference to a valid session |
| pool ref self | reference to the object | |
| Minimum role: | read-only | |
| Result: | value of the field | |
| Published in: | XenServer 4.0 (rio) | The SR in which VDIs for crash dumps are created |
(string → enum pool_allowed_operations) map
get_current_operations
(session ref, pool ref)
Get the current_operations field of the given pool.
| Parameters: | session ref session_id | Reference to a valid session |
| pool 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. |
Prototype
string
get_custom_uefi_certificates
(session ref, pool ref)
Get the custom_uefi_certificates field of the given pool.
| Parameters: | session ref session_id | Reference to a valid session |
| pool ref self | reference to the object | |
| Minimum role: | read-only | |
| Result: | value of the field | |
| Prototyped in: | XAPI 24.0.0 (24.0.0) | |
SR ref
get_default_SR
(session ref, pool ref)
Get the default_SR field of the given pool.
| Parameters: | session ref session_id | Reference to a valid session |
| pool ref self | reference to the object | |
| Minimum role: | read-only | |
| Result: | value of the field | |
| Published in: | XenServer 4.0 (rio) | Default SR for VDIs |
Prototype
int
get_ext_auth_max_threads
(session ref, pool ref)
Get the ext_auth_max_threads field of the given pool.
| Parameters: | session ref session_id | Reference to a valid session |
| pool ref self | reference to the object | |
| Minimum role: | read-only | |
| Result: | value of the field | |
| Prototyped in: | XAPI 23.27.0 (23.27.0) | |
(string → string) map
get_guest_agent_config
(session ref, pool ref)
Get the guest_agent_config field of the given pool.
| Parameters: | session ref session_id | Reference to a valid session |
| pool ref self | reference to the object | |
| Minimum role: | read-only | |
| Result: | value of the field | |
| Published in: | XenServer 7.0 (dundee) | Pool-wide guest agent configuration information |
Prototype
enum pool_guest_secureboot_readiness
get_guest_secureboot_readiness
(session ref, pool ref)
| Parameters: | session ref session_id | Reference to a valid session |
| pool ref self | The pool | |
| Minimum role: | pool-operator | |
| Result: | The readiness of the pool | |
| Prototyped in: | XAPI 24.17.0 (24.17.0) | |
(string → string) map
get_gui_config
(session ref, pool ref)
Get the gui_config field of the given pool.
| Parameters: | session ref session_id | Reference to a valid session |
| pool ref self | reference to the object | |
| Minimum role: | read-only | |
| Result: | value of the field | |
| Published in: | XenServer 5.0 (orlando) | gui-specific configuration for pool |
bool
get_ha_allow_overcommit
(session ref, pool ref)
Get the ha_allow_overcommit field of the given pool.
| Parameters: | session ref session_id | Reference to a valid session |
| pool ref self | reference to the object | |
| Minimum role: | read-only | |
| Result: | value of the field | |
| Published in: | XenServer 5.0 (orlando) | If set to false then operations which would cause the Pool to become overcommitted will be blocked. |
string
get_ha_cluster_stack
(session ref, pool ref)
Get the ha_cluster_stack field of the given pool.
| Parameters: | session ref session_id | Reference to a valid session |
| pool ref self | reference to the object | |
| Minimum role: | read-only | |
| Result: | value of the field | |
| Published in: | XenServer 7.0 (dundee) | The HA cluster stack that is currently in use. Only valid when HA is enabled. |
(string → string) map
get_ha_configuration
(session ref, pool ref)
Get the ha_configuration field of the given pool.
| Parameters: | session ref session_id | Reference to a valid session |
| pool ref self | reference to the object | |
| Minimum role: | read-only | |
| Result: | value of the field | |
| Published in: | XenServer 5.0 (orlando) | The current HA configuration |
bool
get_ha_enabled
(session ref, pool ref)
Get the ha_enabled field of the given pool.
| Parameters: | session ref session_id | Reference to a valid session |
| pool ref self | reference to the object | |
| Minimum role: | read-only | |
| Result: | value of the field | |
| Published in: | XenServer 5.0 (orlando) | true if HA is enabled on the pool, false otherwise |
int
get_ha_host_failures_to_tolerate
(session ref, pool ref)
Get the ha_host_failures_to_tolerate field of the given pool.
| Parameters: | session ref session_id | Reference to a valid session |
| pool ref self | reference to the object | |
| Minimum role: | read-only | |
| Result: | value of the field | |
| Published in: | XenServer 5.0 (orlando) | Number of host failures to tolerate before the Pool is declared to be overcommitted |
bool
get_ha_overcommitted
(session ref, pool ref)
Get the ha_overcommitted field of the given pool.
| Parameters: | session ref session_id | Reference to a valid session |
| pool ref self | reference to the object | |
| Minimum role: | read-only | |
| Result: | value of the field | |
| Published in: | XenServer 5.0 (orlando) | 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 |
int
get_ha_plan_exists_for
(session ref, pool ref)
Get the ha_plan_exists_for field of the given pool.
| Parameters: | session ref session_id | Reference to a valid session |
| pool ref self | reference to the object | |
| Minimum role: | read-only | |
| Result: | value of the field | |
| Published in: | XenServer 5.0 (orlando) | 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. |
string set
get_ha_statefiles
(session ref, pool ref)
Get the ha_statefiles field of the given pool.
| Parameters: | session ref session_id | Reference to a valid session |
| pool ref self | reference to the object | |
| Minimum role: | read-only | |
| Result: | value of the field | |
| Published in: | XenServer 5.0 (orlando) | HA statefile VDIs in use |
(string → string) map
get_health_check_config
(session ref, pool ref)
Get the health_check_config field of the given pool.
| Parameters: | session ref session_id | Reference to a valid session |
| pool ref self | reference to the object | |
| Minimum role: | read-only | |
| Result: | value of the field | |
| Published in: | XenServer 7.0 (dundee) | Configuration for the automatic health check feature |
bool
get_igmp_snooping_enabled
(session ref, pool ref)
Get the igmp_snooping_enabled field of the given pool.
| Parameters: | session ref session_id | Reference to a valid session |
| pool ref self | reference to the object | |
| Minimum role: | read-only | |
| Result: | value of the field | |
| Published in: | XenServer 7.3 (inverness) | true if IGMP snooping is enabled in the pool, false otherwise. |
bool
get_is_psr_pending
(session ref, pool ref)
Get the is_psr_pending field of the given pool.
| Parameters: | session ref session_id | Reference to a valid session |
| pool ref self | reference to the object | |
| Minimum role: | read-only | |
| Result: | value of the field | |
| Published in: | Citrix Hypervisor 8.2 Hotfix 2 (stockholm_psr) | True if either a PSR is running or we are waiting for a PSR to be re-run |
Prototype
datetime
get_last_update_sync
(session ref, pool ref)
Get the last_update_sync field of the given pool.
| Parameters: | session ref session_id | Reference to a valid session |
| pool ref self | reference to the object | |
| Minimum role: | read-only | |
| Result: | value of the field | |
| Prototyped in: | XAPI 23.18.0 (23.18.0) | |
(string → string) map
get_license_state
(session ref, pool ref)
This call returns the license state for the pool
| Parameters: | session ref session_id | Reference to a valid session |
| pool ref self | Reference to the pool | |
| Minimum role: | read-only | |
| Result: | The pool's license state | |
| Published in: | XenServer 6.2 (clearwater) | This call returns the license state for the pool |
bool
get_live_patching_disabled
(session ref, pool ref)
Get the live_patching_disabled field of the given pool.
| Parameters: | session ref session_id | Reference to a valid session |
| pool ref self | reference to the object | |
| Minimum role: | read-only | |
| Result: | value of the field | |
| Published in: | XenServer 7.1 (ely) | The pool-wide flag to show if the live patching feauture is disabled or not. |
Prototype
int
get_local_auth_max_threads
(session ref, pool ref)
Get the local_auth_max_threads field of the given pool.
| Parameters: | session ref session_id | Reference to a valid session |
| pool ref self | reference to the object | |
| Minimum role: | read-only | |
| Result: | value of the field | |
| Prototyped in: | XAPI 23.27.0 (23.27.0) | |
host ref
get_master
(session ref, pool ref)
Get the master field of the given pool.
| Parameters: | session ref session_id | Reference to a valid session |
| pool ref self | reference to the object | |
| Minimum role: | read-only | |
| Result: | value of the field | |
| Published in: | XenServer 4.0 (rio) | The host that is pool master |
VDI ref set
get_metadata_VDIs
(session ref, pool ref)
Get the metadata_VDIs field of the given pool.
| Parameters: | session ref session_id | Reference to a valid session |
| pool ref self | reference to the object | |
| Minimum role: | read-only | |
| Result: | value of the field | |
| Published in: | XenServer 6.0 (boston) | The set of currently known metadata VDIs for this pool |
Prototype
bool
get_migration_compression
(session ref, pool ref)
Get the migration_compression field of the given pool.
| Parameters: | session ref session_id | Reference to a valid session |
| pool ref self | reference to the object | |
| Minimum role: | read-only | |
| Result: | value of the field | |
| Prototyped in: | XAPI 22.33.0 (22.33.0) | |
string
get_name_description
(session ref, pool ref)
Get the name_description field of the given pool.
| Parameters: | session ref session_id | Reference to a valid session |
| pool ref self | reference to the object | |
| Minimum role: | read-only | |
| Result: | value of the field | |
| Published in: | XenServer 4.0 (rio) | Description |
string
get_name_label
(session ref, pool ref)
Get the name_label field of the given pool.
| Parameters: | session ref session_id | Reference to a valid session |
| pool ref self | reference to the object | |
| Minimum role: | read-only | |
| Result: | value of the field | |
| Published in: | XenServer 4.0 (rio) | Short name |
(string → string) map
get_other_config
(session ref, pool ref)
Get the other_config field of the given pool.
| Parameters: | session ref session_id | Reference to a valid session |
| pool ref self | reference to the object | |
| Minimum role: | read-only | |
| Result: | value of the field | |
| Published in: | XenServer 4.0 (rio) | additional configuration |
Deprecated
bool
get_policy_no_vendor_device
(session ref, pool ref)
Get the policy_no_vendor_device field of the given pool.
| Parameters: | session ref session_id | Reference to a valid session |
| pool ref self | reference to the object | |
| Minimum role: | read-only | |
| Result: | value of the field | |
| Published in: | XenServer 7.0 (dundee) | |
| Deprecated in: | XAPI 24.14.0 (24.14.0) | No longer considered by VM.create |
Prototype
(string → string) map
get_recommendations
(session ref, pool ref)
Get the recommendations field of the given pool.
| Parameters: | session ref session_id | Reference to a valid session |
| pool ref self | reference to the object | |
| Minimum role: | read-only | |
| Result: | value of the field | |
| Prototyped in: | XAPI 24.19.1 (24.19.1) | |
pool record
get_record
(session ref, pool ref)
Get a record containing the current state of the given pool.
| Parameters: | session ref session_id | Reference to a valid session |
| pool ref self | reference to the object | |
| Minimum role: | read-only | |
| Result: | all fields from the object | |
| Published in: | XenServer 4.0 (rio) | Pool-wide information |
bool
get_redo_log_enabled
(session ref, pool ref)
Get the redo_log_enabled field of the given pool.
| Parameters: | session ref session_id | Reference to a valid session |
| pool ref self | reference to the object | |
| Minimum role: | read-only | |
| Result: | value of the field | |
| Published in: | XenServer 5.6 (midnight-ride) | true a redo-log is to be used other than when HA is enabled, false otherwise |
VDI ref
get_redo_log_vdi
(session ref, pool ref)
Get the redo_log_vdi field of the given pool.
| Parameters: | session ref session_id | Reference to a valid session |
| pool ref self | reference to the object | |
| Minimum role: | read-only | |
| Result: | value of the field | |
| Published in: | XenServer 5.6 (midnight-ride) | indicates the VDI to use for the redo-log other than when HA is enabled |
Repository ref set
get_repositories
(session ref, pool ref)
Get the repositories field of the given pool.
| Parameters: | session ref session_id | Reference to a valid session |
| pool ref self | reference to the object | |
| Minimum role: | read-only | |
| Result: | value of the field | |
| Published in: | XAPI 1.301.0 (1.301.0) | The set of currently enabled repositories |
secret ref
get_repository_proxy_password
(session ref, pool ref)
Get the repository_proxy_password field of the given pool.
| Parameters: | session ref session_id | Reference to a valid session |
| pool ref self | reference to the object | |
| Minimum role: | read-only | |
| Result: | value of the field | |
| Published in: | XAPI 21.3.0 (21.3.0) | |
| Changed in: | XAPI 23.9.0 (23.9.0) | Changed internal_only to false |
string
get_repository_proxy_url
(session ref, pool ref)
Get the repository_proxy_url field of the given pool.
| Parameters: | session ref session_id | Reference to a valid session |
| pool ref self | reference to the object | |
| Minimum role: | read-only | |
| Result: | value of the field | |
| Published in: | XAPI 21.3.0 (21.3.0) | Url of the proxy used in syncing with the enabled repositories |
string
get_repository_proxy_username
(session ref, pool ref)
Get the repository_proxy_username field of the given pool.
| Parameters: | session ref session_id | Reference to a valid session |
| pool ref self | reference to the object | |
| Minimum role: | read-only | |
| Result: | value of the field | |
| Published in: | XAPI 21.3.0 (21.3.0) | Username for the authentication of the proxy used in syncing with the enabled repositories |
(string → string) map
get_restrictions
(session ref, pool ref)
Get the restrictions field of the given pool.
| Parameters: | session ref session_id | Reference to a valid session |
| pool ref self | reference to the object | |
| Minimum role: | read-only | |
| Result: | value of the field | |
| Published in: | XenServer 5.6 (midnight-ride) | Pool-wide restrictions currently in effect |
SR ref
get_suspend_image_SR
(session ref, pool ref)
Get the suspend_image_SR field of the given pool.
| Parameters: | session ref session_id | Reference to a valid session |
| pool ref self | reference to the object | |
| Minimum role: | read-only | |
| Result: | value of the field | |
| Published in: | XenServer 4.0 (rio) | The SR in which VDIs for suspend images are created |
string set
get_tags
(session ref, pool ref)
Get the tags field of the given pool.
| Parameters: | session ref session_id | Reference to a valid session |
| pool ref self | reference to the object | |
| Minimum role: | read-only | |
| Result: | value of the field | |
| Published in: | XenServer 5.0 (orlando) | user-specified tags for categorization purposes |
Prototype
enum telemetry_frequency
get_telemetry_frequency
(session ref, pool ref)
Get the telemetry_frequency field of the given pool.
| Parameters: | session ref session_id | Reference to a valid session |
| pool ref self | reference to the object | |
| Minimum role: | read-only | |
| Result: | value of the field | |
| Prototyped in: | XAPI 23.9.0 (23.9.0) | |
Prototype
datetime
get_telemetry_next_collection
(session ref, pool ref)
Get the telemetry_next_collection field of the given pool.
| Parameters: | session ref session_id | Reference to a valid session |
| pool ref self | reference to the object | |
| Minimum role: | read-only | |
| Result: | value of the field | |
| Prototyped in: | XAPI 23.9.0 (23.9.0) | |
Prototype
secret ref
get_telemetry_uuid
(session ref, pool ref)
Get the telemetry_uuid field of the given pool.
| Parameters: | session ref session_id | Reference to a valid session |
| pool ref self | reference to the object | |
| Minimum role: | read-only | |
| Result: | value of the field | |
| Prototyped in: | XAPI 23.9.0 (23.9.0) | |
bool
get_tls_verification_enabled
(session ref, pool ref)
Get the tls_verification_enabled field of the given pool.
| Parameters: | session ref session_id | Reference to a valid session |
| pool ref self | reference to the object | |
| Minimum role: | read-only | |
| Result: | value of the field | |
| Published in: | XAPI 1.290.0 (1.290.0) | |
string
get_uefi_certificates
(session ref, pool ref)
Get the uefi_certificates field of the given pool.
| Parameters: | session ref session_id | Reference to a valid session |
| pool ref self | reference to the object | |
| Minimum role: | read-only | |
| Result: | value of the field | |
| Published in: | Citrix Hypervisor 8.1 (quebec) | The UEFI certificates allowing Secure Boot |
| Changed in: | XAPI 22.16.0 (22.16.0) | Became StaticRO to be editable through new method |
Prototype
int
get_update_sync_day
(session ref, pool ref)
Get the update_sync_day field of the given pool.
| Parameters: | session ref session_id | Reference to a valid session |
| pool ref self | reference to the object | |
| Minimum role: | read-only | |
| Result: | value of the field | |
| Prototyped in: | XAPI 23.18.0 (23.18.0) | |
Prototype
bool
get_update_sync_enabled
(session ref, pool ref)
Get the update_sync_enabled field of the given pool.
| Parameters: | session ref session_id | Reference to a valid session |
| pool ref self | reference to the object | |
| Minimum role: | read-only | |
| Result: | value of the field | |
| Prototyped in: | XAPI 23.18.0 (23.18.0) | |
Prototype
enum update_sync_frequency
get_update_sync_frequency
(session ref, pool ref)
Get the update_sync_frequency field of the given pool.
| Parameters: | session ref session_id | Reference to a valid session |
| pool ref self | reference to the object | |
| Minimum role: | read-only | |
| Result: | value of the field | |
| Prototyped in: | XAPI 23.18.0 (23.18.0) | |
string
get_uuid
(session ref, pool ref)
Get the uuid field of the given pool.
| Parameters: | session ref session_id | Reference to a valid session |
| pool ref self | reference to the object | |
| Minimum role: | read-only | |
| Result: | value of the field | |
| Published in: | XenServer 4.0 (rio) | Unique identifier/object reference |
Deprecated
string
get_vswitch_controller
(session ref, pool ref)
Get the vswitch_controller field of the given pool.
| Parameters: | session ref session_id | Reference to a valid session |
| pool ref self | reference to the object | |
| Minimum role: | read-only | |
| Result: | value of the field | |
| Published in: | XenServer 5.6 (midnight-ride) | the IP address of the vswitch controller. |
| Deprecated in: | XenServer 7.2 (falcon) | Deprecated: set the IP address of the vswitch controller in SDN_controller instead. |
bool
get_wlb_enabled
(session ref, pool ref)
Get the wlb_enabled field of the given pool.
| Parameters: | session ref session_id | Reference to a valid session |
| pool ref self | reference to the object | |
| Minimum role: | read-only | |
| Result: | value of the field | |
| Published in: | XenServer 5.5 (george) | true if workload balancing is enabled on the pool, false otherwise |
string
get_wlb_url
(session ref, pool ref)
Get the wlb_url field of the given pool.
| Parameters: | session ref session_id | Reference to a valid session |
| pool ref self | reference to the object | |
| Minimum role: | read-only | |
| Result: | value of the field | |
| Published in: | XenServer 5.5 (george) | Url for the configured workload balancing host |
string
get_wlb_username
(session ref, pool ref)
Get the wlb_username field of the given pool.
| Parameters: | session ref session_id | Reference to a valid session |
| pool ref self | reference to the object | |
| Minimum role: | read-only | |
| Result: | value of the field | |
| Published in: | XenServer 5.5 (george) | Username for accessing the workload balancing host |
Deprecated
bool
get_wlb_verify_cert
(session ref, pool ref)
Get the wlb_verify_cert field of the given pool.
| Parameters: | session ref session_id | Reference to a valid session |
| pool ref self | reference to the object | |
| Minimum role: | read-only | |
| Result: | value of the field | |
| Published in: | XenServer 5.5 (george) | |
| Deprecated in: | XAPI 1.290.0 (1.290.0) | Deprecated: to enable TLS verification use Pool.enable_tls_verification instead |
int
ha_compute_hypothetical_max_host_failures_to_tolerate
(session ref, (VM ref → string) map)
Returns the maximum number of host failures we could tolerate before we would be unable to restart the provided VMs
| Parameters: | session ref session_id | Reference to a valid session |
| (VM ref → string) map configuration | Map of protected VM reference to restart priority | |
| Minimum role: | read-only | |
| Result: | maximum value for ha_host_failures_to_tolerate given provided configuration | |
| Published in: | XenServer 5.0 (orlando) | Returns the maximum number of host failures we could tolerate before we would be unable to restart the provided VMs |
int
ha_compute_max_host_failures_to_tolerate
(session ref)
Returns the maximum number of host failures we could tolerate before we would be unable to restart configured VMs
| Parameters: | session ref session_id | Reference to a valid session |
| Minimum role: | pool-operator | |
| Result: | maximum value for ha_host_failures_to_tolerate given current configuration | |
| Published in: | XenServer 5.0 (orlando) | Returns the maximum number of host failures we could tolerate before we would be unable to restart configured VMs |
(VM ref → (string → string) map) map
ha_compute_vm_failover_plan
(session ref, host ref set, VM ref set)
Return a VM failover plan assuming a given subset of hosts fail
| Parameters: | session ref session_id | Reference to a valid session |
| host ref set failed_hosts | The set of hosts to assume have failed | |
| VM ref set failed_vms | The set of VMs to restart | |
| Minimum role: | pool-operator | |
| Result: | VM failover plan: a map of VM to host to restart the host on | |
| Published in: | XenServer 5.0 (orlando) | Return a VM failover plan assuming a given subset of hosts fail |
bool
ha_failover_plan_exists
(session ref, int)
Returns true if a VM failover plan exists for up to 'n' host failures
| Parameters: | session ref session_id | Reference to a valid session |
| int n | The number of host failures to plan for | |
| Minimum role: | pool-operator | |
| Result: | true if a failover plan exists for the supplied number of host failures | |
| Published in: | XenServer 5.0 (orlando) | Returns true if a VM failover plan exists for up to 'n' host failures |
void
ha_prevent_restarts_for
(session ref, int)
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
| Parameters: | session ref session_id | Reference to a valid session |
| int seconds | The number of seconds to block the restart thread for | |
| Minimum role: | pool-operator | |
| Published in: | XenServer 5.0 Update 1 (orlando-update-1) | 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
has_extension
(session ref, pool ref, string)
Return true if the extension is available on the pool
| Parameters: | session ref session_id | Reference to a valid session |
| pool ref self | The pool | |
| string name | The name of the API call | |
| Minimum role: | pool-admin | |
| Result: | True if the extension exists, false otherwise | |
| Published in: | XenServer 7.0 (dundee) | Return true if the extension is available on the pool |
void
initialize_wlb
(session ref, string, string, string, string, string)
Initializes workload balancing monitoring on this pool with the specified wlb server
| Parameters: | session ref session_id | Reference to a valid session |
| string wlb_url | The ip address and port to use when accessing the wlb server | |
| string wlb_username | The username used to authenticate with the wlb server | |
| string wlb_password | The password used to authenticate with the wlb server | |
| string xenserver_username | The username used by the wlb server to authenticate with the xenserver | |
| string xenserver_password | The password used by the wlb server to authenticate with the xenserver | |
| Minimum role: | pool-operator | |
| Published in: | XenServer 5.5 (george) | Initializes workload balancing monitoring on this pool with the specified wlb server |
void
install_ca_certificate
(session ref, string, string)
Install a TLS CA certificate, pool-wide.
| Parameters: | session ref session_id | Reference to a valid session |
| string name | A name to give the certificate | |
| string cert | The certificate in PEM format | |
| Minimum role: | client-cert | |
| Published in: | XAPI 1.290.0 (1.290.0) | Install TLS CA certificate |
void
join
(session ref, string, string, string)
Instruct host to join a new pool
| Parameters: | session ref session_id | Reference to a valid session |
| string master_address | The hostname of the master of the pool to join | |
| string master_username | The username of the master (for initial authentication) | |
| string master_password | The password for the master (for initial authentication) | |
| Minimum role: | pool-operator | |
| Errors: | JOINING_HOST_CANNOT_CONTAIN_SHARED_SRS | The server joining the pool cannot contain any shared storage. |
| Published in: | XenServer 4.0 (rio) | Instruct host to join a new pool |
void
join_force
(session ref, string, string, string)
Instruct host to join a new pool
| Parameters: | session ref session_id | Reference to a valid session |
| string master_address | The hostname of the master of the pool to join | |
| string master_username | The username of the master (for initial authentication) | |
| string master_password | The password for the master (for initial authentication) | |
| Minimum role: | pool-operator | |
| Published in: | XenServer 4.0 (rio) | Instruct host to join a new pool |
void
management_reconfigure
(session ref, network ref)
Reconfigure the management network interface for all Hosts in the Pool
| Parameters: | session ref session_id | Reference to a valid session |
| network ref network | The network | |
| Minimum role: | pool-operator | |
| Errors: | HA_IS_ENABLED | The operation could not be performed because HA is enabled on the Pool |
| PIF_NOT_PRESENT | This host has no PIF on the given network. | |
| CANNOT_PLUG_BOND_SLAVE | This PIF is a bond member and cannot be plugged. | |
| PIF_INCOMPATIBLE_PRIMARY_ADDRESS_TYPE | The primary address types are not compatible | |
| PIF_HAS_NO_NETWORK_CONFIGURATION | PIF has no IP configuration (mode currently set to 'none') | |
| PIF_HAS_NO_V6_NETWORK_CONFIGURATION | PIF has no IPv6 configuration (mode currently set to 'none') | |
| Published in: | XenServer 7.3 (inverness) | Reconfigure the management network interface for all Hosts in the Pool |
host ref set
recover_slaves
(session ref)
Instruct a pool master, M, to try and contact its slaves and, if slaves are in emergency mode, reset their master address to M.
| Parameters: | session ref session_id | Reference to a valid session |
| Minimum role: | pool-operator | |
| Result: | list of hosts whose master address were successfully reset | |
| Published in: | XenServer 4.0 (rio) | Instruct a pool master, M, to try and contact its slaves and, if slaves are in emergency mode, reset their master address to M. |
void
remove_from_guest_agent_config
(session ref, pool ref, string)
Remove a key-value pair from the pool-wide guest agent configuration
| Parameters: | session ref session_id | Reference to a valid session |
| pool ref self | The pool | |
| string key | The key to remove | |
| Minimum role: | pool-admin | |
| Published in: | XenServer 7.0 (dundee) | Remove a key-value pair from the pool-wide guest agent configuration |
void
remove_from_gui_config
(session ref, pool ref, string)
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.
| Parameters: | session ref session_id | Reference to a valid session |
| pool ref self | reference to the object | |
| string key | Key to remove | |
| Minimum role: | vm-operator | |
| Published in: | XenServer 5.0 (orlando) | gui-specific configuration for pool |
void
remove_from_health_check_config
(session ref, pool ref, string)
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.
| Parameters: | session ref session_id | Reference to a valid session |
| pool ref self | reference to the object | |
| string key | Key to remove | |
| Minimum role: | pool-operator | |
| Published in: | XenServer 7.0 (dundee) | Configuration for the automatic health check feature |
void
remove_from_other_config
(session ref, pool ref, string)
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.
| Parameters: | session ref session_id | Reference to a valid session |
| pool ref self | reference to the object | |
| string key | Key to remove | |
| Minimum role: | pool-operator | |
| Published in: | XenServer 4.0 (rio) | additional configuration |
void
remove_repository
(session ref, pool ref, Repository ref)
Remove a repository from the enabled set
| Parameters: | session ref session_id | Reference to a valid session |
| pool ref self | The pool | |
| Repository ref value | The repository to be removed | |
| Minimum role: | client-cert | |
| Published in: | XAPI 1.301.0 (1.301.0) | Remove a repository from the enabled set |
void
remove_tags
(session ref, pool ref, string)
Remove the given value from the tags field of the given pool. If the value is not in that Set, then do nothing.
| Parameters: | session ref session_id | Reference to a valid session |
| pool ref self | reference to the object | |
| string value | Value to remove | |
| Minimum role: | vm-operator | |
| Published in: | XenServer 5.0 (orlando) | user-specified tags for categorization purposes |
Prototype
void
reset_telemetry_uuid
(session ref, pool ref)
Assign a new UUID to telemetry data.
| Parameters: | session ref session_id | Reference to a valid session |
| pool ref self | The pool | |
| Minimum role: | pool-admin | |
| Prototyped in: | XAPI 23.9.0 (23.9.0) | |
(string → string) map
retrieve_wlb_configuration
(session ref)
Retrieves the pool optimization criteria from the workload balancing server
| Parameters: | session ref session_id | Reference to a valid session |
| Minimum role: | read-only | |
| Result: | The configuration used in optimizing this pool | |
| Published in: | XenServer 5.5 (george) | Retrieves the pool optimization criteria from the workload balancing server |
(VM ref → string set) map
retrieve_wlb_recommendations
(session ref)
Retrieves vm migrate recommendations for the pool from the workload balancing server
| Parameters: | session ref session_id | Reference to a valid session |
| Minimum role: | read-only | |
| Result: | The list of vm migration recommendations | |
| Published in: | XenServer 5.5 (george) | Retrieves vm migrate recommendations for the pool from the workload balancing server |
void
rotate_secret
(session ref)
| Parameters: | session ref session_id | Reference to a valid session |
| Minimum role: | pool-admin | |
| Errors: | INTERNAL_ERROR | The server failed to handle your request, due to an internal error. The given message may give details useful for debugging the problem. |
| HOST_IS_SLAVE | You cannot make regular API calls directly on a supporter. Please pass API calls via the coordinator host. | |
| CANNOT_CONTACT_HOST | Cannot forward messages because the server cannot be contacted. The server may be switched off or there may be network connectivity problems. | |
| HA_IS_ENABLED | The operation could not be performed because HA is enabled on the Pool | |
| NOT_SUPPORTED_DURING_UPGRADE | This operation is not supported during an upgrade. | |
| Published in: | Citrix Hypervisor 8.2 Hotfix 2 (stockholm_psr) | |
string
send_test_post
(session ref, string, int, string)
Send the given body to the given host and port, using HTTPS, and print the response. This is used for debugging the SSL layer.
| Parameters: | session ref session_id | Reference to a valid session |
| string host | ||
| int port | ||
| string body | ||
| Minimum role: | pool-admin | |
| Result: | The response | |
| Published in: | XenServer 5.5 (george) | 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
send_wlb_configuration
(session ref, (string → string) map)
Sets the pool optimization criteria for the workload balancing server
| Parameters: | session ref session_id | Reference to a valid session |
| (string → string) map config | The configuration to use in optimizing this pool | |
| Minimum role: | pool-operator | |
| Published in: | XenServer 5.5 (george) | Sets the pool optimization criteria for the workload balancing server |
void
set_coordinator_bias
(session ref, pool ref, bool)
Set the coordinator_bias field of the given pool.
| Parameters: | session ref session_id | Reference to a valid session |
| pool ref self | reference to the object | |
| bool value | New value to set | |
| Minimum role: | pool-operator | |
| Prototyped in: | XAPI 22.37.0 (22.37.0) | |
| Published in: | XenServer 4.0 (rio) | true if bias against pool master when scheduling vms is enabled, false otherwise |
void
set_crash_dump_SR
(session ref, pool ref, SR ref)
Set the crash_dump_SR field of the given pool.
| Parameters: | session ref session_id | Reference to a valid session |
| pool ref self | reference to the object | |
| SR ref value | New value to set | |
| Minimum role: | pool-operator | |
| Published in: | XenServer 4.0 (rio) | The SR in which VDIs for crash dumps are created |
Prototype
void
set_custom_uefi_certificates
(session ref, pool ref, string)
Set custom UEFI certificates for a pool and all its hosts. Need `allow-custom-uefi-certs` set to true in conf. If empty: default back to Pool.uefi_certificates
| Parameters: | session ref session_id | Reference to a valid session |
| pool ref self | The pool | |
| string value | The certificates to apply to the pool and its hosts | |
| Minimum role: | pool-admin | |
| Prototyped in: | XAPI 24.0.0 (24.0.0) | |
void
set_default_SR
(session ref, pool ref, SR ref)
Set the default_SR field of the given pool.
| Parameters: | session ref session_id | Reference to a valid session |
| pool ref self | reference to the object | |
| SR ref value | New value to set | |
| Minimum role: | pool-operator | |
| Published in: | XenServer 4.0 (rio) | Default SR for VDIs |
Prototype
void
set_ext_auth_max_threads
(session ref, pool ref, int)
| Parameters: | session ref session_id | Reference to a valid session |
| pool ref self | The pool | |
| int value | The new maximum | |
| Minimum role: | pool-operator | |
| Prototyped in: | XAPI 23.27.0 (23.27.0) | |
void
set_gui_config
(session ref, pool ref, (string → string) map)
Set the gui_config field of the given pool.
| Parameters: | session ref session_id | Reference to a valid session |
| pool ref self | reference to the object | |
| (string → string) map value | New value to set | |
| Minimum role: | vm-operator | |
| Published in: | XenServer 5.0 (orlando) | gui-specific configuration for pool |
void
set_ha_allow_overcommit
(session ref, pool ref, bool)
Set the ha_allow_overcommit field of the given pool.
| Parameters: | session ref session_id | Reference to a valid session |
| pool ref self | reference to the object | |
| bool value | New value to set | |
| Minimum role: | pool-operator | |
| Published in: | XenServer 5.0 (orlando) | If set to false then operations which would cause the Pool to become overcommitted will be blocked. |
void
set_ha_host_failures_to_tolerate
(session ref, pool ref, int)
Set the maximum number of host failures to consider in the HA VM restart planner
| Parameters: | session ref session_id | Reference to a valid session |
| pool ref self | The pool | |
| int value | New number of host failures to consider | |
| Minimum role: | pool-operator | |
| Published in: | XenServer 5.0 (orlando) | Set the maximum number of host failures to consider in the HA VM restart planner |
void
set_health_check_config
(session ref, pool ref, (string → string) map)
Set the health_check_config field of the given pool.
| Parameters: | session ref session_id | Reference to a valid session |
| pool ref self | reference to the object | |
| (string → string) map value | New value to set | |
| Minimum role: | pool-operator | |
| Published in: | XenServer 7.0 (dundee) | Configuration for the automatic health check feature |
Prototype
void
set_https_only
(session ref, pool ref, bool)
updates all the host firewalls in the pool to open or close port 80 depending on the value
| Parameters: | session ref session_id | Reference to a valid session |
| pool ref self | The pool | |
| bool value | true - http port 80 will be blocked, false - http port 80 will be open for the hosts in the pool | |
| Minimum role: | pool-operator | |
| Prototyped in: | XAPI 22.27.0 (22.27.0) | |
void
set_igmp_snooping_enabled
(session ref, pool ref, bool)
Enable or disable IGMP Snooping on the pool.
| Parameters: | session ref session_id | Reference to a valid session |
| pool ref self | The pool | |
| bool value | Enable or disable IGMP Snooping on the pool | |
| Minimum role: | pool-operator | |
| Published in: | XenServer 7.3 (inverness) | Enable or disable IGMP Snooping on the pool. |
void
set_is_psr_pending
(session ref, pool ref, bool)
Set the is_psr_pending field of the given pool.
| Parameters: | session ref session_id | Reference to a valid session |
| pool ref self | reference to the object | |
| bool value | New value to set | |
| Minimum role: | pool-operator | |
| Published in: | Citrix Hypervisor 8.2 Hotfix 2 (stockholm_psr) | True if either a PSR is running or we are waiting for a PSR to be re-run |
void
set_live_patching_disabled
(session ref, pool ref, bool)
Set the live_patching_disabled field of the given pool.
| Parameters: | session ref session_id | Reference to a valid session |
| pool ref self | reference to the object | |
| bool value | New value to set | |
| Minimum role: | pool-operator | |
| Published in: | XenServer 7.1 (ely) | The pool-wide flag to show if the live patching feauture is disabled or not. |
Prototype
void
set_local_auth_max_threads
(session ref, pool ref, int)
| Parameters: | session ref session_id | Reference to a valid session |
| pool ref self | The pool | |
| int value | The new maximum | |
| Minimum role: | pool-operator | |
| Prototyped in: | XAPI 23.27.0 (23.27.0) | |
Prototype
void
set_migration_compression
(session ref, pool ref, bool)
Set the migration_compression field of the given pool.
| Parameters: | session ref session_id | Reference to a valid session |
| pool ref self | reference to the object | |
| bool value | New value to set | |
| Minimum role: | pool-operator | |
| Prototyped in: | XAPI 22.33.0 (22.33.0) | |
void
set_name_description
(session ref, pool ref, string)
Set the name_description field of the given pool.
| Parameters: | session ref session_id | Reference to a valid session |
| pool ref self | reference to the object | |
| string value | New value to set | |
| Minimum role: | pool-operator | |
| Published in: | XenServer 4.0 (rio) | Description |
void
set_name_label
(session ref, pool ref, string)
Set the name_label field of the given pool.
| Parameters: | session ref session_id | Reference to a valid session |
| pool ref self | reference to the object | |
| string value | New value to set | |
| Minimum role: | pool-operator | |
| Published in: | XenServer 4.0 (rio) | Short name |
void
set_other_config
(session ref, pool ref, (string → string) map)
Set the other_config field of the given pool.
| Parameters: | session ref session_id | Reference to a valid session |
| pool ref self | reference to the object | |
| (string → string) map value | New value to set | |
| Minimum role: | pool-operator | |
| Published in: | XenServer 4.0 (rio) | additional configuration |
Deprecated
void
set_policy_no_vendor_device
(session ref, pool ref, bool)
Set the policy_no_vendor_device field of the given pool.
| Parameters: | session ref session_id | Reference to a valid session |
| pool ref self | reference to the object | |
| bool value | New value to set | |
| Minimum role: | pool-operator | |
| Published in: | XenServer 7.0 (dundee) | |
| Deprecated in: | XAPI 24.14.0 (24.14.0) | No longer considered by VM.create |
void
set_repositories
(session ref, pool ref, Repository ref set)
Set enabled set of repositories
| Parameters: | session ref session_id | Reference to a valid session |
| pool ref self | The pool | |
| Repository ref set value | The set of repositories to be enabled | |
| Minimum role: | client-cert | |
| Published in: | XAPI 1.301.0 (1.301.0) | Set enabled set of repositories |
void
set_suspend_image_SR
(session ref, pool ref, SR ref)
Set the suspend_image_SR field of the given pool.
| Parameters: | session ref session_id | Reference to a valid session |
| pool ref self | reference to the object | |
| SR ref value | New value to set | |
| Minimum role: | pool-operator | |
| Published in: | XenServer 4.0 (rio) | The SR in which VDIs for suspend images are created |
void
set_tags
(session ref, pool ref, string set)
Set the tags field of the given pool.
| Parameters: | session ref session_id | Reference to a valid session |
| pool ref self | reference to the object | |
| string set value | New value to set | |
| Minimum role: | vm-operator | |
| Published in: | XenServer 5.0 (orlando) | user-specified tags for categorization purposes |
Prototype
void
set_telemetry_next_collection
(session ref, pool ref, datetime)
Set the timestamp for the next telemetry data collection.
| Parameters: | session ref session_id | Reference to a valid session |
| pool ref self | The pool | |
| datetime value | The earliest timestamp (in UTC) when the next round of telemetry collection can be carried out. | |
| Minimum role: | pool-admin | |
| Prototyped in: | XAPI 23.9.0 (23.9.0) | |
Deprecated
void
set_uefi_certificates
(session ref, pool ref, string)
Set the UEFI certificates for a pool and all its hosts. Deprecated: use set_custom_uefi_certificates instead
| Parameters: | session ref session_id | Reference to a valid session |
| pool ref self | The pool | |
| string value | The certificates to apply to the pool and its hosts | |
| Minimum role: | pool-admin | |
| Published in: | XAPI 22.16.0 (22.16.0) | |
| Deprecated in: | XAPI 24.0.0 (24.0.0) | use set_custom_uefi_certificates instead |
Prototype
void
set_update_sync_enabled
(session ref, pool ref, bool)
enable or disable periodic update synchronization depending on the value
| Parameters: | session ref session_id | Reference to a valid session |
| pool ref self | The pool | |
| bool value | true - enable periodic update synchronization, false - disable it | |
| Minimum role: | pool-operator | |
| Prototyped in: | XAPI 23.18.0 (23.18.0) | |
Deprecated
void
set_vswitch_controller
(session ref, string)
Set the IP address of the vswitch controller.
| Parameters: | session ref session_id | Reference to a valid session |
| string address | IP address of the vswitch controller. | |
| Minimum role: | pool-operator | |
| Published in: | XenServer 5.6 (midnight-ride) | Set the IP address of the vswitch controller. |
| Extended in: | XenServer 5.6 FP1 (cowley) | Allow to be set to the empty string (no controller is used). |
| Deprecated in: | XenServer 7.2 (falcon) | Deprecated: use 'SDN_controller.introduce' and 'SDN_controller.forget' instead. |
void
set_wlb_enabled
(session ref, pool ref, bool)
Set the wlb_enabled field of the given pool.
| Parameters: | session ref session_id | Reference to a valid session |
| pool ref self | reference to the object | |
| bool value | New value to set | |
| Minimum role: | client-cert | |
| Published in: | XenServer 5.5 (george) | true if workload balancing is enabled on the pool, false otherwise |
Deprecated
void
set_wlb_verify_cert
(session ref, pool ref, bool)
Set the wlb_verify_cert field of the given pool.
| Parameters: | session ref session_id | Reference to a valid session |
| pool ref self | reference to the object | |
| bool value | New value to set | |
| Minimum role: | pool-operator | |
| Published in: | XenServer 5.5 (george) | |
| Deprecated in: | XAPI 1.290.0 (1.290.0) | Deprecated: to enable TLS verification use Pool.enable_tls_verification instead |
void
sync_database
(session ref)
Forcibly synchronise the database now
| Parameters: | session ref session_id | Reference to a valid session |
| Minimum role: | pool-operator | |
| Published in: | XenServer 4.0 (rio) | Forcibly synchronise the database now |
string
sync_updates
(session ref, pool ref, bool, string, string)
Sync with the enabled repository
| Parameters: | session ref session_id | Reference to a valid session |
| pool ref self | The pool | |
| bool force | If true local mirroring repo will be removed before syncing | |
| string token | The token for repository client authentication | |
| string token_id | The ID of the token | |
| Minimum role: | client-cert | |
| Result: | The SHA256 hash of updateinfo.xml.gz | |
| Published in: | XAPI 1.329.0 (1.329.0) | Sync with the enabled repository |
string
test_archive_target
(session ref, pool ref, (string → string) map)
This call tests if a location is valid
| Parameters: | session ref session_id | Reference to a valid session |
| pool ref self | Reference to the pool | |
| (string → string) map config | Location config settings to test | |
| Minimum role: | pool-operator | |
| Result: | An XMLRPC result | |
| Published in: | XenServer 5.6 FP1 (cowley) | This call tests if a location is valid |
void
uninstall_ca_certificate
(session ref, string)
Remove a pool-wide TLS CA certificate.
| Parameters: | session ref session_id | Reference to a valid session |
| string name | The certificate name | |
| Minimum role: | client-cert | |
| Published in: | XAPI 1.290.0 (1.290.0) | Uninstall TLS CA certificate |