Package com.xensource.xenapi
Class Pool
java.lang.Object
com.xensource.xenapi.XenAPIObject
com.xensource.xenapi.Pool
Pool-wide information
First published in XenServer 4.0.
- Author:
- Cloud Software Group, Inc.
-
Nested Class Summary
Nested Classes -
Field Summary
Fields -
Method Summary
Modifier and TypeMethodDescriptionvoid
addRepository
(Connection c, Repository value) Add a repository to the enabled set Minimum allowed role: pool-operator First published in 1.301.0.addRepositoryAsync
(Connection c, Repository value) Add a repository to the enabled set Minimum allowed role: pool-operator First published in 1.301.0.void
addTags
(Connection c, String value) Add the given value to the tags field of the given pool.void
addToGuestAgentConfig
(Connection c, String key, String value) Add a key-value pair to the pool-wide guest agent configuration Minimum allowed role: pool-admin First published in XenServer 7.0.addToGuestAgentConfigAsync
(Connection c, String key, String value) Add a key-value pair to the pool-wide guest agent configuration Minimum allowed role: pool-admin First published in XenServer 7.0.void
addToGuiConfig
(Connection c, String key, String value) Add the given key-value pair to the gui_config field of the given pool.void
addToHealthCheckConfig
(Connection c, String key, String value) Add the given key-value pair to the health_check_config field of the given pool.void
addToOtherConfig
(Connection c, String key, String value) Add the given key-value pair to the other_config field of the given pool.void
applyEdition
(Connection c, String edition) Apply an edition to all hosts in the pool Minimum allowed role: pool-operator First published in XenServer 6.2.applyEditionAsync
(Connection c, String edition) Apply an edition to all hosts in the pool Minimum allowed role: pool-operator First published in XenServer 6.2.static void
certificateInstall
(Connection c, String name, String cert) Deprecated.since 1.290.0static Task
certificateInstallAsync
(Connection c, String name, String cert) Deprecated.since 1.290.0Deprecated.since 1.290.0static Task
Deprecated.since 1.290.0static void
Copy the TLS CA certificates and CRLs of the master to all slaves.static Task
Copy the TLS CA certificates and CRLs of the master to all slaves.static void
certificateUninstall
(Connection c, String name) Deprecated.since 1.290.0static Task
certificateUninstallAsync
(Connection c, String name) Deprecated.since 1.290.0checkUpdateReadiness
(Connection c, Boolean requiresReboot) Check if the pool is ready to be updated.checkUpdateReadinessAsync
(Connection c, Boolean requiresReboot) Check if the pool is ready to be updated.void
configureRepositoryProxy
(Connection c, String url, String username, String password) Configure proxy for RPM package repositories.configureRepositoryProxyAsync
(Connection c, String url, String username, String password) Configure proxy for RPM package repositories.void
configureUpdateSync
(Connection c, Types.UpdateSyncFrequency updateSyncFrequency, Long updateSyncDay) Configure periodic update synchronization to sync updates from a remote CDN Minimum allowed role: pool-operator Experimental.configureUpdateSyncAsync
(Connection c, Types.UpdateSyncFrequency updateSyncFrequency, Long updateSyncDay) Configure periodic update synchronization to sync updates from a remote CDN Minimum allowed role: pool-operator Experimental.createNewBlob
(Connection c, String name, String mimeType) Create a placeholder for a named binary blob of data that is associated with this pool Minimum allowed role: pool-operator First published in XenServer 5.0.createNewBlob
(Connection c, String name, String mimeType, Boolean _public) Create a placeholder for a named binary blob of data that is associated with this pool Minimum allowed role: pool-operator First published in XenServer 5.0.createNewBlobAsync
(Connection c, String name, String mimeType) Create a placeholder for a named binary blob of data that is associated with this pool Minimum allowed role: pool-operator First published in XenServer 5.0.createNewBlobAsync
(Connection c, String name, String mimeType, Boolean _public) Create a placeholder for a named binary blob of data that is associated with this pool Minimum allowed role: pool-operator First published in XenServer 5.0.createVLAN
(Connection c, String device, Network network, Long VLAN) Create PIFs, mapping a network to the same physical interface/VLAN on each host.static Task
createVLANAsync
(Connection c, String device, Network network, Long VLAN) Create PIFs, mapping a network to the same physical interface/VLAN on each host.createVLANFromPIF
(Connection c, PIF pif, Network network, Long VLAN) Create a pool-wide VLAN by taking the PIF.static Task
createVLANFromPIFAsync
(Connection c, PIF pif, Network network, Long VLAN) Create a pool-wide VLAN by taking the PIF.static void
crlInstall
(Connection c, String name, String cert) Install a TLS CA-issued Certificate Revocation List, pool-wide.static Task
crlInstallAsync
(Connection c, String name, String cert) Install a TLS CA-issued Certificate Revocation List, pool-wide.List the names of all installed TLS CA-issued Certificate Revocation Lists.static Task
List the names of all installed TLS CA-issued Certificate Revocation Lists.static void
crlUninstall
(Connection c, String name) Remove a pool-wide TLS CA-issued Certificate Revocation List.static Task
crlUninstallAsync
(Connection c, String name) Remove a pool-wide TLS CA-issued Certificate Revocation List.static void
Permanently deconfigures workload balancing monitoring on this pool Minimum allowed role: pool-operator First published in XenServer 5.5.static Task
Permanently deconfigures workload balancing monitoring on this pool Minimum allowed role: pool-operator First published in XenServer 5.5.static void
designateNewMaster
(Connection c, Host host) Perform an orderly handover of the role of master to the referenced host.static Task
designateNewMasterAsync
(Connection c, Host host) Perform an orderly handover of the role of master to the referenced host.void
This call asynchronously detects if the external authentication configuration in any slave is different from that in the master and raises appropriate alerts Minimum allowed role: pool-operator First published in XenServer 5.5.void
Disable client certificate authentication on the pool Minimum allowed role: pool-operator First published in 1.318.0.Disable client certificate authentication on the pool Minimum allowed role: pool-operator First published in 1.318.0.void
disableExternalAuth
(Connection c, Map<String, String> config) This call disables external authentication on all the hosts of the pool Minimum allowed role: pool-admin First published in XenServer 5.5.static void
Turn off High Availability mode Minimum allowed role: pool-operator First published in XenServer 4.1.static Task
Turn off High Availability mode Minimum allowed role: pool-operator First published in XenServer 4.1.void
This call disables pool-wide local storage caching Minimum allowed role: pool-operator First published in XenServer 5.6 FP1.This call disables pool-wide local storage caching Minimum allowed role: pool-operator First published in XenServer 5.6 FP1.static void
Disable the redo log if in use, unless HA is enabled.static Task
Disable the redo log if in use, unless HA is enabled.void
Disable the proxy for RPM package repositories.Disable the proxy for RPM package repositories.void
Deprecated.since Citrix Hypervisor 8.2Deprecated.since Citrix Hypervisor 8.2static void
eject
(Connection c, Host host) Instruct a pool master to eject a host from the pool Minimum allowed role: pool-operator First published in XenServer 4.0.static Task
ejectAsync
(Connection c, Host host) Instruct a pool master to eject a host from the pool Minimum allowed role: pool-operator First published in XenServer 4.0.static void
emergencyResetMaster
(Connection c, String masterAddress) Instruct a slave already in a pool that the master has changed Minimum allowed role: pool-operator First published in XenServer 4.0.static void
Instruct host that's currently a slave to transition to being master Minimum allowed role: pool-operator First published in XenServer 4.0.void
enableClientCertificateAuth
(Connection c, String name) Enable client certificate authentication on the pool Minimum allowed role: pool-operator First published in 1.318.0.Enable client certificate authentication on the pool Minimum allowed role: pool-operator First published in 1.318.0.void
enableExternalAuth
(Connection c, Map<String, String> config, String serviceName, String authType) This call enables external authentication on all the hosts of the pool Minimum allowed role: pool-admin First published in XenServer 5.5.static void
Turn on High Availability mode Minimum allowed role: pool-operator First published in XenServer 4.1.static Task
enableHaAsync
(Connection c, Set<SR> heartbeatSrs, Map<String, String> configuration) Turn on High Availability mode Minimum allowed role: pool-operator First published in XenServer 4.1.void
This call attempts to enable pool-wide local storage caching Minimum allowed role: pool-operator First published in XenServer 5.6 FP1.This call attempts to enable pool-wide local storage caching Minimum allowed role: pool-operator First published in XenServer 5.6 FP1.static void
enableRedoLog
(Connection c, SR sr) Enable the redo log on the given SR and start using it, unless HA is enabled.static Task
enableRedoLogAsync
(Connection c, SR sr) Enable the redo log on the given SR and start using it, unless HA is enabled.void
Deprecated.since XenServer 7.0Deprecated.since XenServer 7.0static void
Enable TLS server certificate verification Minimum allowed role: pool-admin First published in 1.290.0.boolean
If obj is a Pool, compares XenAPI references for equality.getAll
(Connection c) Return a list of all the pools known to the system.Get the allowed_operations field of the given pool.static Map<Pool,
Pool.Record> Return a map of pool references to pool records for all pools known to the system.Get the blobs field of the given pool.static Pool
getByUuid
(Connection c, String uuid) Get a reference to the pool instance with the specified UUID.Get the client_certificate_auth_enabled field of the given pool.Get the client_certificate_auth_name field of the given pool.Get the coordinator_bias field of the given pool.Get the cpu_info field of the given pool.Get the crash_dump_SR field of the given pool.Get the current_operations field of the given pool.Get the custom_uefi_certificates field of the given pool.Get the default_SR field of the given pool.Get the ext_auth_cache_enabled field of the given pool.Get the ext_auth_cache_expiry field of the given pool.Get the ext_auth_cache_size field of the given pool.Get the ext_auth_max_threads field of the given pool.Get the guest_agent_config field of the given pool.Minimum allowed role: pool-operator Experimental.Get the gui_config field of the given pool.Get the ha_allow_overcommit field of the given pool.Get the ha_cluster_stack field of the given pool.Get the ha_configuration field of the given pool.Get the ha_enabled field of the given pool.Get the ha_host_failures_to_tolerate field of the given pool.Get the ha_overcommitted field of the given pool.Get the ha_plan_exists_for field of the given pool.Get the ha_statefiles field of the given pool.Get the health_check_config field of the given pool.Get the igmp_snooping_enabled field of the given pool.Get the is_psr_pending field of the given pool.Get the last_update_sync field of the given pool.This call returns the license state for the pool Minimum allowed role: read-only First published in XenServer 6.2.This call returns the license state for the pool Minimum allowed role: read-only First published in XenServer 6.2.Get the live_patching_disabled field of the given pool.Get the local_auth_max_threads field of the given pool.Get the master field of the given pool.Get the metadata_VDIs field of the given pool.Get the migration_compression field of the given pool.Get the name_description field of the given pool.Get the name_label field of the given pool.Get the other_config field of the given pool.Deprecated.since 24.14.0Get the recommendations field of the given pool.Get a record containing the current state of the given pool.Get the redo_log_enabled field of the given pool.Get the redo_log_vdi field of the given pool.Get the repositories field of the given pool.Get the repository_proxy_password field of the given pool.Get the repository_proxy_url field of the given pool.Get the repository_proxy_username field of the given pool.Get the restrictions field of the given pool.Get the suspend_image_SR field of the given pool.Get the tags field of the given pool.Get the telemetry_frequency field of the given pool.Get the telemetry_next_collection field of the given pool.Get the telemetry_uuid field of the given pool.Get the tls_verification_enabled field of the given pool.Get the uefi_certificates field of the given pool.Get the update_sync_day field of the given pool.Get the update_sync_enabled field of the given pool.Get the update_sync_frequency field of the given pool.Get the uuid field of the given pool.Deprecated.since XenServer 7.2Get the wlb_enabled field of the given pool.Get the wlb_url field of the given pool.Get the wlb_username field of the given pool.Deprecated.since 1.290.0static Long
haComputeHypotheticalMaxHostFailuresToTolerate
(Connection c, Map<VM, String> configuration) Returns the maximum number of host failures we could tolerate before we would be unable to restart the provided VMs Minimum allowed role: read-only First published in XenServer 5.0.static Long
Returns the maximum number of host failures we could tolerate before we would be unable to restart configured VMs Minimum allowed role: pool-operator First published in XenServer 5.0.haComputeVmFailoverPlan
(Connection c, Set<Host> failedHosts, Set<VM> failedVms) Return a VM failover plan assuming a given subset of hosts fail Minimum allowed role: pool-operator First published in XenServer 5.0.static Boolean
Returns true if a VM failover plan exists for up to 'n' host failures Minimum allowed role: pool-operator First published in XenServer 5.0.static void
haPreventRestartsFor
(Connection c, Long seconds) When this call returns the VM restart logic will not run for the requested number of seconds.hasExtension
(Connection c, String name) Return true if the extension is available on the pool Minimum allowed role: pool-admin First published in XenServer 7.0.hasExtensionAsync
(Connection c, String name) Return true if the extension is available on the pool Minimum allowed role: pool-admin First published in XenServer 7.0.int
hashCode()
static void
initializeWlb
(Connection c, String wlbUrl, String wlbUsername, String wlbPassword, String xenserverUsername, String xenserverPassword) Initializes workload balancing monitoring on this pool with the specified wlb server Minimum allowed role: pool-operator First published in XenServer 5.5.static Task
initializeWlbAsync
(Connection c, String wlbUrl, String wlbUsername, String wlbPassword, String xenserverUsername, String xenserverPassword) Initializes workload balancing monitoring on this pool with the specified wlb server Minimum allowed role: pool-operator First published in XenServer 5.5.static void
installCaCertificate
(Connection c, String name, String cert) Install a TLS CA certificate, pool-wide.static Task
installCaCertificateAsync
(Connection c, String name, String cert) Install a TLS CA certificate, pool-wide.static void
join
(Connection c, String masterAddress, String masterUsername, String masterPassword) Instruct host to join a new pool Minimum allowed role: pool-operator First published in XenServer 4.0.static Task
joinAsync
(Connection c, String masterAddress, String masterUsername, String masterPassword) Instruct host to join a new pool Minimum allowed role: pool-operator First published in XenServer 4.0.static void
joinForce
(Connection c, String masterAddress, String masterUsername, String masterPassword) Instruct host to join a new pool Minimum allowed role: pool-operator First published in XenServer 4.0.static Task
joinForceAsync
(Connection c, String masterAddress, String masterUsername, String masterPassword) Instruct host to join a new pool Minimum allowed role: pool-operator First published in XenServer 4.0.static void
managementReconfigure
(Connection c, Network network) Reconfigure the management network interface for all Hosts in the Pool Minimum allowed role: pool-operator First published in XenServer 7.3.static Task
managementReconfigureAsync
(Connection c, Network network) Reconfigure the management network interface for all Hosts in the Pool Minimum allowed role: pool-operator First published in XenServer 7.3.Instruct a pool master, M, to try and contact its slaves and, if slaves are in emergency mode, reset their master address to M.static Task
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 a key-value pair from the pool-wide guest agent configuration Minimum allowed role: pool-admin First published in XenServer 7.0.Remove a key-value pair from the pool-wide guest agent configuration Minimum allowed role: pool-admin First published in XenServer 7.0.void
removeFromGuiConfig
(Connection c, String key) Remove the given key and its corresponding value from the gui_config field of the given pool.void
Remove the given key and its corresponding value from the health_check_config field of the given pool.void
removeFromOtherConfig
(Connection c, String key) Remove the given key and its corresponding value from the other_config field of the given pool.void
removeRepository
(Connection c, Repository value) Remove a repository from the enabled set Minimum allowed role: pool-operator First published in 1.301.0.removeRepositoryAsync
(Connection c, Repository value) Remove a repository from the enabled set Minimum allowed role: pool-operator First published in 1.301.0.void
removeTags
(Connection c, String value) Remove the given value from the tags field of the given pool.void
Assign a new UUID to telemetry data.Assign a new UUID to telemetry data.Retrieves the pool optimization criteria from the workload balancing server Minimum allowed role: read-only First published in XenServer 5.5.static Task
Retrieves the pool optimization criteria from the workload balancing server Minimum allowed role: read-only First published in XenServer 5.5.Retrieves vm migrate recommendations for the pool from the workload balancing server Minimum allowed role: read-only First published in XenServer 5.5.static Task
Retrieves vm migrate recommendations for the pool from the workload balancing server Minimum allowed role: read-only First published in XenServer 5.5.static void
Minimum allowed role: pool-admin First published in Citrix Hypervisor 8.2 Hotfix 2.static Task
Minimum allowed role: pool-admin First published in Citrix Hypervisor 8.2 Hotfix 2.static String
sendTestPost
(Connection c, String host, Long port, String body) Send the given body to the given host and port, using HTTPS, and print the response.static Task
sendTestPostAsync
(Connection c, String host, Long port, String body) Send the given body to the given host and port, using HTTPS, and print the response.static void
sendWlbConfiguration
(Connection c, Map<String, String> config) Sets the pool optimization criteria for the workload balancing server Minimum allowed role: pool-operator First published in XenServer 5.5.static Task
sendWlbConfigurationAsync
(Connection c, Map<String, String> config) Sets the pool optimization criteria for the workload balancing server Minimum allowed role: pool-operator First published in XenServer 5.5.void
setCoordinatorBias
(Connection c, Boolean coordinatorBias) Set the coordinator_bias field of the given pool.void
setCrashDumpSR
(Connection c, SR crashDumpSR) Set the crash_dump_SR field of the given pool.void
setCustomUefiCertificates
(Connection c, String value) Set custom UEFI certificates for a pool and all its hosts.setCustomUefiCertificatesAsync
(Connection c, String value) Set custom UEFI certificates for a pool and all its hosts.void
setDefaultSR
(Connection c, SR defaultSR) Set the default_SR field of the given pool.void
setExtAuthMaxThreads
(Connection c, Long value) Minimum allowed role: pool-operator Experimental.void
setGuiConfig
(Connection c, Map<String, String> guiConfig) Set the gui_config field of the given pool.void
setHaAllowOvercommit
(Connection c, Boolean haAllowOvercommit) Set the ha_allow_overcommit field of the given pool.void
setHaHostFailuresToTolerate
(Connection c, Long value) Set the maximum number of host failures to consider in the HA VM restart planner Minimum allowed role: pool-operator First published in XenServer 5.0.setHaHostFailuresToTolerateAsync
(Connection c, Long value) Set the maximum number of host failures to consider in the HA VM restart planner Minimum allowed role: pool-operator First published in XenServer 5.0.void
setHealthCheckConfig
(Connection c, Map<String, String> healthCheckConfig) Set the health_check_config field of the given pool.void
setHttpsOnly
(Connection c, Boolean value) updates all the host firewalls in the pool to open or close port 80 depending on the value Minimum allowed role: pool-operator Experimental.setHttpsOnlyAsync
(Connection c, Boolean value) updates all the host firewalls in the pool to open or close port 80 depending on the value Minimum allowed role: pool-operator Experimental.void
setIgmpSnoopingEnabled
(Connection c, Boolean value) Enable or disable IGMP Snooping on the pool.setIgmpSnoopingEnabledAsync
(Connection c, Boolean value) Enable or disable IGMP Snooping on the pool.void
setIsPsrPending
(Connection c, Boolean isPsrPending) Set the is_psr_pending field of the given pool.void
setLivePatchingDisabled
(Connection c, Boolean livePatchingDisabled) Set the live_patching_disabled field of the given pool.void
setLocalAuthMaxThreads
(Connection c, Long value) Minimum allowed role: pool-operator Experimental.void
setMigrationCompression
(Connection c, Boolean migrationCompression) Set the migration_compression field of the given pool.void
setNameDescription
(Connection c, String nameDescription) Set the name_description field of the given pool.void
setNameLabel
(Connection c, String nameLabel) Set the name_label field of the given pool.void
setOtherConfig
(Connection c, Map<String, String> otherConfig) Set the other_config field of the given pool.void
setPolicyNoVendorDevice
(Connection c, Boolean policyNoVendorDevice) Deprecated.since 24.14.0void
setRepositories
(Connection c, Set<Repository> value) Set enabled set of repositories Minimum allowed role: pool-operator First published in 1.301.0.setRepositoriesAsync
(Connection c, Set<Repository> value) Set enabled set of repositories Minimum allowed role: pool-operator First published in 1.301.0.void
setSuspendImageSR
(Connection c, SR suspendImageSR) Set the suspend_image_SR field of the given pool.void
setTags
(Connection c, Set<String> tags) Set the tags field of the given pool.void
setTelemetryNextCollection
(Connection c, Date value) Set the timestamp for the next telemetry data collection.setTelemetryNextCollectionAsync
(Connection c, Date value) Set the timestamp for the next telemetry data collection.void
setUefiCertificates
(Connection c, String value) Deprecated.since 24.0.0setUefiCertificatesAsync
(Connection c, String value) Deprecated.since 24.0.0void
setUpdateSyncEnabled
(Connection c, Boolean value) enable or disable periodic update synchronization depending on the value Minimum allowed role: pool-operator Experimental.setUpdateSyncEnabledAsync
(Connection c, Boolean value) enable or disable periodic update synchronization depending on the value Minimum allowed role: pool-operator Experimental.static void
setVswitchController
(Connection c, String address) Deprecated.since XenServer 7.2static Task
setVswitchControllerAsync
(Connection c, String address) Deprecated.since XenServer 7.2void
setWlbEnabled
(Connection c, Boolean wlbEnabled) Set the wlb_enabled field of the given pool.void
setWlbVerifyCert
(Connection c, Boolean wlbVerifyCert) Deprecated.since 1.290.0static void
Forcibly synchronise the database now Minimum allowed role: pool-operator First published in XenServer 4.0.static Task
Forcibly synchronise the database now Minimum allowed role: pool-operator First published in XenServer 4.0.syncUpdates
(Connection c, Boolean force, String token, String tokenId) Sync with the enabled repository Minimum allowed role: pool-operator First published in 1.329.0.syncUpdatesAsync
(Connection c, Boolean force, String token, String tokenId) Sync with the enabled repository Minimum allowed role: pool-operator First published in 1.329.0.testArchiveTarget
(Connection c, Map<String, String> config) This call tests if a location is valid Minimum allowed role: pool-operator First published in XenServer 5.6 FP1.static void
uninstallCaCertificate
(Connection c, String name) Remove a pool-wide TLS CA certificate.static Task
uninstallCaCertificateAsync
(Connection c, String name) Remove a pool-wide TLS CA certificate.Methods inherited from class com.xensource.xenapi.XenAPIObject
isNull
-
Field Details
-
ref
The XenAPI reference (OpaqueRef) to this object.
-
-
Method Details
-
toWireString
- Specified by:
toWireString
in classXenAPIObject
- Returns:
- The XenAPI reference (OpaqueRef) to this object.
-
equals
If obj is a Pool, compares XenAPI references for equality. -
hashCode
public int hashCode() -
getRecord
public Pool.Record getRecord(Connection c) throws Types.BadServerResponse, Types.XenAPIException, IOException Get a record containing the current state of the given pool. Minimum allowed role: read-only First published in XenServer 4.0.- Parameters:
c
- The connection the call is made on- Returns:
- all fields from the object
- Throws:
Types.BadServerResponse
- Thrown if the response from the server contains an invalid status.Types.XenAPIException
- if the call failed.IOException
- if an error occurs during a send or receive. This includes cases where a payload is invalid JSON.
-
getByUuid
public static Pool getByUuid(Connection c, String uuid) throws Types.BadServerResponse, Types.XenAPIException, IOException Get a reference to the pool instance with the specified UUID. Minimum allowed role: read-only First published in XenServer 4.0.- Parameters:
c
- The connection the call is made onuuid
- UUID of object to return- Returns:
- reference to the object
- Throws:
Types.BadServerResponse
- Thrown if the response from the server contains an invalid status.Types.XenAPIException
- if the call failed.IOException
- if an error occurs during a send or receive. This includes cases where a payload is invalid JSON.
-
getUuid
public String getUuid(Connection c) throws Types.BadServerResponse, Types.XenAPIException, IOException Get the uuid field of the given pool. Minimum allowed role: read-only First published in XenServer 4.0.- Parameters:
c
- The connection the call is made on- Returns:
- value of the field
- Throws:
Types.BadServerResponse
- Thrown if the response from the server contains an invalid status.Types.XenAPIException
- if the call failed.IOException
- if an error occurs during a send or receive. This includes cases where a payload is invalid JSON.
-
getNameLabel
public String getNameLabel(Connection c) throws Types.BadServerResponse, Types.XenAPIException, IOException Get the name_label field of the given pool. Minimum allowed role: read-only First published in XenServer 4.0.- Parameters:
c
- The connection the call is made on- Returns:
- value of the field
- Throws:
Types.BadServerResponse
- Thrown if the response from the server contains an invalid status.Types.XenAPIException
- if the call failed.IOException
- if an error occurs during a send or receive. This includes cases where a payload is invalid JSON.
-
getNameDescription
public String getNameDescription(Connection c) throws Types.BadServerResponse, Types.XenAPIException, IOException Get the name_description field of the given pool. Minimum allowed role: read-only First published in XenServer 4.0.- Parameters:
c
- The connection the call is made on- Returns:
- value of the field
- Throws:
Types.BadServerResponse
- Thrown if the response from the server contains an invalid status.Types.XenAPIException
- if the call failed.IOException
- if an error occurs during a send or receive. This includes cases where a payload is invalid JSON.
-
getMaster
public Host getMaster(Connection c) throws Types.BadServerResponse, Types.XenAPIException, IOException Get the master field of the given pool. Minimum allowed role: read-only First published in XenServer 4.0.- Parameters:
c
- The connection the call is made on- Returns:
- value of the field
- Throws:
Types.BadServerResponse
- Thrown if the response from the server contains an invalid status.Types.XenAPIException
- if the call failed.IOException
- if an error occurs during a send or receive. This includes cases where a payload is invalid JSON.
-
getDefaultSR
public SR getDefaultSR(Connection c) throws Types.BadServerResponse, Types.XenAPIException, IOException Get the default_SR field of the given pool. Minimum allowed role: read-only First published in XenServer 4.0.- Parameters:
c
- The connection the call is made on- Returns:
- value of the field
- Throws:
Types.BadServerResponse
- Thrown if the response from the server contains an invalid status.Types.XenAPIException
- if the call failed.IOException
- if an error occurs during a send or receive. This includes cases where a payload is invalid JSON.
-
getSuspendImageSR
public SR getSuspendImageSR(Connection c) throws Types.BadServerResponse, Types.XenAPIException, IOException Get the suspend_image_SR field of the given pool. Minimum allowed role: read-only First published in XenServer 4.0.- Parameters:
c
- The connection the call is made on- Returns:
- value of the field
- Throws:
Types.BadServerResponse
- Thrown if the response from the server contains an invalid status.Types.XenAPIException
- if the call failed.IOException
- if an error occurs during a send or receive. This includes cases where a payload is invalid JSON.
-
getCrashDumpSR
public SR getCrashDumpSR(Connection c) throws Types.BadServerResponse, Types.XenAPIException, IOException Get the crash_dump_SR field of the given pool. Minimum allowed role: read-only First published in XenServer 4.0.- Parameters:
c
- The connection the call is made on- Returns:
- value of the field
- Throws:
Types.BadServerResponse
- Thrown if the response from the server contains an invalid status.Types.XenAPIException
- if the call failed.IOException
- if an error occurs during a send or receive. This includes cases where a payload is invalid JSON.
-
getOtherConfig
public Map<String,String> getOtherConfig(Connection c) throws Types.BadServerResponse, Types.XenAPIException, IOException Get the other_config field of the given pool. Minimum allowed role: read-only First published in XenServer 4.0.- Parameters:
c
- The connection the call is made on- Returns:
- value of the field
- Throws:
Types.BadServerResponse
- Thrown if the response from the server contains an invalid status.Types.XenAPIException
- if the call failed.IOException
- if an error occurs during a send or receive. This includes cases where a payload is invalid JSON.
-
getHaEnabled
public Boolean getHaEnabled(Connection c) throws Types.BadServerResponse, Types.XenAPIException, IOException Get the ha_enabled field of the given pool. Minimum allowed role: read-only First published in XenServer 5.0.- Parameters:
c
- The connection the call is made on- Returns:
- value of the field
- Throws:
Types.BadServerResponse
- Thrown if the response from the server contains an invalid status.Types.XenAPIException
- if the call failed.IOException
- if an error occurs during a send or receive. This includes cases where a payload is invalid JSON.
-
getHaConfiguration
public Map<String,String> getHaConfiguration(Connection c) throws Types.BadServerResponse, Types.XenAPIException, IOException Get the ha_configuration field of the given pool. Minimum allowed role: read-only First published in XenServer 5.0.- Parameters:
c
- The connection the call is made on- Returns:
- value of the field
- Throws:
Types.BadServerResponse
- Thrown if the response from the server contains an invalid status.Types.XenAPIException
- if the call failed.IOException
- if an error occurs during a send or receive. This includes cases where a payload is invalid JSON.
-
getHaStatefiles
public Set<String> getHaStatefiles(Connection c) throws Types.BadServerResponse, Types.XenAPIException, IOException Get the ha_statefiles field of the given pool. Minimum allowed role: read-only First published in XenServer 5.0.- Parameters:
c
- The connection the call is made on- Returns:
- value of the field
- Throws:
Types.BadServerResponse
- Thrown if the response from the server contains an invalid status.Types.XenAPIException
- if the call failed.IOException
- if an error occurs during a send or receive. This includes cases where a payload is invalid JSON.
-
getHaHostFailuresToTolerate
public Long getHaHostFailuresToTolerate(Connection c) throws Types.BadServerResponse, Types.XenAPIException, IOException Get the ha_host_failures_to_tolerate field of the given pool. Minimum allowed role: read-only First published in XenServer 5.0.- Parameters:
c
- The connection the call is made on- Returns:
- value of the field
- Throws:
Types.BadServerResponse
- Thrown if the response from the server contains an invalid status.Types.XenAPIException
- if the call failed.IOException
- if an error occurs during a send or receive. This includes cases where a payload is invalid JSON.
-
getHaPlanExistsFor
public Long getHaPlanExistsFor(Connection c) throws Types.BadServerResponse, Types.XenAPIException, IOException Get the ha_plan_exists_for field of the given pool. Minimum allowed role: read-only First published in XenServer 5.0.- Parameters:
c
- The connection the call is made on- Returns:
- value of the field
- Throws:
Types.BadServerResponse
- Thrown if the response from the server contains an invalid status.Types.XenAPIException
- if the call failed.IOException
- if an error occurs during a send or receive. This includes cases where a payload is invalid JSON.
-
getHaAllowOvercommit
public Boolean getHaAllowOvercommit(Connection c) throws Types.BadServerResponse, Types.XenAPIException, IOException Get the ha_allow_overcommit field of the given pool. Minimum allowed role: read-only First published in XenServer 5.0.- Parameters:
c
- The connection the call is made on- Returns:
- value of the field
- Throws:
Types.BadServerResponse
- Thrown if the response from the server contains an invalid status.Types.XenAPIException
- if the call failed.IOException
- if an error occurs during a send or receive. This includes cases where a payload is invalid JSON.
-
getHaOvercommitted
public Boolean getHaOvercommitted(Connection c) throws Types.BadServerResponse, Types.XenAPIException, IOException Get the ha_overcommitted field of the given pool. Minimum allowed role: read-only First published in XenServer 5.0.- Parameters:
c
- The connection the call is made on- Returns:
- value of the field
- Throws:
Types.BadServerResponse
- Thrown if the response from the server contains an invalid status.Types.XenAPIException
- if the call failed.IOException
- if an error occurs during a send or receive. This includes cases where a payload is invalid JSON.
-
getBlobs
public Map<String,Blob> getBlobs(Connection c) throws Types.BadServerResponse, Types.XenAPIException, IOException Get the blobs field of the given pool. Minimum allowed role: read-only First published in XenServer 5.0.- Parameters:
c
- The connection the call is made on- Returns:
- value of the field
- Throws:
Types.BadServerResponse
- Thrown if the response from the server contains an invalid status.Types.XenAPIException
- if the call failed.IOException
- if an error occurs during a send or receive. This includes cases where a payload is invalid JSON.
-
getTags
public Set<String> getTags(Connection c) throws Types.BadServerResponse, Types.XenAPIException, IOException Get the tags field of the given pool. Minimum allowed role: read-only First published in XenServer 5.0.- Parameters:
c
- The connection the call is made on- Returns:
- value of the field
- Throws:
Types.BadServerResponse
- Thrown if the response from the server contains an invalid status.Types.XenAPIException
- if the call failed.IOException
- if an error occurs during a send or receive. This includes cases where a payload is invalid JSON.
-
getGuiConfig
public Map<String,String> getGuiConfig(Connection c) throws Types.BadServerResponse, Types.XenAPIException, IOException Get the gui_config field of the given pool. Minimum allowed role: read-only First published in XenServer 5.0.- Parameters:
c
- The connection the call is made on- Returns:
- value of the field
- Throws:
Types.BadServerResponse
- Thrown if the response from the server contains an invalid status.Types.XenAPIException
- if the call failed.IOException
- if an error occurs during a send or receive. This includes cases where a payload is invalid JSON.
-
getHealthCheckConfig
public Map<String,String> getHealthCheckConfig(Connection c) throws Types.BadServerResponse, Types.XenAPIException, IOException Get the health_check_config field of the given pool. Minimum allowed role: read-only First published in XenServer 7.0.- Parameters:
c
- The connection the call is made on- Returns:
- value of the field
- Throws:
Types.BadServerResponse
- Thrown if the response from the server contains an invalid status.Types.XenAPIException
- if the call failed.IOException
- if an error occurs during a send or receive. This includes cases where a payload is invalid JSON.
-
getWlbUrl
public String getWlbUrl(Connection c) throws Types.BadServerResponse, Types.XenAPIException, IOException Get the wlb_url field of the given pool. Minimum allowed role: read-only First published in XenServer 5.5.- Parameters:
c
- The connection the call is made on- Returns:
- value of the field
- Throws:
Types.BadServerResponse
- Thrown if the response from the server contains an invalid status.Types.XenAPIException
- if the call failed.IOException
- if an error occurs during a send or receive. This includes cases where a payload is invalid JSON.
-
getWlbUsername
public String getWlbUsername(Connection c) throws Types.BadServerResponse, Types.XenAPIException, IOException Get the wlb_username field of the given pool. Minimum allowed role: read-only First published in XenServer 5.5.- Parameters:
c
- The connection the call is made on- Returns:
- value of the field
- Throws:
Types.BadServerResponse
- Thrown if the response from the server contains an invalid status.Types.XenAPIException
- if the call failed.IOException
- if an error occurs during a send or receive. This includes cases where a payload is invalid JSON.
-
getWlbEnabled
public Boolean getWlbEnabled(Connection c) throws Types.BadServerResponse, Types.XenAPIException, IOException Get the wlb_enabled field of the given pool. Minimum allowed role: read-only First published in XenServer 5.5.- Parameters:
c
- The connection the call is made on- Returns:
- value of the field
- Throws:
Types.BadServerResponse
- Thrown if the response from the server contains an invalid status.Types.XenAPIException
- if the call failed.IOException
- if an error occurs during a send or receive. This includes cases where a payload is invalid JSON.
-
getWlbVerifyCert
@Deprecated(since="1.290.0") public Boolean getWlbVerifyCert(Connection c) throws Types.BadServerResponse, Types.XenAPIException, IOException Deprecated.since 1.290.0Get the wlb_verify_cert field of the given pool. Minimum allowed role: read-only First published in XenServer 5.5.- Parameters:
c
- The connection the call is made on- Returns:
- value of the field
- Throws:
Types.BadServerResponse
- Thrown if the response from the server contains an invalid status.Types.XenAPIException
- if the call failed.IOException
- if an error occurs during a send or receive. This includes cases where a payload is invalid JSON.
-
getRedoLogEnabled
public Boolean getRedoLogEnabled(Connection c) throws Types.BadServerResponse, Types.XenAPIException, IOException Get the redo_log_enabled field of the given pool. Minimum allowed role: read-only First published in XenServer 5.6.- Parameters:
c
- The connection the call is made on- Returns:
- value of the field
- Throws:
Types.BadServerResponse
- Thrown if the response from the server contains an invalid status.Types.XenAPIException
- if the call failed.IOException
- if an error occurs during a send or receive. This includes cases where a payload is invalid JSON.
-
getRedoLogVdi
public VDI getRedoLogVdi(Connection c) throws Types.BadServerResponse, Types.XenAPIException, IOException Get the redo_log_vdi field of the given pool. Minimum allowed role: read-only First published in XenServer 5.6.- Parameters:
c
- The connection the call is made on- Returns:
- value of the field
- Throws:
Types.BadServerResponse
- Thrown if the response from the server contains an invalid status.Types.XenAPIException
- if the call failed.IOException
- if an error occurs during a send or receive. This includes cases where a payload is invalid JSON.
-
getVswitchController
@Deprecated(since="XenServer 7.2") public String getVswitchController(Connection c) throws Types.BadServerResponse, Types.XenAPIException, IOException Deprecated.since XenServer 7.2Get the vswitch_controller field of the given pool. Minimum allowed role: read-only First published in XenServer 5.6.- Parameters:
c
- The connection the call is made on- Returns:
- value of the field
- Throws:
Types.BadServerResponse
- Thrown if the response from the server contains an invalid status.Types.XenAPIException
- if the call failed.IOException
- if an error occurs during a send or receive. This includes cases where a payload is invalid JSON.
-
getRestrictions
public Map<String,String> getRestrictions(Connection c) throws Types.BadServerResponse, Types.XenAPIException, IOException Get the restrictions field of the given pool. Minimum allowed role: read-only First published in XenServer 5.6.- Parameters:
c
- The connection the call is made on- Returns:
- value of the field
- Throws:
Types.BadServerResponse
- Thrown if the response from the server contains an invalid status.Types.XenAPIException
- if the call failed.IOException
- if an error occurs during a send or receive. This includes cases where a payload is invalid JSON.
-
getMetadataVDIs
public Set<VDI> getMetadataVDIs(Connection c) throws Types.BadServerResponse, Types.XenAPIException, IOException Get the metadata_VDIs field of the given pool. Minimum allowed role: read-only First published in XenServer 6.0.- Parameters:
c
- The connection the call is made on- Returns:
- value of the field
- Throws:
Types.BadServerResponse
- Thrown if the response from the server contains an invalid status.Types.XenAPIException
- if the call failed.IOException
- if an error occurs during a send or receive. This includes cases where a payload is invalid JSON.
-
getHaClusterStack
public String getHaClusterStack(Connection c) throws Types.BadServerResponse, Types.XenAPIException, IOException Get the ha_cluster_stack field of the given pool. Minimum allowed role: read-only First published in XenServer 7.0.- Parameters:
c
- The connection the call is made on- Returns:
- value of the field
- Throws:
Types.BadServerResponse
- Thrown if the response from the server contains an invalid status.Types.XenAPIException
- if the call failed.IOException
- if an error occurs during a send or receive. This includes cases where a payload is invalid JSON.
-
getAllowedOperations
public Set<Types.PoolAllowedOperations> getAllowedOperations(Connection c) throws Types.BadServerResponse, Types.XenAPIException, IOException Get the allowed_operations field of the given pool. Minimum allowed role: read-only First published in XenServer 4.0.- Parameters:
c
- The connection the call is made on- Returns:
- value of the field
- Throws:
Types.BadServerResponse
- Thrown if the response from the server contains an invalid status.Types.XenAPIException
- if the call failed.IOException
- if an error occurs during a send or receive. This includes cases where a payload is invalid JSON.
-
getCurrentOperations
public Map<String,Types.PoolAllowedOperations> getCurrentOperations(Connection c) throws Types.BadServerResponse, Types.XenAPIException, IOException Get the current_operations field of the given pool. Minimum allowed role: read-only First published in XenServer 4.0.- Parameters:
c
- The connection the call is made on- Returns:
- value of the field
- Throws:
Types.BadServerResponse
- Thrown if the response from the server contains an invalid status.Types.XenAPIException
- if the call failed.IOException
- if an error occurs during a send or receive. This includes cases where a payload is invalid JSON.
-
getGuestAgentConfig
public Map<String,String> getGuestAgentConfig(Connection c) throws Types.BadServerResponse, Types.XenAPIException, IOException Get the guest_agent_config field of the given pool. Minimum allowed role: read-only First published in XenServer 7.0.- Parameters:
c
- The connection the call is made on- Returns:
- value of the field
- Throws:
Types.BadServerResponse
- Thrown if the response from the server contains an invalid status.Types.XenAPIException
- if the call failed.IOException
- if an error occurs during a send or receive. This includes cases where a payload is invalid JSON.
-
getCpuInfo
public Map<String,String> getCpuInfo(Connection c) throws Types.BadServerResponse, Types.XenAPIException, IOException Get the cpu_info field of the given pool. Minimum allowed role: read-only First published in XenServer 7.0.- Parameters:
c
- The connection the call is made on- Returns:
- value of the field
- Throws:
Types.BadServerResponse
- Thrown if the response from the server contains an invalid status.Types.XenAPIException
- if the call failed.IOException
- if an error occurs during a send or receive. This includes cases where a payload is invalid JSON.
-
getPolicyNoVendorDevice
@Deprecated(since="24.14.0") public Boolean getPolicyNoVendorDevice(Connection c) throws Types.BadServerResponse, Types.XenAPIException, IOException Deprecated.since 24.14.0Get the policy_no_vendor_device field of the given pool. Minimum allowed role: read-only First published in XenServer 7.0.- Parameters:
c
- The connection the call is made on- Returns:
- value of the field
- Throws:
Types.BadServerResponse
- Thrown if the response from the server contains an invalid status.Types.XenAPIException
- if the call failed.IOException
- if an error occurs during a send or receive. This includes cases where a payload is invalid JSON.
-
getLivePatchingDisabled
public Boolean getLivePatchingDisabled(Connection c) throws Types.BadServerResponse, Types.XenAPIException, IOException Get the live_patching_disabled field of the given pool. Minimum allowed role: read-only First published in XenServer 7.1.- Parameters:
c
- The connection the call is made on- Returns:
- value of the field
- Throws:
Types.BadServerResponse
- Thrown if the response from the server contains an invalid status.Types.XenAPIException
- if the call failed.IOException
- if an error occurs during a send or receive. This includes cases where a payload is invalid JSON.
-
getIgmpSnoopingEnabled
public Boolean getIgmpSnoopingEnabled(Connection c) throws Types.BadServerResponse, Types.XenAPIException, IOException Get the igmp_snooping_enabled field of the given pool. Minimum allowed role: read-only First published in XenServer 7.3.- Parameters:
c
- The connection the call is made on- Returns:
- value of the field
- Throws:
Types.BadServerResponse
- Thrown if the response from the server contains an invalid status.Types.XenAPIException
- if the call failed.IOException
- if an error occurs during a send or receive. This includes cases where a payload is invalid JSON.
-
getUefiCertificates
public String getUefiCertificates(Connection c) throws Types.BadServerResponse, Types.XenAPIException, IOException Get the uefi_certificates field of the given pool. Minimum allowed role: read-only First published in Citrix Hypervisor 8.1.- Parameters:
c
- The connection the call is made on- Returns:
- value of the field
- Throws:
Types.BadServerResponse
- Thrown if the response from the server contains an invalid status.Types.XenAPIException
- if the call failed.IOException
- if an error occurs during a send or receive. This includes cases where a payload is invalid JSON.
-
getCustomUefiCertificates
public String getCustomUefiCertificates(Connection c) throws Types.BadServerResponse, Types.XenAPIException, IOException Get the custom_uefi_certificates field of the given pool. Minimum allowed role: read-only Experimental. First published in 24.0.0.- Parameters:
c
- The connection the call is made on- Returns:
- value of the field
- Throws:
Types.BadServerResponse
- Thrown if the response from the server contains an invalid status.Types.XenAPIException
- if the call failed.IOException
- if an error occurs during a send or receive. This includes cases where a payload is invalid JSON.
-
getIsPsrPending
public Boolean getIsPsrPending(Connection c) throws Types.BadServerResponse, Types.XenAPIException, IOException Get the is_psr_pending field of the given pool. Minimum allowed role: read-only First published in Citrix Hypervisor 8.2 Hotfix 2.- Parameters:
c
- The connection the call is made on- Returns:
- value of the field
- Throws:
Types.BadServerResponse
- Thrown if the response from the server contains an invalid status.Types.XenAPIException
- if the call failed.IOException
- if an error occurs during a send or receive. This includes cases where a payload is invalid JSON.
-
getTlsVerificationEnabled
public Boolean getTlsVerificationEnabled(Connection c) throws Types.BadServerResponse, Types.XenAPIException, IOException Get the tls_verification_enabled field of the given pool. Minimum allowed role: read-only First published in 1.290.0.- Parameters:
c
- The connection the call is made on- Returns:
- value of the field
- Throws:
Types.BadServerResponse
- Thrown if the response from the server contains an invalid status.Types.XenAPIException
- if the call failed.IOException
- if an error occurs during a send or receive. This includes cases where a payload is invalid JSON.
-
getRepositories
public Set<Repository> getRepositories(Connection c) throws Types.BadServerResponse, Types.XenAPIException, IOException Get the repositories field of the given pool. Minimum allowed role: read-only First published in 1.301.0.- Parameters:
c
- The connection the call is made on- Returns:
- value of the field
- Throws:
Types.BadServerResponse
- Thrown if the response from the server contains an invalid status.Types.XenAPIException
- if the call failed.IOException
- if an error occurs during a send or receive. This includes cases where a payload is invalid JSON.
-
getClientCertificateAuthEnabled
public Boolean getClientCertificateAuthEnabled(Connection c) throws Types.BadServerResponse, Types.XenAPIException, IOException Get the client_certificate_auth_enabled field of the given pool. Minimum allowed role: read-only First published in 1.318.0.- Parameters:
c
- The connection the call is made on- Returns:
- value of the field
- Throws:
Types.BadServerResponse
- Thrown if the response from the server contains an invalid status.Types.XenAPIException
- if the call failed.IOException
- if an error occurs during a send or receive. This includes cases where a payload is invalid JSON.
-
getClientCertificateAuthName
public String getClientCertificateAuthName(Connection c) throws Types.BadServerResponse, Types.XenAPIException, IOException Get the client_certificate_auth_name field of the given pool. Minimum allowed role: read-only First published in 1.318.0.- Parameters:
c
- The connection the call is made on- Returns:
- value of the field
- Throws:
Types.BadServerResponse
- Thrown if the response from the server contains an invalid status.Types.XenAPIException
- if the call failed.IOException
- if an error occurs during a send or receive. This includes cases where a payload is invalid JSON.
-
getRepositoryProxyUrl
public String getRepositoryProxyUrl(Connection c) throws Types.BadServerResponse, Types.XenAPIException, IOException Get the repository_proxy_url field of the given pool. Minimum allowed role: read-only First published in 21.3.0.- Parameters:
c
- The connection the call is made on- Returns:
- value of the field
- Throws:
Types.BadServerResponse
- Thrown if the response from the server contains an invalid status.Types.XenAPIException
- if the call failed.IOException
- if an error occurs during a send or receive. This includes cases where a payload is invalid JSON.
-
getRepositoryProxyUsername
public String getRepositoryProxyUsername(Connection c) throws Types.BadServerResponse, Types.XenAPIException, IOException Get the repository_proxy_username field of the given pool. Minimum allowed role: read-only First published in 21.3.0.- Parameters:
c
- The connection the call is made on- Returns:
- value of the field
- Throws:
Types.BadServerResponse
- Thrown if the response from the server contains an invalid status.Types.XenAPIException
- if the call failed.IOException
- if an error occurs during a send or receive. This includes cases where a payload is invalid JSON.
-
getRepositoryProxyPassword
public Secret getRepositoryProxyPassword(Connection c) throws Types.BadServerResponse, Types.XenAPIException, IOException Get the repository_proxy_password field of the given pool. Minimum allowed role: read-only First published in 21.3.0.- Parameters:
c
- The connection the call is made on- Returns:
- value of the field
- Throws:
Types.BadServerResponse
- Thrown if the response from the server contains an invalid status.Types.XenAPIException
- if the call failed.IOException
- if an error occurs during a send or receive. This includes cases where a payload is invalid JSON.
-
getMigrationCompression
public Boolean getMigrationCompression(Connection c) throws Types.BadServerResponse, Types.XenAPIException, IOException Get the migration_compression field of the given pool. Minimum allowed role: read-only Experimental. First published in 22.33.0.- Parameters:
c
- The connection the call is made on- Returns:
- value of the field
- Throws:
Types.BadServerResponse
- Thrown if the response from the server contains an invalid status.Types.XenAPIException
- if the call failed.IOException
- if an error occurs during a send or receive. This includes cases where a payload is invalid JSON.
-
getCoordinatorBias
public Boolean getCoordinatorBias(Connection c) throws Types.BadServerResponse, Types.XenAPIException, IOException Get the coordinator_bias field of the given pool. Minimum allowed role: read-only First published in XenServer 4.0.- Parameters:
c
- The connection the call is made on- Returns:
- value of the field
- Throws:
Types.BadServerResponse
- Thrown if the response from the server contains an invalid status.Types.XenAPIException
- if the call failed.IOException
- if an error occurs during a send or receive. This includes cases where a payload is invalid JSON.
-
getLocalAuthMaxThreads
public Long getLocalAuthMaxThreads(Connection c) throws Types.BadServerResponse, Types.XenAPIException, IOException Get the local_auth_max_threads field of the given pool. Minimum allowed role: read-only Experimental. First published in 23.27.0.- Parameters:
c
- The connection the call is made on- Returns:
- value of the field
- Throws:
Types.BadServerResponse
- Thrown if the response from the server contains an invalid status.Types.XenAPIException
- if the call failed.IOException
- if an error occurs during a send or receive. This includes cases where a payload is invalid JSON.
-
getExtAuthMaxThreads
public Long getExtAuthMaxThreads(Connection c) throws Types.BadServerResponse, Types.XenAPIException, IOException Get the ext_auth_max_threads field of the given pool. Minimum allowed role: read-only Experimental. First published in 23.27.0.- Parameters:
c
- The connection the call is made on- Returns:
- value of the field
- Throws:
Types.BadServerResponse
- Thrown if the response from the server contains an invalid status.Types.XenAPIException
- if the call failed.IOException
- if an error occurs during a send or receive. This includes cases where a payload is invalid JSON.
-
getExtAuthCacheEnabled
public Boolean getExtAuthCacheEnabled(Connection c) throws Types.BadServerResponse, Types.XenAPIException, IOException Get the ext_auth_cache_enabled field of the given pool. Minimum allowed role: read-only Experimental. First published in 24.32.0.- Parameters:
c
- The connection the call is made on- Returns:
- value of the field
- Throws:
Types.BadServerResponse
- Thrown if the response from the server contains an invalid status.Types.XenAPIException
- if the call failed.IOException
- if an error occurs during a send or receive. This includes cases where a payload is invalid JSON.
-
getExtAuthCacheSize
public Long getExtAuthCacheSize(Connection c) throws Types.BadServerResponse, Types.XenAPIException, IOException Get the ext_auth_cache_size field of the given pool. Minimum allowed role: read-only Experimental. First published in 24.32.0.- Parameters:
c
- The connection the call is made on- Returns:
- value of the field
- Throws:
Types.BadServerResponse
- Thrown if the response from the server contains an invalid status.Types.XenAPIException
- if the call failed.IOException
- if an error occurs during a send or receive. This includes cases where a payload is invalid JSON.
-
getExtAuthCacheExpiry
public Long getExtAuthCacheExpiry(Connection c) throws Types.BadServerResponse, Types.XenAPIException, IOException Get the ext_auth_cache_expiry field of the given pool. Minimum allowed role: read-only Experimental. First published in 24.32.0.- Parameters:
c
- The connection the call is made on- Returns:
- value of the field
- Throws:
Types.BadServerResponse
- Thrown if the response from the server contains an invalid status.Types.XenAPIException
- if the call failed.IOException
- if an error occurs during a send or receive. This includes cases where a payload is invalid JSON.
-
getTelemetryUuid
public Secret getTelemetryUuid(Connection c) throws Types.BadServerResponse, Types.XenAPIException, IOException Get the telemetry_uuid field of the given pool. Minimum allowed role: read-only Experimental. First published in 23.9.0.- Parameters:
c
- The connection the call is made on- Returns:
- value of the field
- Throws:
Types.BadServerResponse
- Thrown if the response from the server contains an invalid status.Types.XenAPIException
- if the call failed.IOException
- if an error occurs during a send or receive. This includes cases where a payload is invalid JSON.
-
getTelemetryFrequency
public Types.TelemetryFrequency getTelemetryFrequency(Connection c) throws Types.BadServerResponse, Types.XenAPIException, IOException Get the telemetry_frequency field of the given pool. Minimum allowed role: read-only Experimental. First published in 23.9.0.- Parameters:
c
- The connection the call is made on- Returns:
- value of the field
- Throws:
Types.BadServerResponse
- Thrown if the response from the server contains an invalid status.Types.XenAPIException
- if the call failed.IOException
- if an error occurs during a send or receive. This includes cases where a payload is invalid JSON.
-
getTelemetryNextCollection
public Date getTelemetryNextCollection(Connection c) throws Types.BadServerResponse, Types.XenAPIException, IOException Get the telemetry_next_collection field of the given pool. Minimum allowed role: read-only Experimental. First published in 23.9.0.- Parameters:
c
- The connection the call is made on- Returns:
- value of the field
- Throws:
Types.BadServerResponse
- Thrown if the response from the server contains an invalid status.Types.XenAPIException
- if the call failed.IOException
- if an error occurs during a send or receive. This includes cases where a payload is invalid JSON.
-
getLastUpdateSync
public Date getLastUpdateSync(Connection c) throws Types.BadServerResponse, Types.XenAPIException, IOException Get the last_update_sync field of the given pool. Minimum allowed role: read-only Experimental. First published in 23.18.0.- Parameters:
c
- The connection the call is made on- Returns:
- value of the field
- Throws:
Types.BadServerResponse
- Thrown if the response from the server contains an invalid status.Types.XenAPIException
- if the call failed.IOException
- if an error occurs during a send or receive. This includes cases where a payload is invalid JSON.
-
getUpdateSyncFrequency
public Types.UpdateSyncFrequency getUpdateSyncFrequency(Connection c) throws Types.BadServerResponse, Types.XenAPIException, IOException Get the update_sync_frequency field of the given pool. Minimum allowed role: read-only Experimental. First published in 23.18.0.- Parameters:
c
- The connection the call is made on- Returns:
- value of the field
- Throws:
Types.BadServerResponse
- Thrown if the response from the server contains an invalid status.Types.XenAPIException
- if the call failed.IOException
- if an error occurs during a send or receive. This includes cases where a payload is invalid JSON.
-
getUpdateSyncDay
public Long getUpdateSyncDay(Connection c) throws Types.BadServerResponse, Types.XenAPIException, IOException Get the update_sync_day field of the given pool. Minimum allowed role: read-only Experimental. First published in 23.18.0.- Parameters:
c
- The connection the call is made on- Returns:
- value of the field
- Throws:
Types.BadServerResponse
- Thrown if the response from the server contains an invalid status.Types.XenAPIException
- if the call failed.IOException
- if an error occurs during a send or receive. This includes cases where a payload is invalid JSON.
-
getUpdateSyncEnabled
public Boolean getUpdateSyncEnabled(Connection c) throws Types.BadServerResponse, Types.XenAPIException, IOException Get the update_sync_enabled field of the given pool. Minimum allowed role: read-only Experimental. First published in 23.18.0.- Parameters:
c
- The connection the call is made on- Returns:
- value of the field
- Throws:
Types.BadServerResponse
- Thrown if the response from the server contains an invalid status.Types.XenAPIException
- if the call failed.IOException
- if an error occurs during a send or receive. This includes cases where a payload is invalid JSON.
-
getRecommendations
public Map<String,String> getRecommendations(Connection c) throws Types.BadServerResponse, Types.XenAPIException, IOException Get the recommendations field of the given pool. Minimum allowed role: read-only Experimental. First published in 24.19.1.- Parameters:
c
- The connection the call is made on- Returns:
- value of the field
- Throws:
Types.BadServerResponse
- Thrown if the response from the server contains an invalid status.Types.XenAPIException
- if the call failed.IOException
- if an error occurs during a send or receive. This includes cases where a payload is invalid JSON.
-
setNameLabel
public void setNameLabel(Connection c, String nameLabel) throws Types.BadServerResponse, Types.XenAPIException, IOException Set the name_label field of the given pool. Minimum allowed role: pool-operator First published in XenServer 4.0.- Parameters:
c
- The connection the call is made onnameLabel
- New value to set- Throws:
Types.BadServerResponse
- Thrown if the response from the server contains an invalid status.Types.XenAPIException
- if the call failed.IOException
- if an error occurs during a send or receive. This includes cases where a payload is invalid JSON.
-
setNameDescription
public void setNameDescription(Connection c, String nameDescription) throws Types.BadServerResponse, Types.XenAPIException, IOException Set the name_description field of the given pool. Minimum allowed role: pool-operator First published in XenServer 4.0.- Parameters:
c
- The connection the call is made onnameDescription
- New value to set- Throws:
Types.BadServerResponse
- Thrown if the response from the server contains an invalid status.Types.XenAPIException
- if the call failed.IOException
- if an error occurs during a send or receive. This includes cases where a payload is invalid JSON.
-
setDefaultSR
public void setDefaultSR(Connection c, SR defaultSR) throws Types.BadServerResponse, Types.XenAPIException, IOException Set the default_SR field of the given pool. Minimum allowed role: pool-operator First published in XenServer 4.0.- Parameters:
c
- The connection the call is made ondefaultSR
- New value to set- Throws:
Types.BadServerResponse
- Thrown if the response from the server contains an invalid status.Types.XenAPIException
- if the call failed.IOException
- if an error occurs during a send or receive. This includes cases where a payload is invalid JSON.
-
setSuspendImageSR
public void setSuspendImageSR(Connection c, SR suspendImageSR) throws Types.BadServerResponse, Types.XenAPIException, IOException Set the suspend_image_SR field of the given pool. Minimum allowed role: pool-operator First published in XenServer 4.0.- Parameters:
c
- The connection the call is made onsuspendImageSR
- New value to set- Throws:
Types.BadServerResponse
- Thrown if the response from the server contains an invalid status.Types.XenAPIException
- if the call failed.IOException
- if an error occurs during a send or receive. This includes cases where a payload is invalid JSON.
-
setCrashDumpSR
public void setCrashDumpSR(Connection c, SR crashDumpSR) throws Types.BadServerResponse, Types.XenAPIException, IOException Set the crash_dump_SR field of the given pool. Minimum allowed role: pool-operator First published in XenServer 4.0.- Parameters:
c
- The connection the call is made oncrashDumpSR
- New value to set- Throws:
Types.BadServerResponse
- Thrown if the response from the server contains an invalid status.Types.XenAPIException
- if the call failed.IOException
- if an error occurs during a send or receive. This includes cases where a payload is invalid JSON.
-
setOtherConfig
public void setOtherConfig(Connection c, Map<String, String> otherConfig) throws Types.BadServerResponse, Types.XenAPIException, IOExceptionSet the other_config field of the given pool. Minimum allowed role: pool-operator First published in XenServer 4.0.- Parameters:
c
- The connection the call is made onotherConfig
- New value to set- Throws:
Types.BadServerResponse
- Thrown if the response from the server contains an invalid status.Types.XenAPIException
- if the call failed.IOException
- if an error occurs during a send or receive. This includes cases where a payload is invalid JSON.
-
addToOtherConfig
public void addToOtherConfig(Connection c, String key, String value) throws Types.BadServerResponse, Types.XenAPIException, IOException Add the given key-value pair to the other_config field of the given pool. Minimum allowed role: pool-operator First published in XenServer 4.0.- Parameters:
c
- The connection the call is made onkey
- Key to addvalue
- Value to add- Throws:
Types.BadServerResponse
- Thrown if the response from the server contains an invalid status.Types.XenAPIException
- if the call failed.IOException
- if an error occurs during a send or receive. This includes cases where a payload is invalid JSON.
-
removeFromOtherConfig
public void removeFromOtherConfig(Connection c, String key) throws Types.BadServerResponse, Types.XenAPIException, IOException 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. Minimum allowed role: pool-operator First published in XenServer 4.0.- Parameters:
c
- The connection the call is made onkey
- Key to remove- Throws:
Types.BadServerResponse
- Thrown if the response from the server contains an invalid status.Types.XenAPIException
- if the call failed.IOException
- if an error occurs during a send or receive. This includes cases where a payload is invalid JSON.
-
setHaAllowOvercommit
public void setHaAllowOvercommit(Connection c, Boolean haAllowOvercommit) throws Types.BadServerResponse, Types.XenAPIException, IOException Set the ha_allow_overcommit field of the given pool. Minimum allowed role: pool-operator First published in XenServer 5.0.- Parameters:
c
- The connection the call is made onhaAllowOvercommit
- New value to set- Throws:
Types.BadServerResponse
- Thrown if the response from the server contains an invalid status.Types.XenAPIException
- if the call failed.IOException
- if an error occurs during a send or receive. This includes cases where a payload is invalid JSON.
-
setTags
public void setTags(Connection c, Set<String> tags) throws Types.BadServerResponse, Types.XenAPIException, IOException Set the tags field of the given pool. Minimum allowed role: vm-operator First published in XenServer 5.0.- Parameters:
c
- The connection the call is made ontags
- New value to set- Throws:
Types.BadServerResponse
- Thrown if the response from the server contains an invalid status.Types.XenAPIException
- if the call failed.IOException
- if an error occurs during a send or receive. This includes cases where a payload is invalid JSON.
-
addTags
public void addTags(Connection c, String value) throws Types.BadServerResponse, Types.XenAPIException, IOException Add the given value to the tags field of the given pool. If the value is already in that Set, then do nothing. Minimum allowed role: vm-operator First published in XenServer 5.0.- Parameters:
c
- The connection the call is made onvalue
- New value to add- Throws:
Types.BadServerResponse
- Thrown if the response from the server contains an invalid status.Types.XenAPIException
- if the call failed.IOException
- if an error occurs during a send or receive. This includes cases where a payload is invalid JSON.
-
removeTags
public void removeTags(Connection c, String value) throws Types.BadServerResponse, Types.XenAPIException, IOException Remove the given value from the tags field of the given pool. If the value is not in that Set, then do nothing. Minimum allowed role: vm-operator First published in XenServer 5.0.- Parameters:
c
- The connection the call is made onvalue
- Value to remove- Throws:
Types.BadServerResponse
- Thrown if the response from the server contains an invalid status.Types.XenAPIException
- if the call failed.IOException
- if an error occurs during a send or receive. This includes cases where a payload is invalid JSON.
-
setGuiConfig
public void setGuiConfig(Connection c, Map<String, String> guiConfig) throws Types.BadServerResponse, Types.XenAPIException, IOExceptionSet the gui_config field of the given pool. Minimum allowed role: vm-operator First published in XenServer 5.0.- Parameters:
c
- The connection the call is made onguiConfig
- New value to set- Throws:
Types.BadServerResponse
- Thrown if the response from the server contains an invalid status.Types.XenAPIException
- if the call failed.IOException
- if an error occurs during a send or receive. This includes cases where a payload is invalid JSON.
-
addToGuiConfig
public void addToGuiConfig(Connection c, String key, String value) throws Types.BadServerResponse, Types.XenAPIException, IOException Add the given key-value pair to the gui_config field of the given pool. Minimum allowed role: vm-operator First published in XenServer 5.0.- Parameters:
c
- The connection the call is made onkey
- Key to addvalue
- Value to add- Throws:
Types.BadServerResponse
- Thrown if the response from the server contains an invalid status.Types.XenAPIException
- if the call failed.IOException
- if an error occurs during a send or receive. This includes cases where a payload is invalid JSON.
-
removeFromGuiConfig
public void removeFromGuiConfig(Connection c, String key) throws Types.BadServerResponse, Types.XenAPIException, IOException 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. Minimum allowed role: vm-operator First published in XenServer 5.0.- Parameters:
c
- The connection the call is made onkey
- Key to remove- Throws:
Types.BadServerResponse
- Thrown if the response from the server contains an invalid status.Types.XenAPIException
- if the call failed.IOException
- if an error occurs during a send or receive. This includes cases where a payload is invalid JSON.
-
setHealthCheckConfig
public void setHealthCheckConfig(Connection c, Map<String, String> healthCheckConfig) throws Types.BadServerResponse, Types.XenAPIException, IOExceptionSet the health_check_config field of the given pool. Minimum allowed role: pool-operator First published in XenServer 7.0.- Parameters:
c
- The connection the call is made onhealthCheckConfig
- New value to set- Throws:
Types.BadServerResponse
- Thrown if the response from the server contains an invalid status.Types.XenAPIException
- if the call failed.IOException
- if an error occurs during a send or receive. This includes cases where a payload is invalid JSON.
-
addToHealthCheckConfig
public void addToHealthCheckConfig(Connection c, String key, String value) throws Types.BadServerResponse, Types.XenAPIException, IOException Add the given key-value pair to the health_check_config field of the given pool. Minimum allowed role: pool-operator First published in XenServer 7.0.- Parameters:
c
- The connection the call is made onkey
- Key to addvalue
- Value to add- Throws:
Types.BadServerResponse
- Thrown if the response from the server contains an invalid status.Types.XenAPIException
- if the call failed.IOException
- if an error occurs during a send or receive. This includes cases where a payload is invalid JSON.
-
removeFromHealthCheckConfig
public void removeFromHealthCheckConfig(Connection c, String key) throws Types.BadServerResponse, Types.XenAPIException, IOException 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. Minimum allowed role: pool-operator First published in XenServer 7.0.- Parameters:
c
- The connection the call is made onkey
- Key to remove- Throws:
Types.BadServerResponse
- Thrown if the response from the server contains an invalid status.Types.XenAPIException
- if the call failed.IOException
- if an error occurs during a send or receive. This includes cases where a payload is invalid JSON.
-
setWlbEnabled
public void setWlbEnabled(Connection c, Boolean wlbEnabled) throws Types.BadServerResponse, Types.XenAPIException, IOException Set the wlb_enabled field of the given pool. Minimum allowed role: pool-operator First published in XenServer 5.5.- Parameters:
c
- The connection the call is made onwlbEnabled
- New value to set- Throws:
Types.BadServerResponse
- Thrown if the response from the server contains an invalid status.Types.XenAPIException
- if the call failed.IOException
- if an error occurs during a send or receive. This includes cases where a payload is invalid JSON.
-
setWlbVerifyCert
@Deprecated(since="1.290.0") public void setWlbVerifyCert(Connection c, Boolean wlbVerifyCert) throws Types.BadServerResponse, Types.XenAPIException, IOException Deprecated.since 1.290.0Set the wlb_verify_cert field of the given pool. Minimum allowed role: pool-operator First published in XenServer 5.5.- Parameters:
c
- The connection the call is made onwlbVerifyCert
- New value to set- Throws:
Types.BadServerResponse
- Thrown if the response from the server contains an invalid status.Types.XenAPIException
- if the call failed.IOException
- if an error occurs during a send or receive. This includes cases where a payload is invalid JSON.
-
setPolicyNoVendorDevice
@Deprecated(since="24.14.0") public void setPolicyNoVendorDevice(Connection c, Boolean policyNoVendorDevice) throws Types.BadServerResponse, Types.XenAPIException, IOException Deprecated.since 24.14.0Set the policy_no_vendor_device field of the given pool. Minimum allowed role: pool-operator First published in XenServer 7.0.- Parameters:
c
- The connection the call is made onpolicyNoVendorDevice
- New value to set- Throws:
Types.BadServerResponse
- Thrown if the response from the server contains an invalid status.Types.XenAPIException
- if the call failed.IOException
- if an error occurs during a send or receive. This includes cases where a payload is invalid JSON.
-
setLivePatchingDisabled
public void setLivePatchingDisabled(Connection c, Boolean livePatchingDisabled) throws Types.BadServerResponse, Types.XenAPIException, IOException Set the live_patching_disabled field of the given pool. Minimum allowed role: pool-operator First published in XenServer 7.1.- Parameters:
c
- The connection the call is made onlivePatchingDisabled
- New value to set- Throws:
Types.BadServerResponse
- Thrown if the response from the server contains an invalid status.Types.XenAPIException
- if the call failed.IOException
- if an error occurs during a send or receive. This includes cases where a payload is invalid JSON.
-
setIsPsrPending
public void setIsPsrPending(Connection c, Boolean isPsrPending) throws Types.BadServerResponse, Types.XenAPIException, IOException Set the is_psr_pending field of the given pool. Minimum allowed role: pool-operator First published in Citrix Hypervisor 8.2 Hotfix 2.- Parameters:
c
- The connection the call is made onisPsrPending
- New value to set- Throws:
Types.BadServerResponse
- Thrown if the response from the server contains an invalid status.Types.XenAPIException
- if the call failed.IOException
- if an error occurs during a send or receive. This includes cases where a payload is invalid JSON.
-
setMigrationCompression
public void setMigrationCompression(Connection c, Boolean migrationCompression) throws Types.BadServerResponse, Types.XenAPIException, IOException Set the migration_compression field of the given pool. Minimum allowed role: pool-operator Experimental. First published in 22.33.0.- Parameters:
c
- The connection the call is made onmigrationCompression
- New value to set- Throws:
Types.BadServerResponse
- Thrown if the response from the server contains an invalid status.Types.XenAPIException
- if the call failed.IOException
- if an error occurs during a send or receive. This includes cases where a payload is invalid JSON.
-
setCoordinatorBias
public void setCoordinatorBias(Connection c, Boolean coordinatorBias) throws Types.BadServerResponse, Types.XenAPIException, IOException Set the coordinator_bias field of the given pool. Minimum allowed role: pool-operator First published in XenServer 4.0.- Parameters:
c
- The connection the call is made oncoordinatorBias
- New value to set- Throws:
Types.BadServerResponse
- Thrown if the response from the server contains an invalid status.Types.XenAPIException
- if the call failed.IOException
- if an error occurs during a send or receive. This includes cases where a payload is invalid JSON.
-
join
public static void join(Connection c, String masterAddress, String masterUsername, String masterPassword) throws Types.BadServerResponse, Types.XenAPIException, IOException, Types.JoiningHostCannotContainSharedSrs Instruct host to join a new pool Minimum allowed role: pool-operator First published in XenServer 4.0.- Parameters:
c
- The connection the call is made onmasterAddress
- The hostname of the master of the pool to joinmasterUsername
- The username of the master (for initial authentication)masterPassword
- The password for the master (for initial authentication)- Throws:
Types.BadServerResponse
- Thrown if the response from the server contains an invalid status.Types.XenAPIException
- if the call failed.IOException
- if an error occurs during a send or receive. This includes cases where a payload is invalid JSON.Types.JoiningHostCannotContainSharedSrs
- The server joining the pool cannot contain any shared storage.
-
joinAsync
public static Task joinAsync(Connection c, String masterAddress, String masterUsername, String masterPassword) throws Types.BadServerResponse, Types.XenAPIException, IOException, Types.JoiningHostCannotContainSharedSrs Instruct host to join a new pool Minimum allowed role: pool-operator First published in XenServer 4.0.- Parameters:
c
- The connection the call is made onmasterAddress
- The hostname of the master of the pool to joinmasterUsername
- The username of the master (for initial authentication)masterPassword
- The password for the master (for initial authentication)- Returns:
- Task
- Throws:
Types.BadServerResponse
- Thrown if the response from the server contains an invalid status.Types.XenAPIException
- if the call failed.IOException
- if an error occurs during a send or receive. This includes cases where a payload is invalid JSON.Types.JoiningHostCannotContainSharedSrs
- The server joining the pool cannot contain any shared storage.
-
joinForce
public static void joinForce(Connection c, String masterAddress, String masterUsername, String masterPassword) throws Types.BadServerResponse, Types.XenAPIException, IOException Instruct host to join a new pool Minimum allowed role: pool-operator First published in XenServer 4.0.- Parameters:
c
- The connection the call is made onmasterAddress
- The hostname of the master of the pool to joinmasterUsername
- The username of the master (for initial authentication)masterPassword
- The password for the master (for initial authentication)- Throws:
Types.BadServerResponse
- Thrown if the response from the server contains an invalid status.Types.XenAPIException
- if the call failed.IOException
- if an error occurs during a send or receive. This includes cases where a payload is invalid JSON.
-
joinForceAsync
public static Task joinForceAsync(Connection c, String masterAddress, String masterUsername, String masterPassword) throws Types.BadServerResponse, Types.XenAPIException, IOException Instruct host to join a new pool Minimum allowed role: pool-operator First published in XenServer 4.0.- Parameters:
c
- The connection the call is made onmasterAddress
- The hostname of the master of the pool to joinmasterUsername
- The username of the master (for initial authentication)masterPassword
- The password for the master (for initial authentication)- Returns:
- Task
- Throws:
Types.BadServerResponse
- Thrown if the response from the server contains an invalid status.Types.XenAPIException
- if the call failed.IOException
- if an error occurs during a send or receive. This includes cases where a payload is invalid JSON.
-
eject
public static void eject(Connection c, Host host) throws Types.BadServerResponse, Types.XenAPIException, IOException Instruct a pool master to eject a host from the pool Minimum allowed role: pool-operator First published in XenServer 4.0.- Parameters:
c
- The connection the call is made onhost
- The host to eject- Throws:
Types.BadServerResponse
- Thrown if the response from the server contains an invalid status.Types.XenAPIException
- if the call failed.IOException
- if an error occurs during a send or receive. This includes cases where a payload is invalid JSON.
-
ejectAsync
public static Task ejectAsync(Connection c, Host host) throws Types.BadServerResponse, Types.XenAPIException, IOException Instruct a pool master to eject a host from the pool Minimum allowed role: pool-operator First published in XenServer 4.0.- Parameters:
c
- The connection the call is made onhost
- The host to eject- Returns:
- Task
- Throws:
Types.BadServerResponse
- Thrown if the response from the server contains an invalid status.Types.XenAPIException
- if the call failed.IOException
- if an error occurs during a send or receive. This includes cases where a payload is invalid JSON.
-
emergencyTransitionToMaster
public static void emergencyTransitionToMaster(Connection c) throws Types.BadServerResponse, Types.XenAPIException, IOException Instruct host that's currently a slave to transition to being master Minimum allowed role: pool-operator First published in XenServer 4.0.- Parameters:
c
- The connection the call is made on- Throws:
Types.BadServerResponse
- Thrown if the response from the server contains an invalid status.Types.XenAPIException
- if the call failed.IOException
- if an error occurs during a send or receive. This includes cases where a payload is invalid JSON.
-
emergencyResetMaster
public static void emergencyResetMaster(Connection c, String masterAddress) throws Types.BadServerResponse, Types.XenAPIException, IOException Instruct a slave already in a pool that the master has changed Minimum allowed role: pool-operator First published in XenServer 4.0.- Parameters:
c
- The connection the call is made onmasterAddress
- The hostname of the master- Throws:
Types.BadServerResponse
- Thrown if the response from the server contains an invalid status.Types.XenAPIException
- if the call failed.IOException
- if an error occurs during a send or receive. This includes cases where a payload is invalid JSON.
-
recoverSlaves
public static Set<Host> recoverSlaves(Connection c) throws Types.BadServerResponse, Types.XenAPIException, IOException Instruct a pool master, M, to try and contact its slaves and, if slaves are in emergency mode, reset their master address to M. Minimum allowed role: pool-operator First published in XenServer 4.0.- Parameters:
c
- The connection the call is made on- Returns:
- list of hosts whose master address were successfully reset
- Throws:
Types.BadServerResponse
- Thrown if the response from the server contains an invalid status.Types.XenAPIException
- if the call failed.IOException
- if an error occurs during a send or receive. This includes cases where a payload is invalid JSON.
-
recoverSlavesAsync
public static Task recoverSlavesAsync(Connection c) throws Types.BadServerResponse, Types.XenAPIException, IOException Instruct a pool master, M, to try and contact its slaves and, if slaves are in emergency mode, reset their master address to M. Minimum allowed role: pool-operator First published in XenServer 4.0.- Parameters:
c
- The connection the call is made on- Returns:
- Task
- Throws:
Types.BadServerResponse
- Thrown if the response from the server contains an invalid status.Types.XenAPIException
- if the call failed.IOException
- if an error occurs during a send or receive. This includes cases where a payload is invalid JSON.
-
createVLAN
public static Set<PIF> createVLAN(Connection c, String device, Network network, Long VLAN) throws Types.BadServerResponse, Types.XenAPIException, IOException, Types.VlanTagInvalid 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. Minimum allowed role: pool-operator First published in XenServer 4.0.- Parameters:
c
- The connection the call is made ondevice
- physical interface on which to create the VLAN interfacenetwork
- network to which this interface should be connectedVLAN
- VLAN tag for the new interface- Returns:
- The references of the created PIF objects
- Throws:
Types.BadServerResponse
- Thrown if the response from the server contains an invalid status.Types.XenAPIException
- if the call failed.IOException
- if an error occurs during a send or receive. This includes cases where a payload is invalid JSON.Types.VlanTagInvalid
- 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.
-
createVLANAsync
public static Task createVLANAsync(Connection c, String device, Network network, Long VLAN) throws Types.BadServerResponse, Types.XenAPIException, IOException, Types.VlanTagInvalid 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. Minimum allowed role: pool-operator First published in XenServer 4.0.- Parameters:
c
- The connection the call is made ondevice
- physical interface on which to create the VLAN interfacenetwork
- network to which this interface should be connectedVLAN
- VLAN tag for the new interface- Returns:
- Task
- Throws:
Types.BadServerResponse
- Thrown if the response from the server contains an invalid status.Types.XenAPIException
- if the call failed.IOException
- if an error occurs during a send or receive. This includes cases where a payload is invalid JSON.Types.VlanTagInvalid
- 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.
-
managementReconfigure
public static void managementReconfigure(Connection c, Network network) throws Types.BadServerResponse, Types.XenAPIException, IOException, Types.HaIsEnabled, Types.PifNotPresent, Types.CannotPlugBondSlave, Types.PifIncompatiblePrimaryAddressType, Types.PifHasNoNetworkConfiguration, Types.PifHasNoV6NetworkConfiguration Reconfigure the management network interface for all Hosts in the Pool Minimum allowed role: pool-operator First published in XenServer 7.3.- Parameters:
c
- The connection the call is made onnetwork
- The network- Throws:
Types.BadServerResponse
- Thrown if the response from the server contains an invalid status.Types.XenAPIException
- if the call failed.IOException
- if an error occurs during a send or receive. This includes cases where a payload is invalid JSON.Types.HaIsEnabled
- The operation could not be performed because HA is enabled on the PoolTypes.PifNotPresent
- This host has no PIF on the given network.Types.CannotPlugBondSlave
- This PIF is a bond member and cannot be plugged.Types.PifIncompatiblePrimaryAddressType
- The primary address types are not compatibleTypes.PifHasNoNetworkConfiguration
- PIF has no IP configuration (mode currently set to 'none')Types.PifHasNoV6NetworkConfiguration
- PIF has no IPv6 configuration (mode currently set to 'none')
-
managementReconfigureAsync
public static Task managementReconfigureAsync(Connection c, Network network) throws Types.BadServerResponse, Types.XenAPIException, IOException, Types.HaIsEnabled, Types.PifNotPresent, Types.CannotPlugBondSlave, Types.PifIncompatiblePrimaryAddressType, Types.PifHasNoNetworkConfiguration, Types.PifHasNoV6NetworkConfiguration Reconfigure the management network interface for all Hosts in the Pool Minimum allowed role: pool-operator First published in XenServer 7.3.- Parameters:
c
- The connection the call is made onnetwork
- The network- Returns:
- Task
- Throws:
Types.BadServerResponse
- Thrown if the response from the server contains an invalid status.Types.XenAPIException
- if the call failed.IOException
- if an error occurs during a send or receive. This includes cases where a payload is invalid JSON.Types.HaIsEnabled
- The operation could not be performed because HA is enabled on the PoolTypes.PifNotPresent
- This host has no PIF on the given network.Types.CannotPlugBondSlave
- This PIF is a bond member and cannot be plugged.Types.PifIncompatiblePrimaryAddressType
- The primary address types are not compatibleTypes.PifHasNoNetworkConfiguration
- PIF has no IP configuration (mode currently set to 'none')Types.PifHasNoV6NetworkConfiguration
- PIF has no IPv6 configuration (mode currently set to 'none')
-
createVLANFromPIF
public static Set<PIF> createVLANFromPIF(Connection c, PIF pif, Network network, Long VLAN) throws Types.BadServerResponse, Types.XenAPIException, IOException, Types.VlanTagInvalid Create a pool-wide VLAN by taking the PIF. Minimum allowed role: pool-operator First published in XenServer 4.0.- Parameters:
c
- The connection the call is made onpif
- physical interface on any particular host, that identifies the PIF on which to create the (pool-wide) VLAN interfacenetwork
- network to which this interface should be connectedVLAN
- VLAN tag for the new interface- Returns:
- The references of the created PIF objects
- Throws:
Types.BadServerResponse
- Thrown if the response from the server contains an invalid status.Types.XenAPIException
- if the call failed.IOException
- if an error occurs during a send or receive. This includes cases where a payload is invalid JSON.Types.VlanTagInvalid
- 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.
-
createVLANFromPIFAsync
public static Task createVLANFromPIFAsync(Connection c, PIF pif, Network network, Long VLAN) throws Types.BadServerResponse, Types.XenAPIException, IOException, Types.VlanTagInvalid Create a pool-wide VLAN by taking the PIF. Minimum allowed role: pool-operator First published in XenServer 4.0.- Parameters:
c
- The connection the call is made onpif
- physical interface on any particular host, that identifies the PIF on which to create the (pool-wide) VLAN interfacenetwork
- network to which this interface should be connectedVLAN
- VLAN tag for the new interface- Returns:
- Task
- Throws:
Types.BadServerResponse
- Thrown if the response from the server contains an invalid status.Types.XenAPIException
- if the call failed.IOException
- if an error occurs during a send or receive. This includes cases where a payload is invalid JSON.Types.VlanTagInvalid
- 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.
-
enableHa
public static void enableHa(Connection c, Set<SR> heartbeatSrs, Map<String, String> configuration) throws Types.BadServerResponse, Types.XenAPIException, IOExceptionTurn on High Availability mode Minimum allowed role: pool-operator First published in XenServer 4.1.- Parameters:
c
- The connection the call is made onheartbeatSrs
- Set of SRs to use for storage heartbeatingconfiguration
- Detailed HA configuration to apply- Throws:
Types.BadServerResponse
- Thrown if the response from the server contains an invalid status.Types.XenAPIException
- if the call failed.IOException
- if an error occurs during a send or receive. This includes cases where a payload is invalid JSON.
-
enableHaAsync
public static Task enableHaAsync(Connection c, Set<SR> heartbeatSrs, Map<String, String> configuration) throws Types.BadServerResponse, Types.XenAPIException, IOExceptionTurn on High Availability mode Minimum allowed role: pool-operator First published in XenServer 4.1.- Parameters:
c
- The connection the call is made onheartbeatSrs
- Set of SRs to use for storage heartbeatingconfiguration
- Detailed HA configuration to apply- Returns:
- Task
- Throws:
Types.BadServerResponse
- Thrown if the response from the server contains an invalid status.Types.XenAPIException
- if the call failed.IOException
- if an error occurs during a send or receive. This includes cases where a payload is invalid JSON.
-
disableHa
public static void disableHa(Connection c) throws Types.BadServerResponse, Types.XenAPIException, IOException Turn off High Availability mode Minimum allowed role: pool-operator First published in XenServer 4.1.- Parameters:
c
- The connection the call is made on- Throws:
Types.BadServerResponse
- Thrown if the response from the server contains an invalid status.Types.XenAPIException
- if the call failed.IOException
- if an error occurs during a send or receive. This includes cases where a payload is invalid JSON.
-
disableHaAsync
public static Task disableHaAsync(Connection c) throws Types.BadServerResponse, Types.XenAPIException, IOException Turn off High Availability mode Minimum allowed role: pool-operator First published in XenServer 4.1.- Parameters:
c
- The connection the call is made on- Returns:
- Task
- Throws:
Types.BadServerResponse
- Thrown if the response from the server contains an invalid status.Types.XenAPIException
- if the call failed.IOException
- if an error occurs during a send or receive. This includes cases where a payload is invalid JSON.
-
syncDatabase
public static void syncDatabase(Connection c) throws Types.BadServerResponse, Types.XenAPIException, IOException Forcibly synchronise the database now Minimum allowed role: pool-operator First published in XenServer 4.0.- Parameters:
c
- The connection the call is made on- Throws:
Types.BadServerResponse
- Thrown if the response from the server contains an invalid status.Types.XenAPIException
- if the call failed.IOException
- if an error occurs during a send or receive. This includes cases where a payload is invalid JSON.
-
syncDatabaseAsync
public static Task syncDatabaseAsync(Connection c) throws Types.BadServerResponse, Types.XenAPIException, IOException Forcibly synchronise the database now Minimum allowed role: pool-operator First published in XenServer 4.0.- Parameters:
c
- The connection the call is made on- Returns:
- Task
- Throws:
Types.BadServerResponse
- Thrown if the response from the server contains an invalid status.Types.XenAPIException
- if the call failed.IOException
- if an error occurs during a send or receive. This includes cases where a payload is invalid JSON.
-
designateNewMaster
public static void designateNewMaster(Connection c, Host host) throws Types.BadServerResponse, Types.XenAPIException, IOException Perform an orderly handover of the role of master to the referenced host. Minimum allowed role: pool-operator First published in XenServer 4.1.- Parameters:
c
- The connection the call is made onhost
- The host who should become the new master- Throws:
Types.BadServerResponse
- Thrown if the response from the server contains an invalid status.Types.XenAPIException
- if the call failed.IOException
- if an error occurs during a send or receive. This includes cases where a payload is invalid JSON.
-
designateNewMasterAsync
public static Task designateNewMasterAsync(Connection c, Host host) throws Types.BadServerResponse, Types.XenAPIException, IOException Perform an orderly handover of the role of master to the referenced host. Minimum allowed role: pool-operator First published in XenServer 4.1.- Parameters:
c
- The connection the call is made onhost
- The host who should become the new master- Returns:
- Task
- Throws:
Types.BadServerResponse
- Thrown if the response from the server contains an invalid status.Types.XenAPIException
- if the call failed.IOException
- if an error occurs during a send or receive. This includes cases where a payload is invalid JSON.
-
haPreventRestartsFor
public static void haPreventRestartsFor(Connection c, Long seconds) throws Types.BadServerResponse, Types.XenAPIException, IOException 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 Minimum allowed role: pool-operator First published in XenServer 5.0 Update 1.- Parameters:
c
- The connection the call is made onseconds
- The number of seconds to block the restart thread for- Throws:
Types.BadServerResponse
- Thrown if the response from the server contains an invalid status.Types.XenAPIException
- if the call failed.IOException
- if an error occurs during a send or receive. This includes cases where a payload is invalid JSON.
-
haFailoverPlanExists
public static Boolean haFailoverPlanExists(Connection c, Long n) throws Types.BadServerResponse, Types.XenAPIException, IOException Returns true if a VM failover plan exists for up to 'n' host failures Minimum allowed role: pool-operator First published in XenServer 5.0.- Parameters:
c
- The connection the call is made onn
- The number of host failures to plan for- Returns:
- true if a failover plan exists for the supplied number of host failures
- Throws:
Types.BadServerResponse
- Thrown if the response from the server contains an invalid status.Types.XenAPIException
- if the call failed.IOException
- if an error occurs during a send or receive. This includes cases where a payload is invalid JSON.
-
haComputeMaxHostFailuresToTolerate
public static Long haComputeMaxHostFailuresToTolerate(Connection c) throws Types.BadServerResponse, Types.XenAPIException, IOException Returns the maximum number of host failures we could tolerate before we would be unable to restart configured VMs Minimum allowed role: pool-operator First published in XenServer 5.0.- Parameters:
c
- The connection the call is made on- Returns:
- maximum value for ha_host_failures_to_tolerate given current configuration
- Throws:
Types.BadServerResponse
- Thrown if the response from the server contains an invalid status.Types.XenAPIException
- if the call failed.IOException
- if an error occurs during a send or receive. This includes cases where a payload is invalid JSON.
-
haComputeHypotheticalMaxHostFailuresToTolerate
public static Long haComputeHypotheticalMaxHostFailuresToTolerate(Connection c, Map<VM, String> configuration) throws Types.BadServerResponse, Types.XenAPIException, IOExceptionReturns the maximum number of host failures we could tolerate before we would be unable to restart the provided VMs Minimum allowed role: read-only First published in XenServer 5.0.- Parameters:
c
- The connection the call is made onconfiguration
- Map of protected VM reference to restart priority- Returns:
- maximum value for ha_host_failures_to_tolerate given provided configuration
- Throws:
Types.BadServerResponse
- Thrown if the response from the server contains an invalid status.Types.XenAPIException
- if the call failed.IOException
- if an error occurs during a send or receive. This includes cases where a payload is invalid JSON.
-
haComputeVmFailoverPlan
public static Map<VM,Map<String, haComputeVmFailoverPlanString>> (Connection c, Set<Host> failedHosts, Set<VM> failedVms) throws Types.BadServerResponse, Types.XenAPIException, IOException Return a VM failover plan assuming a given subset of hosts fail Minimum allowed role: pool-operator First published in XenServer 5.0.- Parameters:
c
- The connection the call is made onfailedHosts
- The set of hosts to assume have failedfailedVms
- The set of VMs to restart- Returns:
- VM failover plan: a map of VM to host to restart the host on
- Throws:
Types.BadServerResponse
- Thrown if the response from the server contains an invalid status.Types.XenAPIException
- if the call failed.IOException
- if an error occurs during a send or receive. This includes cases where a payload is invalid JSON.
-
setHaHostFailuresToTolerate
public void setHaHostFailuresToTolerate(Connection c, Long value) throws Types.BadServerResponse, Types.XenAPIException, IOException Set the maximum number of host failures to consider in the HA VM restart planner Minimum allowed role: pool-operator First published in XenServer 5.0.- Parameters:
c
- The connection the call is made onvalue
- New number of host failures to consider- Throws:
Types.BadServerResponse
- Thrown if the response from the server contains an invalid status.Types.XenAPIException
- if the call failed.IOException
- if an error occurs during a send or receive. This includes cases where a payload is invalid JSON.
-
setHaHostFailuresToTolerateAsync
public Task setHaHostFailuresToTolerateAsync(Connection c, Long value) throws Types.BadServerResponse, Types.XenAPIException, IOException Set the maximum number of host failures to consider in the HA VM restart planner Minimum allowed role: pool-operator First published in XenServer 5.0.- Parameters:
c
- The connection the call is made onvalue
- New number of host failures to consider- Returns:
- Task
- Throws:
Types.BadServerResponse
- Thrown if the response from the server contains an invalid status.Types.XenAPIException
- if the call failed.IOException
- if an error occurs during a send or receive. This includes cases where a payload is invalid JSON.
-
createNewBlob
public Blob createNewBlob(Connection c, String name, String mimeType) throws Types.BadServerResponse, Types.XenAPIException, IOException Create a placeholder for a named binary blob of data that is associated with this pool Minimum allowed role: pool-operator First published in XenServer 5.0.- Parameters:
c
- The connection the call is made onname
- The name associated with the blobmimeType
- The mime type for the data. Empty string translates to application/octet-stream- Returns:
- The reference of the blob, needed for populating its data
- Throws:
Types.BadServerResponse
- Thrown if the response from the server contains an invalid status.Types.XenAPIException
- if the call failed.IOException
- if an error occurs during a send or receive. This includes cases where a payload is invalid JSON.
-
createNewBlob
public Blob createNewBlob(Connection c, String name, String mimeType, Boolean _public) throws Types.BadServerResponse, Types.XenAPIException, IOException Create a placeholder for a named binary blob of data that is associated with this pool Minimum allowed role: pool-operator First published in XenServer 5.0.- Parameters:
c
- The connection the call is made onname
- The name associated with the blobmimeType
- The mime type for the data. Empty string translates to application/octet-stream_public
- True if the blob should be publicly available First published in XenServer 6.1.- Returns:
- The reference of the blob, needed for populating its data
- Throws:
Types.BadServerResponse
- Thrown if the response from the server contains an invalid status.Types.XenAPIException
- if the call failed.IOException
- if an error occurs during a send or receive. This includes cases where a payload is invalid JSON.
-
createNewBlobAsync
public Task createNewBlobAsync(Connection c, String name, String mimeType) throws Types.BadServerResponse, Types.XenAPIException, IOException Create a placeholder for a named binary blob of data that is associated with this pool Minimum allowed role: pool-operator First published in XenServer 5.0.- Parameters:
c
- The connection the call is made onname
- The name associated with the blobmimeType
- The mime type for the data. Empty string translates to application/octet-stream- Returns:
- Task
- Throws:
Types.BadServerResponse
- Thrown if the response from the server contains an invalid status.Types.XenAPIException
- if the call failed.IOException
- if an error occurs during a send or receive. This includes cases where a payload is invalid JSON.
-
createNewBlobAsync
public Task createNewBlobAsync(Connection c, String name, String mimeType, Boolean _public) throws Types.BadServerResponse, Types.XenAPIException, IOException Create a placeholder for a named binary blob of data that is associated with this pool Minimum allowed role: pool-operator First published in XenServer 5.0.- Parameters:
c
- The connection the call is made onname
- The name associated with the blobmimeType
- The mime type for the data. Empty string translates to application/octet-stream_public
- True if the blob should be publicly available First published in XenServer 6.1.- Returns:
- Task
- Throws:
Types.BadServerResponse
- Thrown if the response from the server contains an invalid status.Types.XenAPIException
- if the call failed.IOException
- if an error occurs during a send or receive. This includes cases where a payload is invalid JSON.
-
enableExternalAuth
public void enableExternalAuth(Connection c, Map<String, String> config, String serviceName, String authType) throws Types.BadServerResponse, Types.XenAPIException, IOExceptionThis call enables external authentication on all the hosts of the pool Minimum allowed role: pool-admin First published in XenServer 5.5.- Parameters:
c
- The connection the call is made onconfig
- A list of key-values containing the configuration dataserviceName
- The name of the serviceauthType
- The type of authentication (e.g. AD for Active Directory)- Throws:
Types.BadServerResponse
- Thrown if the response from the server contains an invalid status.Types.XenAPIException
- if the call failed.IOException
- if an error occurs during a send or receive. This includes cases where a payload is invalid JSON.
-
disableExternalAuth
public void disableExternalAuth(Connection c, Map<String, String> config) throws Types.BadServerResponse, Types.XenAPIException, IOExceptionThis call disables external authentication on all the hosts of the pool Minimum allowed role: pool-admin First published in XenServer 5.5.- Parameters:
c
- The connection the call is made onconfig
- Optional parameters as a list of key-values containing the configuration data- Throws:
Types.BadServerResponse
- Thrown if the response from the server contains an invalid status.Types.XenAPIException
- if the call failed.IOException
- if an error occurs during a send or receive. This includes cases where a payload is invalid JSON.
-
detectNonhomogeneousExternalAuth
public void detectNonhomogeneousExternalAuth(Connection c) throws Types.BadServerResponse, Types.XenAPIException, IOException This call asynchronously detects if the external authentication configuration in any slave is different from that in the master and raises appropriate alerts Minimum allowed role: pool-operator First published in XenServer 5.5.- Parameters:
c
- The connection the call is made on- Throws:
Types.BadServerResponse
- Thrown if the response from the server contains an invalid status.Types.XenAPIException
- if the call failed.IOException
- if an error occurs during a send or receive. This includes cases where a payload is invalid JSON.
-
initializeWlb
public static void initializeWlb(Connection c, String wlbUrl, String wlbUsername, String wlbPassword, String xenserverUsername, String xenserverPassword) throws Types.BadServerResponse, Types.XenAPIException, IOException Initializes workload balancing monitoring on this pool with the specified wlb server Minimum allowed role: pool-operator First published in XenServer 5.5.- Parameters:
c
- The connection the call is made onwlbUrl
- The ip address and port to use when accessing the wlb serverwlbUsername
- The username used to authenticate with the wlb serverwlbPassword
- The password used to authenticate with the wlb serverxenserverUsername
- The username used by the wlb server to authenticate with the xenserverxenserverPassword
- The password used by the wlb server to authenticate with the xenserver- Throws:
Types.BadServerResponse
- Thrown if the response from the server contains an invalid status.Types.XenAPIException
- if the call failed.IOException
- if an error occurs during a send or receive. This includes cases where a payload is invalid JSON.
-
initializeWlbAsync
public static Task initializeWlbAsync(Connection c, String wlbUrl, String wlbUsername, String wlbPassword, String xenserverUsername, String xenserverPassword) throws Types.BadServerResponse, Types.XenAPIException, IOException Initializes workload balancing monitoring on this pool with the specified wlb server Minimum allowed role: pool-operator First published in XenServer 5.5.- Parameters:
c
- The connection the call is made onwlbUrl
- The ip address and port to use when accessing the wlb serverwlbUsername
- The username used to authenticate with the wlb serverwlbPassword
- The password used to authenticate with the wlb serverxenserverUsername
- The username used by the wlb server to authenticate with the xenserverxenserverPassword
- The password used by the wlb server to authenticate with the xenserver- Returns:
- Task
- Throws:
Types.BadServerResponse
- Thrown if the response from the server contains an invalid status.Types.XenAPIException
- if the call failed.IOException
- if an error occurs during a send or receive. This includes cases where a payload is invalid JSON.
-
deconfigureWlb
public static void deconfigureWlb(Connection c) throws Types.BadServerResponse, Types.XenAPIException, IOException Permanently deconfigures workload balancing monitoring on this pool Minimum allowed role: pool-operator First published in XenServer 5.5.- Parameters:
c
- The connection the call is made on- Throws:
Types.BadServerResponse
- Thrown if the response from the server contains an invalid status.Types.XenAPIException
- if the call failed.IOException
- if an error occurs during a send or receive. This includes cases where a payload is invalid JSON.
-
deconfigureWlbAsync
public static Task deconfigureWlbAsync(Connection c) throws Types.BadServerResponse, Types.XenAPIException, IOException Permanently deconfigures workload balancing monitoring on this pool Minimum allowed role: pool-operator First published in XenServer 5.5.- Parameters:
c
- The connection the call is made on- Returns:
- Task
- Throws:
Types.BadServerResponse
- Thrown if the response from the server contains an invalid status.Types.XenAPIException
- if the call failed.IOException
- if an error occurs during a send or receive. This includes cases where a payload is invalid JSON.
-
sendWlbConfiguration
public static void sendWlbConfiguration(Connection c, Map<String, String> config) throws Types.BadServerResponse, Types.XenAPIException, IOExceptionSets the pool optimization criteria for the workload balancing server Minimum allowed role: pool-operator First published in XenServer 5.5.- Parameters:
c
- The connection the call is made onconfig
- The configuration to use in optimizing this pool- Throws:
Types.BadServerResponse
- Thrown if the response from the server contains an invalid status.Types.XenAPIException
- if the call failed.IOException
- if an error occurs during a send or receive. This includes cases where a payload is invalid JSON.
-
sendWlbConfigurationAsync
public static Task sendWlbConfigurationAsync(Connection c, Map<String, String> config) throws Types.BadServerResponse, Types.XenAPIException, IOExceptionSets the pool optimization criteria for the workload balancing server Minimum allowed role: pool-operator First published in XenServer 5.5.- Parameters:
c
- The connection the call is made onconfig
- The configuration to use in optimizing this pool- Returns:
- Task
- Throws:
Types.BadServerResponse
- Thrown if the response from the server contains an invalid status.Types.XenAPIException
- if the call failed.IOException
- if an error occurs during a send or receive. This includes cases where a payload is invalid JSON.
-
retrieveWlbConfiguration
public static Map<String,String> retrieveWlbConfiguration(Connection c) throws Types.BadServerResponse, Types.XenAPIException, IOException Retrieves the pool optimization criteria from the workload balancing server Minimum allowed role: read-only First published in XenServer 5.5.- Parameters:
c
- The connection the call is made on- Returns:
- The configuration used in optimizing this pool
- Throws:
Types.BadServerResponse
- Thrown if the response from the server contains an invalid status.Types.XenAPIException
- if the call failed.IOException
- if an error occurs during a send or receive. This includes cases where a payload is invalid JSON.
-
retrieveWlbConfigurationAsync
public static Task retrieveWlbConfigurationAsync(Connection c) throws Types.BadServerResponse, Types.XenAPIException, IOException Retrieves the pool optimization criteria from the workload balancing server Minimum allowed role: read-only First published in XenServer 5.5.- Parameters:
c
- The connection the call is made on- Returns:
- Task
- Throws:
Types.BadServerResponse
- Thrown if the response from the server contains an invalid status.Types.XenAPIException
- if the call failed.IOException
- if an error occurs during a send or receive. This includes cases where a payload is invalid JSON.
-
retrieveWlbRecommendations
public static Map<VM,Set<String>> retrieveWlbRecommendations(Connection c) throws Types.BadServerResponse, Types.XenAPIException, IOException Retrieves vm migrate recommendations for the pool from the workload balancing server Minimum allowed role: read-only First published in XenServer 5.5.- Parameters:
c
- The connection the call is made on- Returns:
- The list of vm migration recommendations
- Throws:
Types.BadServerResponse
- Thrown if the response from the server contains an invalid status.Types.XenAPIException
- if the call failed.IOException
- if an error occurs during a send or receive. This includes cases where a payload is invalid JSON.
-
retrieveWlbRecommendationsAsync
public static Task retrieveWlbRecommendationsAsync(Connection c) throws Types.BadServerResponse, Types.XenAPIException, IOException Retrieves vm migrate recommendations for the pool from the workload balancing server Minimum allowed role: read-only First published in XenServer 5.5.- Parameters:
c
- The connection the call is made on- Returns:
- Task
- Throws:
Types.BadServerResponse
- Thrown if the response from the server contains an invalid status.Types.XenAPIException
- if the call failed.IOException
- if an error occurs during a send or receive. This includes cases where a payload is invalid JSON.
-
sendTestPost
public static String sendTestPost(Connection c, String host, Long port, String body) throws Types.BadServerResponse, Types.XenAPIException, IOException Send the given body to the given host and port, using HTTPS, and print the response. This is used for debugging the SSL layer. Minimum allowed role: pool-admin First published in XenServer 5.5.- Parameters:
c
- The connection the call is made onhost
- No descriptionport
- No descriptionbody
- No description- Returns:
- The response
- Throws:
Types.BadServerResponse
- Thrown if the response from the server contains an invalid status.Types.XenAPIException
- if the call failed.IOException
- if an error occurs during a send or receive. This includes cases where a payload is invalid JSON.
-
sendTestPostAsync
public static Task sendTestPostAsync(Connection c, String host, Long port, String body) throws Types.BadServerResponse, Types.XenAPIException, IOException Send the given body to the given host and port, using HTTPS, and print the response. This is used for debugging the SSL layer. Minimum allowed role: pool-admin First published in XenServer 5.5.- Parameters:
c
- The connection the call is made onhost
- No descriptionport
- No descriptionbody
- No description- Returns:
- Task
- Throws:
Types.BadServerResponse
- Thrown if the response from the server contains an invalid status.Types.XenAPIException
- if the call failed.IOException
- if an error occurs during a send or receive. This includes cases where a payload is invalid JSON.
-
certificateInstall
@Deprecated(since="1.290.0") public static void certificateInstall(Connection c, String name, String cert) throws Types.BadServerResponse, Types.XenAPIException, IOException Deprecated.since 1.290.0Install a TLS CA certificate, pool-wide. Minimum allowed role: pool-operator First published in XenServer 5.5.- Parameters:
c
- The connection the call is made onname
- A name to give the certificatecert
- The certificate in PEM format- Throws:
Types.BadServerResponse
- Thrown if the response from the server contains an invalid status.Types.XenAPIException
- if the call failed.IOException
- if an error occurs during a send or receive. This includes cases where a payload is invalid JSON.
-
certificateInstallAsync
@Deprecated(since="1.290.0") public static Task certificateInstallAsync(Connection c, String name, String cert) throws Types.BadServerResponse, Types.XenAPIException, IOException Deprecated.since 1.290.0Install a TLS CA certificate, pool-wide. Minimum allowed role: pool-operator First published in XenServer 5.5.- Parameters:
c
- The connection the call is made onname
- A name to give the certificatecert
- The certificate in PEM format- Returns:
- Task
- Throws:
Types.BadServerResponse
- Thrown if the response from the server contains an invalid status.Types.XenAPIException
- if the call failed.IOException
- if an error occurs during a send or receive. This includes cases where a payload is invalid JSON.
-
certificateUninstall
@Deprecated(since="1.290.0") public static void certificateUninstall(Connection c, String name) throws Types.BadServerResponse, Types.XenAPIException, IOException Deprecated.since 1.290.0Remove a pool-wide TLS CA certificate. Minimum allowed role: pool-operator First published in XenServer 5.5.- Parameters:
c
- The connection the call is made onname
- The certificate name- Throws:
Types.BadServerResponse
- Thrown if the response from the server contains an invalid status.Types.XenAPIException
- if the call failed.IOException
- if an error occurs during a send or receive. This includes cases where a payload is invalid JSON.
-
certificateUninstallAsync
@Deprecated(since="1.290.0") public static Task certificateUninstallAsync(Connection c, String name) throws Types.BadServerResponse, Types.XenAPIException, IOException Deprecated.since 1.290.0Remove a pool-wide TLS CA certificate. Minimum allowed role: pool-operator First published in XenServer 5.5.- Parameters:
c
- The connection the call is made onname
- The certificate name- Returns:
- Task
- Throws:
Types.BadServerResponse
- Thrown if the response from the server contains an invalid status.Types.XenAPIException
- if the call failed.IOException
- if an error occurs during a send or receive. This includes cases where a payload is invalid JSON.
-
certificateList
@Deprecated(since="1.290.0") public static Set<String> certificateList(Connection c) throws Types.BadServerResponse, Types.XenAPIException, IOException Deprecated.since 1.290.0List the names of all installed TLS CA certificates. Minimum allowed role: pool-operator First published in XenServer 5.5.- Parameters:
c
- The connection the call is made on- Returns:
- All installed certificates
- Throws:
Types.BadServerResponse
- Thrown if the response from the server contains an invalid status.Types.XenAPIException
- if the call failed.IOException
- if an error occurs during a send or receive. This includes cases where a payload is invalid JSON.
-
certificateListAsync
@Deprecated(since="1.290.0") public static Task certificateListAsync(Connection c) throws Types.BadServerResponse, Types.XenAPIException, IOException Deprecated.since 1.290.0List the names of all installed TLS CA certificates. Minimum allowed role: pool-operator First published in XenServer 5.5.- Parameters:
c
- The connection the call is made on- Returns:
- Task
- Throws:
Types.BadServerResponse
- Thrown if the response from the server contains an invalid status.Types.XenAPIException
- if the call failed.IOException
- if an error occurs during a send or receive. This includes cases where a payload is invalid JSON.
-
installCaCertificate
public static void installCaCertificate(Connection c, String name, String cert) throws Types.BadServerResponse, Types.XenAPIException, IOException Install a TLS CA certificate, pool-wide. Minimum allowed role: pool-operator First published in 1.290.0.- Parameters:
c
- The connection the call is made onname
- A name to give the certificatecert
- The certificate in PEM format- Throws:
Types.BadServerResponse
- Thrown if the response from the server contains an invalid status.Types.XenAPIException
- if the call failed.IOException
- if an error occurs during a send or receive. This includes cases where a payload is invalid JSON.
-
installCaCertificateAsync
public static Task installCaCertificateAsync(Connection c, String name, String cert) throws Types.BadServerResponse, Types.XenAPIException, IOException Install a TLS CA certificate, pool-wide. Minimum allowed role: pool-operator First published in 1.290.0.- Parameters:
c
- The connection the call is made onname
- A name to give the certificatecert
- The certificate in PEM format- Returns:
- Task
- Throws:
Types.BadServerResponse
- Thrown if the response from the server contains an invalid status.Types.XenAPIException
- if the call failed.IOException
- if an error occurs during a send or receive. This includes cases where a payload is invalid JSON.
-
uninstallCaCertificate
public static void uninstallCaCertificate(Connection c, String name) throws Types.BadServerResponse, Types.XenAPIException, IOException Remove a pool-wide TLS CA certificate. Minimum allowed role: pool-operator First published in 1.290.0.- Parameters:
c
- The connection the call is made onname
- The certificate name- Throws:
Types.BadServerResponse
- Thrown if the response from the server contains an invalid status.Types.XenAPIException
- if the call failed.IOException
- if an error occurs during a send or receive. This includes cases where a payload is invalid JSON.
-
uninstallCaCertificateAsync
public static Task uninstallCaCertificateAsync(Connection c, String name) throws Types.BadServerResponse, Types.XenAPIException, IOException Remove a pool-wide TLS CA certificate. Minimum allowed role: pool-operator First published in 1.290.0.- Parameters:
c
- The connection the call is made onname
- The certificate name- Returns:
- Task
- Throws:
Types.BadServerResponse
- Thrown if the response from the server contains an invalid status.Types.XenAPIException
- if the call failed.IOException
- if an error occurs during a send or receive. This includes cases where a payload is invalid JSON.
-
crlInstall
public static void crlInstall(Connection c, String name, String cert) throws Types.BadServerResponse, Types.XenAPIException, IOException Install a TLS CA-issued Certificate Revocation List, pool-wide. Minimum allowed role: pool-operator First published in XenServer 5.5.- Parameters:
c
- The connection the call is made onname
- A name to give the CRLcert
- The CRL- Throws:
Types.BadServerResponse
- Thrown if the response from the server contains an invalid status.Types.XenAPIException
- if the call failed.IOException
- if an error occurs during a send or receive. This includes cases where a payload is invalid JSON.
-
crlInstallAsync
public static Task crlInstallAsync(Connection c, String name, String cert) throws Types.BadServerResponse, Types.XenAPIException, IOException Install a TLS CA-issued Certificate Revocation List, pool-wide. Minimum allowed role: pool-operator First published in XenServer 5.5.- Parameters:
c
- The connection the call is made onname
- A name to give the CRLcert
- The CRL- Returns:
- Task
- Throws:
Types.BadServerResponse
- Thrown if the response from the server contains an invalid status.Types.XenAPIException
- if the call failed.IOException
- if an error occurs during a send or receive. This includes cases where a payload is invalid JSON.
-
crlUninstall
public static void crlUninstall(Connection c, String name) throws Types.BadServerResponse, Types.XenAPIException, IOException Remove a pool-wide TLS CA-issued Certificate Revocation List. Minimum allowed role: pool-operator First published in XenServer 5.5.- Parameters:
c
- The connection the call is made onname
- The CRL name- Throws:
Types.BadServerResponse
- Thrown if the response from the server contains an invalid status.Types.XenAPIException
- if the call failed.IOException
- if an error occurs during a send or receive. This includes cases where a payload is invalid JSON.
-
crlUninstallAsync
public static Task crlUninstallAsync(Connection c, String name) throws Types.BadServerResponse, Types.XenAPIException, IOException Remove a pool-wide TLS CA-issued Certificate Revocation List. Minimum allowed role: pool-operator First published in XenServer 5.5.- Parameters:
c
- The connection the call is made onname
- The CRL name- Returns:
- Task
- Throws:
Types.BadServerResponse
- Thrown if the response from the server contains an invalid status.Types.XenAPIException
- if the call failed.IOException
- if an error occurs during a send or receive. This includes cases where a payload is invalid JSON.
-
crlList
public static Set<String> crlList(Connection c) throws Types.BadServerResponse, Types.XenAPIException, IOException List the names of all installed TLS CA-issued Certificate Revocation Lists. Minimum allowed role: pool-operator First published in XenServer 5.5.- Parameters:
c
- The connection the call is made on- Returns:
- The names of all installed CRLs
- Throws:
Types.BadServerResponse
- Thrown if the response from the server contains an invalid status.Types.XenAPIException
- if the call failed.IOException
- if an error occurs during a send or receive. This includes cases where a payload is invalid JSON.
-
crlListAsync
public static Task crlListAsync(Connection c) throws Types.BadServerResponse, Types.XenAPIException, IOException List the names of all installed TLS CA-issued Certificate Revocation Lists. Minimum allowed role: pool-operator First published in XenServer 5.5.- Parameters:
c
- The connection the call is made on- Returns:
- Task
- Throws:
Types.BadServerResponse
- Thrown if the response from the server contains an invalid status.Types.XenAPIException
- if the call failed.IOException
- if an error occurs during a send or receive. This includes cases where a payload is invalid JSON.
-
certificateSync
public static void certificateSync(Connection c) throws Types.BadServerResponse, Types.XenAPIException, IOException Copy the TLS CA certificates and CRLs of the master to all slaves. Minimum allowed role: pool-operator First published in XenServer 5.5.- Parameters:
c
- The connection the call is made on- Throws:
Types.BadServerResponse
- Thrown if the response from the server contains an invalid status.Types.XenAPIException
- if the call failed.IOException
- if an error occurs during a send or receive. This includes cases where a payload is invalid JSON.
-
certificateSyncAsync
public static Task certificateSyncAsync(Connection c) throws Types.BadServerResponse, Types.XenAPIException, IOException Copy the TLS CA certificates and CRLs of the master to all slaves. Minimum allowed role: pool-operator First published in XenServer 5.5.- Parameters:
c
- The connection the call is made on- Returns:
- Task
- Throws:
Types.BadServerResponse
- Thrown if the response from the server contains an invalid status.Types.XenAPIException
- if the call failed.IOException
- if an error occurs during a send or receive. This includes cases where a payload is invalid JSON.
-
enableTlsVerification
public static void enableTlsVerification(Connection c) throws Types.BadServerResponse, Types.XenAPIException, IOException Enable TLS server certificate verification Minimum allowed role: pool-admin First published in 1.290.0.- Parameters:
c
- The connection the call is made on- Throws:
Types.BadServerResponse
- Thrown if the response from the server contains an invalid status.Types.XenAPIException
- if the call failed.IOException
- if an error occurs during a send or receive. This includes cases where a payload is invalid JSON.
-
enableRedoLog
public static void enableRedoLog(Connection c, SR sr) throws Types.BadServerResponse, Types.XenAPIException, IOException Enable the redo log on the given SR and start using it, unless HA is enabled. Minimum allowed role: pool-operator First published in XenServer 5.6.- Parameters:
c
- The connection the call is made onsr
- SR to hold the redo log.- Throws:
Types.BadServerResponse
- Thrown if the response from the server contains an invalid status.Types.XenAPIException
- if the call failed.IOException
- if an error occurs during a send or receive. This includes cases where a payload is invalid JSON.
-
enableRedoLogAsync
public static Task enableRedoLogAsync(Connection c, SR sr) throws Types.BadServerResponse, Types.XenAPIException, IOException Enable the redo log on the given SR and start using it, unless HA is enabled. Minimum allowed role: pool-operator First published in XenServer 5.6.- Parameters:
c
- The connection the call is made onsr
- SR to hold the redo log.- Returns:
- Task
- Throws:
Types.BadServerResponse
- Thrown if the response from the server contains an invalid status.Types.XenAPIException
- if the call failed.IOException
- if an error occurs during a send or receive. This includes cases where a payload is invalid JSON.
-
disableRedoLog
public static void disableRedoLog(Connection c) throws Types.BadServerResponse, Types.XenAPIException, IOException Disable the redo log if in use, unless HA is enabled. Minimum allowed role: pool-operator First published in XenServer 5.6.- Parameters:
c
- The connection the call is made on- Throws:
Types.BadServerResponse
- Thrown if the response from the server contains an invalid status.Types.XenAPIException
- if the call failed.IOException
- if an error occurs during a send or receive. This includes cases where a payload is invalid JSON.
-
disableRedoLogAsync
public static Task disableRedoLogAsync(Connection c) throws Types.BadServerResponse, Types.XenAPIException, IOException Disable the redo log if in use, unless HA is enabled. Minimum allowed role: pool-operator First published in XenServer 5.6.- Parameters:
c
- The connection the call is made on- Returns:
- Task
- Throws:
Types.BadServerResponse
- Thrown if the response from the server contains an invalid status.Types.XenAPIException
- if the call failed.IOException
- if an error occurs during a send or receive. This includes cases where a payload is invalid JSON.
-
setVswitchController
@Deprecated(since="XenServer 7.2") public static void setVswitchController(Connection c, String address) throws Types.BadServerResponse, Types.XenAPIException, IOException Deprecated.since XenServer 7.2Set the IP address of the vswitch controller. Minimum allowed role: pool-operator First published in XenServer 5.6.- Parameters:
c
- The connection the call is made onaddress
- IP address of the vswitch controller.- Throws:
Types.BadServerResponse
- Thrown if the response from the server contains an invalid status.Types.XenAPIException
- if the call failed.IOException
- if an error occurs during a send or receive. This includes cases where a payload is invalid JSON.
-
setVswitchControllerAsync
@Deprecated(since="XenServer 7.2") public static Task setVswitchControllerAsync(Connection c, String address) throws Types.BadServerResponse, Types.XenAPIException, IOException Deprecated.since XenServer 7.2Set the IP address of the vswitch controller. Minimum allowed role: pool-operator First published in XenServer 5.6.- Parameters:
c
- The connection the call is made onaddress
- IP address of the vswitch controller.- Returns:
- Task
- Throws:
Types.BadServerResponse
- Thrown if the response from the server contains an invalid status.Types.XenAPIException
- if the call failed.IOException
- if an error occurs during a send or receive. This includes cases where a payload is invalid JSON.
-
testArchiveTarget
public String testArchiveTarget(Connection c, Map<String, String> config) throws Types.BadServerResponse, Types.XenAPIException, IOExceptionThis call tests if a location is valid Minimum allowed role: pool-operator First published in XenServer 5.6 FP1.- Parameters:
c
- The connection the call is made onconfig
- Location config settings to test- Returns:
- An XMLRPC result
- Throws:
Types.BadServerResponse
- Thrown if the response from the server contains an invalid status.Types.XenAPIException
- if the call failed.IOException
- if an error occurs during a send or receive. This includes cases where a payload is invalid JSON.
-
enableLocalStorageCaching
public void enableLocalStorageCaching(Connection c) throws Types.BadServerResponse, Types.XenAPIException, IOException This call attempts to enable pool-wide local storage caching Minimum allowed role: pool-operator First published in XenServer 5.6 FP1.- Parameters:
c
- The connection the call is made on- Throws:
Types.BadServerResponse
- Thrown if the response from the server contains an invalid status.Types.XenAPIException
- if the call failed.IOException
- if an error occurs during a send or receive. This includes cases where a payload is invalid JSON.
-
enableLocalStorageCachingAsync
public Task enableLocalStorageCachingAsync(Connection c) throws Types.BadServerResponse, Types.XenAPIException, IOException This call attempts to enable pool-wide local storage caching Minimum allowed role: pool-operator First published in XenServer 5.6 FP1.- Parameters:
c
- The connection the call is made on- Returns:
- Task
- Throws:
Types.BadServerResponse
- Thrown if the response from the server contains an invalid status.Types.XenAPIException
- if the call failed.IOException
- if an error occurs during a send or receive. This includes cases where a payload is invalid JSON.
-
disableLocalStorageCaching
public void disableLocalStorageCaching(Connection c) throws Types.BadServerResponse, Types.XenAPIException, IOException This call disables pool-wide local storage caching Minimum allowed role: pool-operator First published in XenServer 5.6 FP1.- Parameters:
c
- The connection the call is made on- Throws:
Types.BadServerResponse
- Thrown if the response from the server contains an invalid status.Types.XenAPIException
- if the call failed.IOException
- if an error occurs during a send or receive. This includes cases where a payload is invalid JSON.
-
disableLocalStorageCachingAsync
public Task disableLocalStorageCachingAsync(Connection c) throws Types.BadServerResponse, Types.XenAPIException, IOException This call disables pool-wide local storage caching Minimum allowed role: pool-operator First published in XenServer 5.6 FP1.- Parameters:
c
- The connection the call is made on- Returns:
- Task
- Throws:
Types.BadServerResponse
- Thrown if the response from the server contains an invalid status.Types.XenAPIException
- if the call failed.IOException
- if an error occurs during a send or receive. This includes cases where a payload is invalid JSON.
-
getLicenseState
public Map<String,String> getLicenseState(Connection c) throws Types.BadServerResponse, Types.XenAPIException, IOException This call returns the license state for the pool Minimum allowed role: read-only First published in XenServer 6.2.- Parameters:
c
- The connection the call is made on- Returns:
- The pool's license state
- Throws:
Types.BadServerResponse
- Thrown if the response from the server contains an invalid status.Types.XenAPIException
- if the call failed.IOException
- if an error occurs during a send or receive. This includes cases where a payload is invalid JSON.
-
getLicenseStateAsync
public Task getLicenseStateAsync(Connection c) throws Types.BadServerResponse, Types.XenAPIException, IOException This call returns the license state for the pool Minimum allowed role: read-only First published in XenServer 6.2.- Parameters:
c
- The connection the call is made on- Returns:
- Task
- Throws:
Types.BadServerResponse
- Thrown if the response from the server contains an invalid status.Types.XenAPIException
- if the call failed.IOException
- if an error occurs during a send or receive. This includes cases where a payload is invalid JSON.
-
applyEdition
public void applyEdition(Connection c, String edition) throws Types.BadServerResponse, Types.XenAPIException, IOException Apply an edition to all hosts in the pool Minimum allowed role: pool-operator First published in XenServer 6.2.- Parameters:
c
- The connection the call is made onedition
- The requested edition- Throws:
Types.BadServerResponse
- Thrown if the response from the server contains an invalid status.Types.XenAPIException
- if the call failed.IOException
- if an error occurs during a send or receive. This includes cases where a payload is invalid JSON.
-
applyEditionAsync
public Task applyEditionAsync(Connection c, String edition) throws Types.BadServerResponse, Types.XenAPIException, IOException Apply an edition to all hosts in the pool Minimum allowed role: pool-operator First published in XenServer 6.2.- Parameters:
c
- The connection the call is made onedition
- The requested edition- Returns:
- Task
- Throws:
Types.BadServerResponse
- Thrown if the response from the server contains an invalid status.Types.XenAPIException
- if the call failed.IOException
- if an error occurs during a send or receive. This includes cases where a payload is invalid JSON.
-
enableSslLegacy
@Deprecated(since="XenServer 7.0") public void enableSslLegacy(Connection c) throws Types.BadServerResponse, Types.XenAPIException, IOException Deprecated.since XenServer 7.0Sets ssl_legacy true on each host, pool-master last. See Host.ssl_legacy and Host.set_ssl_legacy. Minimum allowed role: pool-operator First published in XenServer 7.0.- Parameters:
c
- The connection the call is made on- Throws:
Types.BadServerResponse
- Thrown if the response from the server contains an invalid status.Types.XenAPIException
- if the call failed.IOException
- if an error occurs during a send or receive. This includes cases where a payload is invalid JSON.
-
enableSslLegacyAsync
@Deprecated(since="XenServer 7.0") public Task enableSslLegacyAsync(Connection c) throws Types.BadServerResponse, Types.XenAPIException, IOException Deprecated.since XenServer 7.0Sets ssl_legacy true on each host, pool-master last. See Host.ssl_legacy and Host.set_ssl_legacy. Minimum allowed role: pool-operator First published in XenServer 7.0.- Parameters:
c
- The connection the call is made on- Returns:
- Task
- Throws:
Types.BadServerResponse
- Thrown if the response from the server contains an invalid status.Types.XenAPIException
- if the call failed.IOException
- if an error occurs during a send or receive. This includes cases where a payload is invalid JSON.
-
disableSslLegacy
@Deprecated(since="Citrix Hypervisor 8.2") public void disableSslLegacy(Connection c) throws Types.BadServerResponse, Types.XenAPIException, IOException Deprecated.since Citrix Hypervisor 8.2Sets ssl_legacy false on each host, pool-master last. See Host.ssl_legacy and Host.set_ssl_legacy. Minimum allowed role: pool-operator First published in XenServer 7.0.- Parameters:
c
- The connection the call is made on- Throws:
Types.BadServerResponse
- Thrown if the response from the server contains an invalid status.Types.XenAPIException
- if the call failed.IOException
- if an error occurs during a send or receive. This includes cases where a payload is invalid JSON.
-
disableSslLegacyAsync
@Deprecated(since="Citrix Hypervisor 8.2") public Task disableSslLegacyAsync(Connection c) throws Types.BadServerResponse, Types.XenAPIException, IOException Deprecated.since Citrix Hypervisor 8.2Sets ssl_legacy false on each host, pool-master last. See Host.ssl_legacy and Host.set_ssl_legacy. Minimum allowed role: pool-operator First published in XenServer 7.0.- Parameters:
c
- The connection the call is made on- Returns:
- Task
- Throws:
Types.BadServerResponse
- Thrown if the response from the server contains an invalid status.Types.XenAPIException
- if the call failed.IOException
- if an error occurs during a send or receive. This includes cases where a payload is invalid JSON.
-
setIgmpSnoopingEnabled
public void setIgmpSnoopingEnabled(Connection c, Boolean value) throws Types.BadServerResponse, Types.XenAPIException, IOException Enable or disable IGMP Snooping on the pool. Minimum allowed role: pool-operator First published in XenServer 7.3.- Parameters:
c
- The connection the call is made onvalue
- Enable or disable IGMP Snooping on the pool- Throws:
Types.BadServerResponse
- Thrown if the response from the server contains an invalid status.Types.XenAPIException
- if the call failed.IOException
- if an error occurs during a send or receive. This includes cases where a payload is invalid JSON.
-
setIgmpSnoopingEnabledAsync
public Task setIgmpSnoopingEnabledAsync(Connection c, Boolean value) throws Types.BadServerResponse, Types.XenAPIException, IOException Enable or disable IGMP Snooping on the pool. Minimum allowed role: pool-operator First published in XenServer 7.3.- Parameters:
c
- The connection the call is made onvalue
- Enable or disable IGMP Snooping on the pool- Returns:
- Task
- Throws:
Types.BadServerResponse
- Thrown if the response from the server contains an invalid status.Types.XenAPIException
- if the call failed.IOException
- if an error occurs during a send or receive. This includes cases where a payload is invalid JSON.
-
hasExtension
public Boolean hasExtension(Connection c, String name) throws Types.BadServerResponse, Types.XenAPIException, IOException Return true if the extension is available on the pool Minimum allowed role: pool-admin First published in XenServer 7.0.- Parameters:
c
- The connection the call is made onname
- The name of the API call- Returns:
- True if the extension exists, false otherwise
- Throws:
Types.BadServerResponse
- Thrown if the response from the server contains an invalid status.Types.XenAPIException
- if the call failed.IOException
- if an error occurs during a send or receive. This includes cases where a payload is invalid JSON.
-
hasExtensionAsync
public Task hasExtensionAsync(Connection c, String name) throws Types.BadServerResponse, Types.XenAPIException, IOException Return true if the extension is available on the pool Minimum allowed role: pool-admin First published in XenServer 7.0.- Parameters:
c
- The connection the call is made onname
- The name of the API call- Returns:
- Task
- Throws:
Types.BadServerResponse
- Thrown if the response from the server contains an invalid status.Types.XenAPIException
- if the call failed.IOException
- if an error occurs during a send or receive. This includes cases where a payload is invalid JSON.
-
addToGuestAgentConfig
public void addToGuestAgentConfig(Connection c, String key, String value) throws Types.BadServerResponse, Types.XenAPIException, IOException Add a key-value pair to the pool-wide guest agent configuration Minimum allowed role: pool-admin First published in XenServer 7.0.- Parameters:
c
- The connection the call is made onkey
- The key to addvalue
- The value to add- Throws:
Types.BadServerResponse
- Thrown if the response from the server contains an invalid status.Types.XenAPIException
- if the call failed.IOException
- if an error occurs during a send or receive. This includes cases where a payload is invalid JSON.
-
addToGuestAgentConfigAsync
public Task addToGuestAgentConfigAsync(Connection c, String key, String value) throws Types.BadServerResponse, Types.XenAPIException, IOException Add a key-value pair to the pool-wide guest agent configuration Minimum allowed role: pool-admin First published in XenServer 7.0.- Parameters:
c
- The connection the call is made onkey
- The key to addvalue
- The value to add- Returns:
- Task
- Throws:
Types.BadServerResponse
- Thrown if the response from the server contains an invalid status.Types.XenAPIException
- if the call failed.IOException
- if an error occurs during a send or receive. This includes cases where a payload is invalid JSON.
-
removeFromGuestAgentConfig
public void removeFromGuestAgentConfig(Connection c, String key) throws Types.BadServerResponse, Types.XenAPIException, IOException Remove a key-value pair from the pool-wide guest agent configuration Minimum allowed role: pool-admin First published in XenServer 7.0.- Parameters:
c
- The connection the call is made onkey
- The key to remove- Throws:
Types.BadServerResponse
- Thrown if the response from the server contains an invalid status.Types.XenAPIException
- if the call failed.IOException
- if an error occurs during a send or receive. This includes cases where a payload is invalid JSON.
-
removeFromGuestAgentConfigAsync
public Task removeFromGuestAgentConfigAsync(Connection c, String key) throws Types.BadServerResponse, Types.XenAPIException, IOException Remove a key-value pair from the pool-wide guest agent configuration Minimum allowed role: pool-admin First published in XenServer 7.0.- Parameters:
c
- The connection the call is made onkey
- The key to remove- Returns:
- Task
- Throws:
Types.BadServerResponse
- Thrown if the response from the server contains an invalid status.Types.XenAPIException
- if the call failed.IOException
- if an error occurs during a send or receive. This includes cases where a payload is invalid JSON.
-
rotateSecret
public static void rotateSecret(Connection c) throws Types.BadServerResponse, Types.XenAPIException, IOException, Types.InternalError, Types.HostIsSlave, Types.CannotContactHost, Types.HaIsEnabled, Types.NotSupportedDuringUpgrade Minimum allowed role: pool-admin First published in Citrix Hypervisor 8.2 Hotfix 2.- Parameters:
c
- The connection the call is made on- Throws:
Types.BadServerResponse
- Thrown if the response from the server contains an invalid status.Types.XenAPIException
- if the call failed.IOException
- if an error occurs during a send or receive. This includes cases where a payload is invalid JSON.Types.InternalError
- The server failed to handle your request, due to an internal error. The given message may give details useful for debugging the problem.Types.HostIsSlave
- You cannot make regular API calls directly on a supporter. Please pass API calls via the coordinator host.Types.CannotContactHost
- Cannot forward messages because the server cannot be contacted. The server may be switched off or there may be network connectivity problems.Types.HaIsEnabled
- The operation could not be performed because HA is enabled on the PoolTypes.NotSupportedDuringUpgrade
- This operation is not supported during an upgrade.
-
rotateSecretAsync
public static Task rotateSecretAsync(Connection c) throws Types.BadServerResponse, Types.XenAPIException, IOException, Types.InternalError, Types.HostIsSlave, Types.CannotContactHost, Types.HaIsEnabled, Types.NotSupportedDuringUpgrade Minimum allowed role: pool-admin First published in Citrix Hypervisor 8.2 Hotfix 2.- Parameters:
c
- The connection the call is made on- Returns:
- Task
- Throws:
Types.BadServerResponse
- Thrown if the response from the server contains an invalid status.Types.XenAPIException
- if the call failed.IOException
- if an error occurs during a send or receive. This includes cases where a payload is invalid JSON.Types.InternalError
- The server failed to handle your request, due to an internal error. The given message may give details useful for debugging the problem.Types.HostIsSlave
- You cannot make regular API calls directly on a supporter. Please pass API calls via the coordinator host.Types.CannotContactHost
- Cannot forward messages because the server cannot be contacted. The server may be switched off or there may be network connectivity problems.Types.HaIsEnabled
- The operation could not be performed because HA is enabled on the PoolTypes.NotSupportedDuringUpgrade
- This operation is not supported during an upgrade.
-
setRepositories
public void setRepositories(Connection c, Set<Repository> value) throws Types.BadServerResponse, Types.XenAPIException, IOException Set enabled set of repositories Minimum allowed role: pool-operator First published in 1.301.0.- Parameters:
c
- The connection the call is made onvalue
- The set of repositories to be enabled- Throws:
Types.BadServerResponse
- Thrown if the response from the server contains an invalid status.Types.XenAPIException
- if the call failed.IOException
- if an error occurs during a send or receive. This includes cases where a payload is invalid JSON.
-
setRepositoriesAsync
public Task setRepositoriesAsync(Connection c, Set<Repository> value) throws Types.BadServerResponse, Types.XenAPIException, IOException Set enabled set of repositories Minimum allowed role: pool-operator First published in 1.301.0.- Parameters:
c
- The connection the call is made onvalue
- The set of repositories to be enabled- Returns:
- Task
- Throws:
Types.BadServerResponse
- Thrown if the response from the server contains an invalid status.Types.XenAPIException
- if the call failed.IOException
- if an error occurs during a send or receive. This includes cases where a payload is invalid JSON.
-
addRepository
public void addRepository(Connection c, Repository value) throws Types.BadServerResponse, Types.XenAPIException, IOException Add a repository to the enabled set Minimum allowed role: pool-operator First published in 1.301.0.- Parameters:
c
- The connection the call is made onvalue
- The repository to be added to the enabled set- Throws:
Types.BadServerResponse
- Thrown if the response from the server contains an invalid status.Types.XenAPIException
- if the call failed.IOException
- if an error occurs during a send or receive. This includes cases where a payload is invalid JSON.
-
addRepositoryAsync
public Task addRepositoryAsync(Connection c, Repository value) throws Types.BadServerResponse, Types.XenAPIException, IOException Add a repository to the enabled set Minimum allowed role: pool-operator First published in 1.301.0.- Parameters:
c
- The connection the call is made onvalue
- The repository to be added to the enabled set- Returns:
- Task
- Throws:
Types.BadServerResponse
- Thrown if the response from the server contains an invalid status.Types.XenAPIException
- if the call failed.IOException
- if an error occurs during a send or receive. This includes cases where a payload is invalid JSON.
-
removeRepository
public void removeRepository(Connection c, Repository value) throws Types.BadServerResponse, Types.XenAPIException, IOException Remove a repository from the enabled set Minimum allowed role: pool-operator First published in 1.301.0.- Parameters:
c
- The connection the call is made onvalue
- The repository to be removed- Throws:
Types.BadServerResponse
- Thrown if the response from the server contains an invalid status.Types.XenAPIException
- if the call failed.IOException
- if an error occurs during a send or receive. This includes cases where a payload is invalid JSON.
-
removeRepositoryAsync
public Task removeRepositoryAsync(Connection c, Repository value) throws Types.BadServerResponse, Types.XenAPIException, IOException Remove a repository from the enabled set Minimum allowed role: pool-operator First published in 1.301.0.- Parameters:
c
- The connection the call is made onvalue
- The repository to be removed- Returns:
- Task
- Throws:
Types.BadServerResponse
- Thrown if the response from the server contains an invalid status.Types.XenAPIException
- if the call failed.IOException
- if an error occurs during a send or receive. This includes cases where a payload is invalid JSON.
-
syncUpdates
public String syncUpdates(Connection c, Boolean force, String token, String tokenId) throws Types.BadServerResponse, Types.XenAPIException, IOException Sync with the enabled repository Minimum allowed role: pool-operator First published in 1.329.0.- Parameters:
c
- The connection the call is made onforce
- If true local mirroring repo will be removed before syncingtoken
- The token for repository client authenticationtokenId
- The ID of the token- Returns:
- The SHA256 hash of updateinfo.xml.gz
- Throws:
Types.BadServerResponse
- Thrown if the response from the server contains an invalid status.Types.XenAPIException
- if the call failed.IOException
- if an error occurs during a send or receive. This includes cases where a payload is invalid JSON.
-
syncUpdatesAsync
public Task syncUpdatesAsync(Connection c, Boolean force, String token, String tokenId) throws Types.BadServerResponse, Types.XenAPIException, IOException Sync with the enabled repository Minimum allowed role: pool-operator First published in 1.329.0.- Parameters:
c
- The connection the call is made onforce
- If true local mirroring repo will be removed before syncingtoken
- The token for repository client authenticationtokenId
- The ID of the token- Returns:
- Task
- Throws:
Types.BadServerResponse
- Thrown if the response from the server contains an invalid status.Types.XenAPIException
- if the call failed.IOException
- if an error occurs during a send or receive. This includes cases where a payload is invalid JSON.
-
checkUpdateReadiness
public Set<Set<String>> checkUpdateReadiness(Connection c, Boolean requiresReboot) throws Types.BadServerResponse, Types.XenAPIException, IOException Check if the pool is ready to be updated. If not, report the reasons. Minimum allowed role: pool-operator First published in 1.304.0.- Parameters:
c
- The connection the call is made onrequiresReboot
- Assume that the update will require host reboots- Returns:
- A set of error codes with arguments, if the pool is not ready to update. An empty list means the pool can be updated.
- Throws:
Types.BadServerResponse
- Thrown if the response from the server contains an invalid status.Types.XenAPIException
- if the call failed.IOException
- if an error occurs during a send or receive. This includes cases where a payload is invalid JSON.
-
checkUpdateReadinessAsync
public Task checkUpdateReadinessAsync(Connection c, Boolean requiresReboot) throws Types.BadServerResponse, Types.XenAPIException, IOException Check if the pool is ready to be updated. If not, report the reasons. Minimum allowed role: pool-operator First published in 1.304.0.- Parameters:
c
- The connection the call is made onrequiresReboot
- Assume that the update will require host reboots- Returns:
- Task
- Throws:
Types.BadServerResponse
- Thrown if the response from the server contains an invalid status.Types.XenAPIException
- if the call failed.IOException
- if an error occurs during a send or receive. This includes cases where a payload is invalid JSON.
-
enableClientCertificateAuth
public void enableClientCertificateAuth(Connection c, String name) throws Types.BadServerResponse, Types.XenAPIException, IOException Enable client certificate authentication on the pool Minimum allowed role: pool-operator First published in 1.318.0.- Parameters:
c
- The connection the call is made onname
- The name (CN/SAN) that an incoming client certificate must have to allow authentication- Throws:
Types.BadServerResponse
- Thrown if the response from the server contains an invalid status.Types.XenAPIException
- if the call failed.IOException
- if an error occurs during a send or receive. This includes cases where a payload is invalid JSON.
-
enableClientCertificateAuthAsync
public Task enableClientCertificateAuthAsync(Connection c, String name) throws Types.BadServerResponse, Types.XenAPIException, IOException Enable client certificate authentication on the pool Minimum allowed role: pool-operator First published in 1.318.0.- Parameters:
c
- The connection the call is made onname
- The name (CN/SAN) that an incoming client certificate must have to allow authentication- Returns:
- Task
- Throws:
Types.BadServerResponse
- Thrown if the response from the server contains an invalid status.Types.XenAPIException
- if the call failed.IOException
- if an error occurs during a send or receive. This includes cases where a payload is invalid JSON.
-
disableClientCertificateAuth
public void disableClientCertificateAuth(Connection c) throws Types.BadServerResponse, Types.XenAPIException, IOException Disable client certificate authentication on the pool Minimum allowed role: pool-operator First published in 1.318.0.- Parameters:
c
- The connection the call is made on- Throws:
Types.BadServerResponse
- Thrown if the response from the server contains an invalid status.Types.XenAPIException
- if the call failed.IOException
- if an error occurs during a send or receive. This includes cases where a payload is invalid JSON.
-
disableClientCertificateAuthAsync
public Task disableClientCertificateAuthAsync(Connection c) throws Types.BadServerResponse, Types.XenAPIException, IOException Disable client certificate authentication on the pool Minimum allowed role: pool-operator First published in 1.318.0.- Parameters:
c
- The connection the call is made on- Returns:
- Task
- Throws:
Types.BadServerResponse
- Thrown if the response from the server contains an invalid status.Types.XenAPIException
- if the call failed.IOException
- if an error occurs during a send or receive. This includes cases where a payload is invalid JSON.
-
configureRepositoryProxy
public void configureRepositoryProxy(Connection c, String url, String username, String password) throws Types.BadServerResponse, Types.XenAPIException, IOException Configure proxy for RPM package repositories. Minimum allowed role: pool-operator First published in 21.3.0.- Parameters:
c
- The connection the call is made onurl
- The URL of the proxy serverusername
- The username used to authenticate with the proxy serverpassword
- The password used to authenticate with the proxy server- Throws:
Types.BadServerResponse
- Thrown if the response from the server contains an invalid status.Types.XenAPIException
- if the call failed.IOException
- if an error occurs during a send or receive. This includes cases where a payload is invalid JSON.
-
configureRepositoryProxyAsync
public Task configureRepositoryProxyAsync(Connection c, String url, String username, String password) throws Types.BadServerResponse, Types.XenAPIException, IOException Configure proxy for RPM package repositories. Minimum allowed role: pool-operator First published in 21.3.0.- Parameters:
c
- The connection the call is made onurl
- The URL of the proxy serverusername
- The username used to authenticate with the proxy serverpassword
- The password used to authenticate with the proxy server- Returns:
- Task
- Throws:
Types.BadServerResponse
- Thrown if the response from the server contains an invalid status.Types.XenAPIException
- if the call failed.IOException
- if an error occurs during a send or receive. This includes cases where a payload is invalid JSON.
-
disableRepositoryProxy
public void disableRepositoryProxy(Connection c) throws Types.BadServerResponse, Types.XenAPIException, IOException Disable the proxy for RPM package repositories. Minimum allowed role: pool-operator First published in 21.4.0.- Parameters:
c
- The connection the call is made on- Throws:
Types.BadServerResponse
- Thrown if the response from the server contains an invalid status.Types.XenAPIException
- if the call failed.IOException
- if an error occurs during a send or receive. This includes cases where a payload is invalid JSON.
-
disableRepositoryProxyAsync
public Task disableRepositoryProxyAsync(Connection c) throws Types.BadServerResponse, Types.XenAPIException, IOException Disable the proxy for RPM package repositories. Minimum allowed role: pool-operator First published in 21.4.0.- Parameters:
c
- The connection the call is made on- Returns:
- Task
- Throws:
Types.BadServerResponse
- Thrown if the response from the server contains an invalid status.Types.XenAPIException
- if the call failed.IOException
- if an error occurs during a send or receive. This includes cases where a payload is invalid JSON.
-
setUefiCertificates
@Deprecated(since="24.0.0") public void setUefiCertificates(Connection c, String value) throws Types.BadServerResponse, Types.XenAPIException, IOException Deprecated.since 24.0.0Set the UEFI certificates for a pool and all its hosts. Deprecated: use set_custom_uefi_certificates instead Minimum allowed role: pool-admin First published in 22.16.0.- Parameters:
c
- The connection the call is made onvalue
- The certificates to apply to the pool and its hosts- Throws:
Types.BadServerResponse
- Thrown if the response from the server contains an invalid status.Types.XenAPIException
- if the call failed.IOException
- if an error occurs during a send or receive. This includes cases where a payload is invalid JSON.
-
setUefiCertificatesAsync
@Deprecated(since="24.0.0") public Task setUefiCertificatesAsync(Connection c, String value) throws Types.BadServerResponse, Types.XenAPIException, IOException Deprecated.since 24.0.0Set the UEFI certificates for a pool and all its hosts. Deprecated: use set_custom_uefi_certificates instead Minimum allowed role: pool-admin First published in 22.16.0.- Parameters:
c
- The connection the call is made onvalue
- The certificates to apply to the pool and its hosts- Returns:
- Task
- Throws:
Types.BadServerResponse
- Thrown if the response from the server contains an invalid status.Types.XenAPIException
- if the call failed.IOException
- if an error occurs during a send or receive. This includes cases where a payload is invalid JSON.
-
setCustomUefiCertificates
public void setCustomUefiCertificates(Connection c, String value) throws Types.BadServerResponse, Types.XenAPIException, IOException 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 Minimum allowed role: pool-admin Experimental. First published in 24.0.0.- Parameters:
c
- The connection the call is made onvalue
- The certificates to apply to the pool and its hosts- Throws:
Types.BadServerResponse
- Thrown if the response from the server contains an invalid status.Types.XenAPIException
- if the call failed.IOException
- if an error occurs during a send or receive. This includes cases where a payload is invalid JSON.
-
setCustomUefiCertificatesAsync
public Task setCustomUefiCertificatesAsync(Connection c, String value) throws Types.BadServerResponse, Types.XenAPIException, IOException 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 Minimum allowed role: pool-admin Experimental. First published in 24.0.0.- Parameters:
c
- The connection the call is made onvalue
- The certificates to apply to the pool and its hosts- Returns:
- Task
- Throws:
Types.BadServerResponse
- Thrown if the response from the server contains an invalid status.Types.XenAPIException
- if the call failed.IOException
- if an error occurs during a send or receive. This includes cases where a payload is invalid JSON.
-
setHttpsOnly
public void setHttpsOnly(Connection c, Boolean value) throws Types.BadServerResponse, Types.XenAPIException, IOException updates all the host firewalls in the pool to open or close port 80 depending on the value Minimum allowed role: pool-operator Experimental. First published in 22.27.0.- Parameters:
c
- The connection the call is made onvalue
- true - http port 80 will be blocked, false - http port 80 will be open for the hosts in the pool- Throws:
Types.BadServerResponse
- Thrown if the response from the server contains an invalid status.Types.XenAPIException
- if the call failed.IOException
- if an error occurs during a send or receive. This includes cases where a payload is invalid JSON.
-
setHttpsOnlyAsync
public Task setHttpsOnlyAsync(Connection c, Boolean value) throws Types.BadServerResponse, Types.XenAPIException, IOException updates all the host firewalls in the pool to open or close port 80 depending on the value Minimum allowed role: pool-operator Experimental. First published in 22.27.0.- Parameters:
c
- The connection the call is made onvalue
- true - http port 80 will be blocked, false - http port 80 will be open for the hosts in the pool- Returns:
- Task
- Throws:
Types.BadServerResponse
- Thrown if the response from the server contains an invalid status.Types.XenAPIException
- if the call failed.IOException
- if an error occurs during a send or receive. This includes cases where a payload is invalid JSON.
-
setTelemetryNextCollection
public void setTelemetryNextCollection(Connection c, Date value) throws Types.BadServerResponse, Types.XenAPIException, IOException Set the timestamp for the next telemetry data collection. Minimum allowed role: pool-admin Experimental. First published in 23.9.0.- Parameters:
c
- The connection the call is made onvalue
- The earliest timestamp (in UTC) when the next round of telemetry collection can be carried out.- Throws:
Types.BadServerResponse
- Thrown if the response from the server contains an invalid status.Types.XenAPIException
- if the call failed.IOException
- if an error occurs during a send or receive. This includes cases where a payload is invalid JSON.
-
setTelemetryNextCollectionAsync
public Task setTelemetryNextCollectionAsync(Connection c, Date value) throws Types.BadServerResponse, Types.XenAPIException, IOException Set the timestamp for the next telemetry data collection. Minimum allowed role: pool-admin Experimental. First published in 23.9.0.- Parameters:
c
- The connection the call is made onvalue
- The earliest timestamp (in UTC) when the next round of telemetry collection can be carried out.- Returns:
- Task
- Throws:
Types.BadServerResponse
- Thrown if the response from the server contains an invalid status.Types.XenAPIException
- if the call failed.IOException
- if an error occurs during a send or receive. This includes cases where a payload is invalid JSON.
-
resetTelemetryUuid
public void resetTelemetryUuid(Connection c) throws Types.BadServerResponse, Types.XenAPIException, IOException Assign a new UUID to telemetry data. Minimum allowed role: pool-admin Experimental. First published in 23.9.0.- Parameters:
c
- The connection the call is made on- Throws:
Types.BadServerResponse
- Thrown if the response from the server contains an invalid status.Types.XenAPIException
- if the call failed.IOException
- if an error occurs during a send or receive. This includes cases where a payload is invalid JSON.
-
resetTelemetryUuidAsync
public Task resetTelemetryUuidAsync(Connection c) throws Types.BadServerResponse, Types.XenAPIException, IOException Assign a new UUID to telemetry data. Minimum allowed role: pool-admin Experimental. First published in 23.9.0.- Parameters:
c
- The connection the call is made on- Returns:
- Task
- Throws:
Types.BadServerResponse
- Thrown if the response from the server contains an invalid status.Types.XenAPIException
- if the call failed.IOException
- if an error occurs during a send or receive. This includes cases where a payload is invalid JSON.
-
configureUpdateSync
public void configureUpdateSync(Connection c, Types.UpdateSyncFrequency updateSyncFrequency, Long updateSyncDay) throws Types.BadServerResponse, Types.XenAPIException, IOException Configure periodic update synchronization to sync updates from a remote CDN Minimum allowed role: pool-operator Experimental. First published in 23.18.0.- Parameters:
c
- The connection the call is made onupdateSyncFrequency
- The frequency at which updates are synchronized from a remote CDN: daily or weekly.updateSyncDay
- 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.- Throws:
Types.BadServerResponse
- Thrown if the response from the server contains an invalid status.Types.XenAPIException
- if the call failed.IOException
- if an error occurs during a send or receive. This includes cases where a payload is invalid JSON.
-
configureUpdateSyncAsync
public Task configureUpdateSyncAsync(Connection c, Types.UpdateSyncFrequency updateSyncFrequency, Long updateSyncDay) throws Types.BadServerResponse, Types.XenAPIException, IOException Configure periodic update synchronization to sync updates from a remote CDN Minimum allowed role: pool-operator Experimental. First published in 23.18.0.- Parameters:
c
- The connection the call is made onupdateSyncFrequency
- The frequency at which updates are synchronized from a remote CDN: daily or weekly.updateSyncDay
- 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.- Returns:
- Task
- Throws:
Types.BadServerResponse
- Thrown if the response from the server contains an invalid status.Types.XenAPIException
- if the call failed.IOException
- if an error occurs during a send or receive. This includes cases where a payload is invalid JSON.
-
setUpdateSyncEnabled
public void setUpdateSyncEnabled(Connection c, Boolean value) throws Types.BadServerResponse, Types.XenAPIException, IOException enable or disable periodic update synchronization depending on the value Minimum allowed role: pool-operator Experimental. First published in 23.18.0.- Parameters:
c
- The connection the call is made onvalue
- true - enable periodic update synchronization, false - disable it- Throws:
Types.BadServerResponse
- Thrown if the response from the server contains an invalid status.Types.XenAPIException
- if the call failed.IOException
- if an error occurs during a send or receive. This includes cases where a payload is invalid JSON.
-
setUpdateSyncEnabledAsync
public Task setUpdateSyncEnabledAsync(Connection c, Boolean value) throws Types.BadServerResponse, Types.XenAPIException, IOException enable or disable periodic update synchronization depending on the value Minimum allowed role: pool-operator Experimental. First published in 23.18.0.- Parameters:
c
- The connection the call is made onvalue
- true - enable periodic update synchronization, false - disable it- Returns:
- Task
- Throws:
Types.BadServerResponse
- Thrown if the response from the server contains an invalid status.Types.XenAPIException
- if the call failed.IOException
- if an error occurs during a send or receive. This includes cases where a payload is invalid JSON.
-
setLocalAuthMaxThreads
public void setLocalAuthMaxThreads(Connection c, Long value) throws Types.BadServerResponse, Types.XenAPIException, IOException Minimum allowed role: pool-operator Experimental. First published in 23.27.0.- Parameters:
c
- The connection the call is made onvalue
- The new maximum- Throws:
Types.BadServerResponse
- Thrown if the response from the server contains an invalid status.Types.XenAPIException
- if the call failed.IOException
- if an error occurs during a send or receive. This includes cases where a payload is invalid JSON.
-
setExtAuthMaxThreads
public void setExtAuthMaxThreads(Connection c, Long value) throws Types.BadServerResponse, Types.XenAPIException, IOException Minimum allowed role: pool-operator Experimental. First published in 23.27.0.- Parameters:
c
- The connection the call is made onvalue
- The new maximum- Throws:
Types.BadServerResponse
- Thrown if the response from the server contains an invalid status.Types.XenAPIException
- if the call failed.IOException
- if an error occurs during a send or receive. This includes cases where a payload is invalid JSON.
-
getGuestSecurebootReadiness
public Types.PoolGuestSecurebootReadiness getGuestSecurebootReadiness(Connection c) throws Types.BadServerResponse, Types.XenAPIException, IOException Minimum allowed role: pool-operator Experimental. First published in 24.17.0.- Parameters:
c
- The connection the call is made on- Returns:
- The readiness of the pool
- Throws:
Types.BadServerResponse
- Thrown if the response from the server contains an invalid status.Types.XenAPIException
- if the call failed.IOException
- if an error occurs during a send or receive. This includes cases where a payload is invalid JSON.
-
getAll
public static Set<Pool> getAll(Connection c) throws Types.BadServerResponse, Types.XenAPIException, IOException Return a list of all the pools known to the system. Minimum allowed role: read-only First published in XenServer 4.0.- Parameters:
c
- The connection the call is made on- Returns:
- references to all objects
- Throws:
Types.BadServerResponse
- Thrown if the response from the server contains an invalid status.Types.XenAPIException
- if the call failed.IOException
- if an error occurs during a send or receive. This includes cases where a payload is invalid JSON.
-
getAllRecords
public static Map<Pool,Pool.Record> getAllRecords(Connection c) throws Types.BadServerResponse, Types.XenAPIException, IOException Return a map of pool references to pool records for all pools known to the system. Minimum allowed role: read-only First published in XenServer 4.0.- Parameters:
c
- The connection the call is made on- Returns:
- records of all objects
- Throws:
Types.BadServerResponse
- Thrown if the response from the server contains an invalid status.Types.XenAPIException
- if the call failed.IOException
- if an error occurs during a send or receive. This includes cases where a payload is invalid JSON.
-