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) mapblobs[RO/runtime]
Binary blobs associated with this pool
Default value:
{}
Published in:
XenServer 5.0 (orlando)
Binary blobs associated with this pool
boolclient_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)
stringclient_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)
boolcoordinator_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
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.
stringha_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) mapha_configuration[RO/runtime]
The current HA configuration
Default value:
{}
Published in:
XenServer 5.0 (orlando)
The current HA configuration
boolha_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
intha_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
boolha_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
intha_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 setha_statefiles[RO/runtime]
HA statefile VDIs in use
Default value:
{}
Published in:
XenServer 5.0 (orlando)
HA statefile VDIs in use
(string → string) maphealth_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
booligmp_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.
boolis_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
datetimelast_update_sync[RO/runtime]
time of the last update sychronization
Default value:
19700101T00:00:00Z
Prototyped in:
XAPI 23.18.0 (23.18.0)
boollive_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
intlocal_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 refmaster[RO/runtime]
The host that is pool master
Published in:
XenServer 4.0 (rio)
The host that is pool master
VDI ref setmetadata_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
boolmigration_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)
stringname_description[RW]
Description
Published in:
XenServer 4.0 (rio)
Description
stringname_label[RW]
Short name
Published in:
XenServer 4.0 (rio)
Short name
(string → string) mapother_config[RW]
additional configuration
Published in:
XenServer 4.0 (rio)
additional configuration
boolpolicy_no_vendor_device[RW]
The pool-wide policy for clients on whether to use the vendor device or not on newly created VMs. This field will also be consulted if the 'has_vendor_device' field is not specified in the VM.create call.
Default value:
false
Published in:
XenServer 7.0 (dundee)
The pool-wide policy for clients on whether to use the vendor device or not on newly created VMs. This field will also be consulted if the 'has_vendor_device' field is not specified in the VM.create call.
boolredo_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 refredo_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 setrepositories[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 refrepository_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
stringrepository_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
stringrepository_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) maprestrictions[RO/runtime]
Pool-wide restrictions currently in effect
Default value:
{}
Published in:
XenServer 5.6 (midnight-ride)
Pool-wide restrictions currently in effect
SR refsuspend_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
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
voidcertificate_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
voidcertificate_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 setcheck_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)
voidconfigure_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
voidconfigure_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)
blob refcreate_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
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.
voidcrl_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 setcrl_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.
voidcrl_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.
voiddeconfigure_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
voiddesignate_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.
voiddetect_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
voiddisable_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)
voiddisable_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
voiddisable_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
voiddisable_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
voiddisable_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.
voiddisable_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
voiddisable_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
voideject(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
voidemergency_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
voidemergency_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
voidenable_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)
voidenable_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
voidenable_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
voidenable_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
voidenable_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
voidenable_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
voidenable_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 setget_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) mapget_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 setget_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) mapget_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 refget_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
boolget_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)
stringget_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)
boolget_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) mapget_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 refget_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) mapget_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
stringget_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 refget_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
intget_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) mapget_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
(string → string) mapget_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
boolget_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.
stringget_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) mapget_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
boolget_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
intget_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
boolget_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
intget_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 setget_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) mapget_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
boolget_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.
boolget_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
datetimeget_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) mapget_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
boolget_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
intget_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 refget_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 setget_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
boolget_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)
stringget_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
stringget_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) mapget_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
boolget_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)
The pool-wide policy for clients on whether to use the vendor device or not on newly created VMs. This field will also be consulted if the 'has_vendor_device' field is not specified in the VM.create call.
pool recordget_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
boolget_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 refget_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 setget_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 refget_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
stringget_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
stringget_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) mapget_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 refget_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 setget_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_frequencyget_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
datetimeget_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 refget_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)
boolget_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)
stringget_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
intget_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
boolget_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_frequencyget_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)
stringget_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
stringget_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.
boolget_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
stringget_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
stringget_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
boolget_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
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
boolha_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
voidha_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
boolhas_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
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
voidset_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
voidset_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
voidset_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)
voidset_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
voidset_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)
voidset_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
voidset_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.
voidset_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
voidset_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
voidset_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)
voidset_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.
voidset_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
voidset_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
voidset_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
voidset_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)
voidset_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
voidset_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
voidset_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
voidset_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)
The pool-wide policy for clients on whether to use the vendor device or not on newly created VMs. This field will also be consulted if the 'has_vendor_device' field is not specified in the VM.create call.
voidset_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
voidset_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
voidset_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
voidset_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
voidset_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
voidset_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
voidset_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.
voidset_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
voidset_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
voidsync_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
stringsync_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
stringtest_archive_target(session ref, pool ref, (string → string) map)