Package com.xensource.xenapi
Class Host
java.lang.Object
com.xensource.xenapi.XenAPIObject
com.xensource.xenapi.Host
A physical host
First published in XenServer 4.0.
- Author:
- Cloud Software Group, Inc.
-
Nested Class Summary
Nested Classes -
Field Summary
Fields -
Method Summary
Modifier and TypeMethodDescriptionvoid
addTags
(Connection c, String value) Add the given value to the tags field of the given host.void
addToGuestVCPUsParams
(Connection c, String key, String value) Add the given key-value pair to the guest_VCPUs_params field of the given host.void
addToLicenseServer
(Connection c, String key, String value) Add the given key-value pair to the license_server field of the given host.void
addToLogging
(Connection c, String key, String value) Add the given key-value pair to the logging field of the given host.void
addToOtherConfig
(Connection c, String key, String value) Add the given key-value pair to the other_config field of the given host.void
applyEdition
(Connection c, String edition) Change to another edition, or reactivate the current edition after a license has expired.void
applyEdition
(Connection c, String edition, Boolean force) Change to another edition, or reactivate the current edition after a license has expired.void
apply all recommended guidances both on the host and on all HVM VMs on the host after updates are applied on the host Minimum allowed role: pool-operator Experimental.apply all recommended guidances both on the host and on all HVM VMs on the host after updates are applied on the host Minimum allowed role: pool-operator Experimental.applyUpdates
(Connection c, String hash) apply updates from current enabled repository on a host Minimum allowed role: pool-operator First published in 1.301.0.applyUpdatesAsync
(Connection c, String hash) apply updates from current enabled repository on a host Minimum allowed role: pool-operator First published in 1.301.0.void
Check this host can be evacuated.Check this host can be evacuated.void
backupRrds
(Connection c, Double delay) This causes the RRDs to be backed up to the master Minimum allowed role: pool-admin First published in XenServer 5.0.void
bugreportUpload
(Connection c, String url, Map<String, String> options) Run xen-bugtool --yestoall and upload the output to support Minimum allowed role: pool-operator First published in XenServer 4.0.bugreportUploadAsync
(Connection c, String url, Map<String, String> options) Run xen-bugtool --yestoall and upload the output to support Minimum allowed role: pool-operator First published in XenServer 4.0.callExtension
(Connection c, String call) Call an API extension on this host Minimum allowed role: pool-admin First published in XenServer 7.1.callPlugin
(Connection c, String plugin, String fn, Map<String, String> args) Call an API plugin on this host Minimum allowed role: pool-admin First published in XenServer 5.0.callPluginAsync
(Connection c, String plugin, String fn, Map<String, String> args) Call an API plugin on this host Minimum allowed role: pool-admin First published in XenServer 5.0.Computes the amount of free memory on the host.Computes the amount of free memory on the host.Computes the virtualization memory overhead of a host.Computes the virtualization memory overhead of a host.createNewBlob
(Connection c, String name, String mimeType) Create a placeholder for a named binary blob of data that is associated with this host 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 host 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 host 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 host Minimum allowed role: pool-operator First published in XenServer 5.0.void
Declare that a host is dead.Declare that a host is dead.void
Destroy specified host record in database Minimum allowed role: pool-operator First published in XenServer 4.0.Destroy specified host record in database Minimum allowed role: pool-operator First published in XenServer 4.0.void
Puts the host into a state in which no new VMs can be started.Puts the host into a state in which no new VMs can be started.Disable console output to the physical display device next time this host boots Minimum allowed role: pool-operator First published in XenServer 6.5 SP1.Disable console output to the physical display device next time this host boots Minimum allowed role: pool-operator First published in XenServer 6.5 SP1.void
disableExternalAuth
(Connection c, Map<String, String> config) This call disables external authentication on the local host Minimum allowed role: pool-admin First published in XenServer 5.5.void
Disable the use of a local SR for caching purposes Minimum allowed role: pool-operator First published in XenServer 5.6 FP1.dmesg
(Connection c) Get the host xen dmesg.Get the host xen dmesg.Get the host xen dmesg, and clear the buffer.Get the host xen dmesg, and clear the buffer.static void
Clear the pending mandatory guidance on this host Minimum allowed role: Not Applicable Experimental.static void
Disable TLS verification for this host only Minimum allowed role: Not Applicable First published in 1.290.0.static void
emergencyHaDisable
(Connection c, Boolean soft) This call disables HA on the local host.static void
Reenable TLS verification for this host only Minimum allowed role: Not Applicable First published in 1.298.0.static void
Delete the current TLS server certificate and replace by a new, self-signed one.void
enable
(Connection c) Puts the host into a state in which new VMs can be started.Puts the host into a state in which new VMs can be started.Enable console output to the physical display device next time this host boots Minimum allowed role: pool-operator First published in XenServer 6.5 SP1.Enable console output to the physical display device next time this host boots Minimum allowed role: pool-operator First published in XenServer 6.5 SP1.void
enableExternalAuth
(Connection c, Map<String, String> config, String serviceName, String authType) This call enables external authentication on a host Minimum allowed role: pool-admin First published in XenServer 5.5.void
Enable the use of a local SR for caching purposes Minimum allowed role: pool-operator First published in XenServer 5.6 FP1.boolean
If obj is a Host, compares XenAPI references for equality.void
Migrate all VMs off of this host, where possible.void
evacuate
(Connection c, Network network) Migrate all VMs off of this host, where possible.void
evacuate
(Connection c, Network network, Long evacuateBatchSize) Migrate all VMs off of this host, where possible.Migrate all VMs off of this host, where possible.evacuateAsync
(Connection c, Network network) Migrate all VMs off of this host, where possible.evacuateAsync
(Connection c, Network network, Long evacuateBatchSize) Migrate all VMs off of this host, where possible.void
forgetDataSourceArchives
(Connection c, String dataSource) Forget the recorded statistics related to the specified data source Minimum allowed role: pool-operator First published in XenServer 5.0.Get the address field of the given host.getAll
(Connection c) Return a list of all the hosts known to the system.Get the allowed_operations field of the given host.static Map<Host,
Host.Record> Return a map of host references to host records for all hosts known to the system.Get the API_version/major field of the given host.Get the API_version/minor field of the given host.Get the API_version/vendor field of the given host.Get the API_version/vendor_implementation field of the given host.Get the bios_strings field of the given host.Get the blobs field of the given host.getByNameLabel
(Connection c, String label) Get all the host instances with the given label.static Host
getByUuid
(Connection c, String uuid) Get a reference to the host instance with the specified UUID.Get the capabilities field of the given host.Get the certificates field of the given host.Get the chipset_info field of the given host.Get the control_domain field of the given host.Get the cpu_configuration field of the given host.Get the cpu_info field of the given host.Get the crashdumps field of the given host.Get the crash_dump_sr field of the given host.Get the current_operations field of the given host.Minimum allowed role: read-only First published in XenServer 5.0.Get the display field of the given host.Get the edition field of the given host.Get the editions field of the given host.Get the enabled field of the given host.Get the external_auth_configuration field of the given host.Get the external_auth_service_name field of the given host.Get the external_auth_type field of the given host.Get the features field of the given host.Get the guest_VCPUs_params field of the given host.Get the ha_network_peers field of the given host.Get the ha_statefiles field of the given host.Get the host_CPUs field of the given host.Get the hostname field of the given host.Get the https_only field of the given host.Get the iscsi_iqn field of the given host.Get the last_software_update field of the given host.Get the last_update_hash field of the given host.Get the latest_synced_updates_applied field of the given host.Get the license_params field of the given host.Get the license_server field of the given host.Get the local_cache_sr field of the given host.getLog
(Connection c) Get the host's log file Minimum allowed role: read-only First published in XenServer 4.0.Get the host's log file Minimum allowed role: read-only First published in XenServer 4.0.Get the logging field of the given host.Returns the management interface for the specified host Minimum allowed role: pool-operator First published in XenServer 6.1.Returns the management interface for the specified host Minimum allowed role: pool-operator First published in XenServer 6.1.Get the memory/overhead field of the given host.Get the metrics field of the given host.Get the multipathing field of the given host.Get the name/description field of the given host.Get the name/label field of the given host.Get the numa_affinity_policy field of the given host.Get the other_config field of the given host.Deprecated.since XenServer 7.1Get the PBDs field of the given host.Get the PCIs field of the given host.Get the pending_guidances field of the given host.Get the pending_guidances_full field of the given host.Get the pending_guidances_recommended field of the given host.Get the PGPUs field of the given host.Get the PIFs field of the given host.Get the power_on_config field of the given host.Get the power_on_mode field of the given host.Get the PUSBs field of the given host.Get a record containing the current state of the given host.Get the resident_VMs field of the given host.Gets xen's sched-gran on a host Minimum allowed role: Not Applicable First published in 1.271.0.Gets xen's sched-gran on a host Minimum allowed role: Not Applicable First published in 1.271.0.Get the sched_policy field of the given host.Get the installed server public TLS certificate.Get the installed server public TLS certificate.This call queries the host's clock for the current time in the host's local timezone Minimum allowed role: read-only First published in XenServer 5.6 FP1.This call queries the host's clock for the current time Minimum allowed role: read-only First published in XenServer 5.0.Get the software_version field of the given host.Deprecated.since Citrix Hypervisor 8.2Get the supported_bootloaders field of the given host.Get the suspend_image_sr field of the given host.Minimum allowed role: read-only First published in XenServer 4.1.Get the tags field of the given host.Get the tls_verification_enabled field of the given host.Deprecated.since 22.16.0Deprecated.since XenServer 6.1Deprecated.since XenServer 6.1Get the updates field of the given host.Get the updates_requiring_reboot field of the given host.Get the uuid field of the given host.Get the virtual_hardware_platform_versions field of the given host.Return a set of VMs which prevent the host being evacuated, with per-VM error codes Minimum allowed role: read-only First published in XenServer 5.0.Return a set of VMs which prevent the host being evacuated, with per-VM error codes Minimum allowed role: read-only First published in XenServer 5.0.hasExtension
(Connection c, String name) Return true if the extension is available on the host Minimum allowed role: pool-admin First published in XenServer 7.1.hasExtensionAsync
(Connection c, String name) Return true if the extension is available on the host Minimum allowed role: pool-admin First published in XenServer 7.1.int
hashCode()
void
installServerCertificate
(Connection c, String certificate, String privateKey, String certificateChain) Install the TLS server certificate.installServerCertificateAsync
(Connection c, String certificate, String privateKey, String certificateChain) Install the TLS server certificate.void
licenseAdd
(Connection c, String contents) Apply a new license to a host Minimum allowed role: pool-operator First published in XenServer 6.5 SP1 Hotfix 31.licenseAddAsync
(Connection c, String contents) Apply a new license to a host Minimum allowed role: pool-operator First published in XenServer 6.5 SP1 Hotfix 31.void
licenseApply
(Connection c, String contents) Deprecated.since XenServer 6.2licenseApplyAsync
(Connection c, String contents) Deprecated.since XenServer 6.2void
Remove any license file from the specified host, and switch that host to the unlicensed edition Minimum allowed role: pool-operator First published in XenServer 6.5 SP1 Hotfix 31.Remove any license file from the specified host, and switch that host to the unlicensed edition Minimum allowed role: pool-operator First published in XenServer 6.5 SP1 Hotfix 31.List all supported methods Minimum allowed role: read-only First published in XenServer 4.0.static void
localManagementReconfigure
(Connection c, String iface) Reconfigure the management network interface.static void
Disable the management network interface Minimum allowed role: pool-operator First published in XenServer 4.1.static void
managementReconfigure
(Connection c, PIF pif) Reconfigure the management network interface Minimum allowed role: pool-operator First published in XenServer 4.1.static Task
managementReconfigureAsync
(Connection c, PIF pif) Reconfigure the management network interface Minimum allowed role: pool-operator First published in XenServer 4.1.migrateReceive
(Connection c, Network network, Map<String, String> options) Prepare to receive a VM, returning a token which can be passed to VM.migrate.migrateReceiveAsync
(Connection c, Network network, Map<String, String> options) Prepare to receive a VM, returning a token which can be passed to VM.migrate.void
Attempt to power-on the host (if the capability exists).Attempt to power-on the host (if the capability exists).queryDataSource
(Connection c, String dataSource) Query the latest value of the specified data source Minimum allowed role: read-only First published in XenServer 5.0.void
reboot
(Connection c) Reboot the host.Reboot the host.void
recordDataSource
(Connection c, String dataSource) Start recording the specified data source Minimum allowed role: pool-operator First published in XenServer 5.0.void
Deprecated.since XenServer 7.1Deprecated.since XenServer 7.1void
Replace the internal self-signed host certficate with a new one.Replace the internal self-signed host certficate with a new one.void
Remove the given key and its corresponding value from the guest_VCPUs_params field of the given host.void
removeFromLicenseServer
(Connection c, String key) Remove the given key and its corresponding value from the license_server field of the given host.void
removeFromLogging
(Connection c, String key) Remove the given key and its corresponding value from the logging field of the given host.void
removeFromOtherConfig
(Connection c, String key) Remove the given key and its corresponding value from the other_config field of the given host.void
removeTags
(Connection c, String value) Remove the given value from the tags field of the given host.void
Deprecated.since XenServer 7.0void
Delete the current TLS server certificate and replace by a new, self-signed one.Delete the current TLS server certificate and replace by a new, self-signed one.void
Restarts the agent after a 10 second pause.Restarts the agent after a 10 second pause.Retrieves recommended host migrations to perform when evacuating the host from the wlb server.Retrieves recommended host migrations to perform when evacuating the host from the wlb server.void
sendDebugKeys
(Connection c, String keys) Inject the given string as debugging keys into Xen Minimum allowed role: pool-admin First published in XenServer 4.0.sendDebugKeysAsync
(Connection c, String keys) Inject the given string as debugging keys into Xen Minimum allowed role: pool-admin First published in XenServer 4.0.void
setAddress
(Connection c, String address) Set the address field of the given host.void
setCpuFeatures
(Connection c, String features) Deprecated.since XenServer 7.0void
setCrashDumpSr
(Connection c, SR crashDumpSr) Set the crash_dump_sr field of the given host.void
setDisplay
(Connection c, Types.HostDisplay display) Set the display field of the given host.void
setGuestVCPUsParams
(Connection c, Map<String, String> guestVCPUsParams) Set the guest_VCPUs_params field of the given host.void
setHostname
(Connection c, String hostname) Set the hostname field of the given host.void
setHostnameLive
(Connection c, String hostname) Sets the host name to the specified string.void
setHttpsOnly
(Connection c, Boolean value) updates the host firewall to open or close port 80 depending on the value Minimum allowed role: pool-operator Experimental.setHttpsOnlyAsync
(Connection c, Boolean value) updates the host firewall to open or close port 80 depending on the value Minimum allowed role: pool-operator Experimental.void
setIscsiIqn
(Connection c, String value) Sets the initiator IQN for the host Minimum allowed role: pool-operator First published in XenServer 7.5.setIscsiIqnAsync
(Connection c, String value) Sets the initiator IQN for the host Minimum allowed role: pool-operator First published in XenServer 7.5.void
setLicenseServer
(Connection c, Map<String, String> licenseServer) Set the license_server field of the given host.void
setLogging
(Connection c, Map<String, String> logging) Set the logging field of the given host.void
setMultipathing
(Connection c, Boolean value) Specifies whether multipathing is enabled Minimum allowed role: pool-operator First published in XenServer 7.5.setMultipathingAsync
(Connection c, Boolean value) Specifies whether multipathing is enabled Minimum allowed role: pool-operator First published in XenServer 7.5.void
setNameDescription
(Connection c, String description) Set the name/description field of the given host.void
setNameLabel
(Connection c, String label) Set the name/label field of the given host.void
Set VM placement NUMA affinity policy Minimum allowed role: pool-admin Experimental.Set VM placement NUMA affinity policy Minimum allowed role: pool-admin Experimental.void
setOtherConfig
(Connection c, Map<String, String> otherConfig) Set the other_config field of the given host.void
setPowerOnMode
(Connection c, String powerOnMode, Map<String, String> powerOnConfig) Set the power-on-mode, host, user and password Minimum allowed role: pool-operator First published in XenServer 5.6 FP1.setPowerOnModeAsync
(Connection c, String powerOnMode, Map<String, String> powerOnConfig) Set the power-on-mode, host, user and password Minimum allowed role: pool-operator First published in XenServer 5.6 FP1.void
setSchedGran
(Connection c, Types.HostSchedGran value) Sets xen's sched-gran on a host.setSchedGranAsync
(Connection c, Types.HostSchedGran value) Sets xen's sched-gran on a host.void
setSslLegacy
(Connection c, Boolean value) Enable/disable SSLv3 for interoperability with older server versions.setSslLegacyAsync
(Connection c, Boolean value) Enable/disable SSLv3 for interoperability with older server versions.void
setSuspendImageSr
(Connection c, SR suspendImageSr) Set the suspend_image_sr field of the given host.void
setTags
(Connection c, Set<String> tags) Set the tags field of the given host.void
setUefiCertificates
(Connection c, String value) Deprecated.since 22.16.0setUefiCertificatesAsync
(Connection c, String value) Deprecated.since 22.16.0void
Shutdown the host.static void
Shuts the agent down after a 10 second pause.Shutdown the host.void
This causes the synchronisation of the non-database data (messages, RRDs and so on) stored on the master to be synchronised with the host Minimum allowed role: pool-admin First published in XenServer 5.0.void
Re-configure syslog logging Minimum allowed role: pool-operator First published in XenServer 4.1.Re-configure syslog logging Minimum allowed role: pool-operator First published in XenServer 4.1.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 Host, compares XenAPI references for equality. -
hashCode
public int hashCode() -
getRecord
public Host.Record getRecord(Connection c) throws Types.BadServerResponse, Types.XenAPIException, IOException Get a record containing the current state of the given host. 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 Host getByUuid(Connection c, String uuid) throws Types.BadServerResponse, Types.XenAPIException, IOException Get a reference to the host 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.
-
getByNameLabel
public static Set<Host> getByNameLabel(Connection c, String label) throws Types.BadServerResponse, Types.XenAPIException, IOException Get all the host instances with the given label. Minimum allowed role: read-only First published in XenServer 4.0.- Parameters:
c
- The connection the call is made onlabel
- label of object to return- Returns:
- references to objects with matching names
- 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 host. 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 host. 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 host. 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.
-
getMemoryOverhead
public Long getMemoryOverhead(Connection c) throws Types.BadServerResponse, Types.XenAPIException, IOException Get the memory/overhead field of the given host. 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.
-
getAllowedOperations
public Set<Types.HostAllowedOperations> getAllowedOperations(Connection c) throws Types.BadServerResponse, Types.XenAPIException, IOException Get the allowed_operations field of the given host. 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.HostAllowedOperations> getCurrentOperations(Connection c) throws Types.BadServerResponse, Types.XenAPIException, IOException Get the current_operations field of the given host. 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.
-
getAPIVersionMajor
public Long getAPIVersionMajor(Connection c) throws Types.BadServerResponse, Types.XenAPIException, IOException Get the API_version/major field of the given host. 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.
-
getAPIVersionMinor
public Long getAPIVersionMinor(Connection c) throws Types.BadServerResponse, Types.XenAPIException, IOException Get the API_version/minor field of the given host. 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.
-
getAPIVersionVendor
public String getAPIVersionVendor(Connection c) throws Types.BadServerResponse, Types.XenAPIException, IOException Get the API_version/vendor field of the given host. 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.
-
getAPIVersionVendorImplementation
public Map<String,String> getAPIVersionVendorImplementation(Connection c) throws Types.BadServerResponse, Types.XenAPIException, IOException Get the API_version/vendor_implementation field of the given host. 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.
-
getEnabled
public Boolean getEnabled(Connection c) throws Types.BadServerResponse, Types.XenAPIException, IOException Get the enabled field of the given host. 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.
-
getSoftwareVersion
public Map<String,String> getSoftwareVersion(Connection c) throws Types.BadServerResponse, Types.XenAPIException, IOException Get the software_version field of the given host. 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 host. 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.
-
getCapabilities
public Set<String> getCapabilities(Connection c) throws Types.BadServerResponse, Types.XenAPIException, IOException Get the capabilities field of the given host. 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.
-
getCpuConfiguration
public Map<String,String> getCpuConfiguration(Connection c) throws Types.BadServerResponse, Types.XenAPIException, IOException Get the cpu_configuration field of the given host. 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.
-
getSchedPolicy
public String getSchedPolicy(Connection c) throws Types.BadServerResponse, Types.XenAPIException, IOException Get the sched_policy field of the given host. 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.
-
getSupportedBootloaders
public Set<String> getSupportedBootloaders(Connection c) throws Types.BadServerResponse, Types.XenAPIException, IOException Get the supported_bootloaders field of the given host. 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.
-
getResidentVMs
public Set<VM> getResidentVMs(Connection c) throws Types.BadServerResponse, Types.XenAPIException, IOException Get the resident_VMs field of the given host. 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.
-
getLogging
public Map<String,String> getLogging(Connection c) throws Types.BadServerResponse, Types.XenAPIException, IOException Get the logging field of the given host. 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.
-
getPIFs
public Set<PIF> getPIFs(Connection c) throws Types.BadServerResponse, Types.XenAPIException, IOException Get the PIFs field of the given host. 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 host. 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 host. 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.
-
getCrashdumps
public Set<HostCrashdump> getCrashdumps(Connection c) throws Types.BadServerResponse, Types.XenAPIException, IOException Get the crashdumps field of the given host. 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.
-
getPatches
@Deprecated(since="XenServer 7.1") public Set<HostPatch> getPatches(Connection c) throws Types.BadServerResponse, Types.XenAPIException, IOException Deprecated.since XenServer 7.1Get the patches field of the given host. 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.
-
getUpdates
public Set<PoolUpdate> getUpdates(Connection c) throws Types.BadServerResponse, Types.XenAPIException, IOException Get the updates field of the given host. 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.
-
getPBDs
public Set<PBD> getPBDs(Connection c) throws Types.BadServerResponse, Types.XenAPIException, IOException Get the PBDs field of the given host. 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.
-
getHostCPUs
public Set<HostCpu> getHostCPUs(Connection c) throws Types.BadServerResponse, Types.XenAPIException, IOException Get the host_CPUs field of the given host. 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.
-
getCpuInfo
public Map<String,String> getCpuInfo(Connection c) throws Types.BadServerResponse, Types.XenAPIException, IOException Get the cpu_info field of the given host. 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.
-
getHostname
public String getHostname(Connection c) throws Types.BadServerResponse, Types.XenAPIException, IOException Get the hostname field of the given host. 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.
-
getAddress
public String getAddress(Connection c) throws Types.BadServerResponse, Types.XenAPIException, IOException Get the address field of the given host. 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.
-
getMetrics
public HostMetrics getMetrics(Connection c) throws Types.BadServerResponse, Types.XenAPIException, IOException Get the metrics field of the given host. 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.
-
getLicenseParams
public Map<String,String> getLicenseParams(Connection c) throws Types.BadServerResponse, Types.XenAPIException, IOException Get the license_params field of the given host. 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.
-
getHaStatefiles
public Set<String> getHaStatefiles(Connection c) throws Types.BadServerResponse, Types.XenAPIException, IOException Get the ha_statefiles field of the given host. 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.
-
getHaNetworkPeers
public Set<String> getHaNetworkPeers(Connection c) throws Types.BadServerResponse, Types.XenAPIException, IOException Get the ha_network_peers field of the given host. 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 host. 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 host. 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.
-
getExternalAuthType
public String getExternalAuthType(Connection c) throws Types.BadServerResponse, Types.XenAPIException, IOException Get the external_auth_type field of the given host. 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.
-
getExternalAuthServiceName
public String getExternalAuthServiceName(Connection c) throws Types.BadServerResponse, Types.XenAPIException, IOException Get the external_auth_service_name field of the given host. 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.
-
getExternalAuthConfiguration
public Map<String,String> getExternalAuthConfiguration(Connection c) throws Types.BadServerResponse, Types.XenAPIException, IOException Get the external_auth_configuration field of the given host. 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.
-
getEdition
public String getEdition(Connection c) throws Types.BadServerResponse, Types.XenAPIException, IOException Get the edition field of the given host. 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.
-
getLicenseServer
public Map<String,String> getLicenseServer(Connection c) throws Types.BadServerResponse, Types.XenAPIException, IOException Get the license_server field of the given host. 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.
-
getBiosStrings
public Map<String,String> getBiosStrings(Connection c) throws Types.BadServerResponse, Types.XenAPIException, IOException Get the bios_strings field of the given host. 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.
-
getPowerOnMode
public String getPowerOnMode(Connection c) throws Types.BadServerResponse, Types.XenAPIException, IOException Get the power_on_mode field of the given host. 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.
-
getPowerOnConfig
public Map<String,String> getPowerOnConfig(Connection c) throws Types.BadServerResponse, Types.XenAPIException, IOException Get the power_on_config field of the given host. 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.
-
getLocalCacheSr
public SR getLocalCacheSr(Connection c) throws Types.BadServerResponse, Types.XenAPIException, IOException Get the local_cache_sr field of the given host. Minimum allowed role: read-only First published in XenServer 5.6 FP1.- 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.
-
getChipsetInfo
public Map<String,String> getChipsetInfo(Connection c) throws Types.BadServerResponse, Types.XenAPIException, IOException Get the chipset_info field of the given host. 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.
-
getPCIs
public Set<PCI> getPCIs(Connection c) throws Types.BadServerResponse, Types.XenAPIException, IOException Get the PCIs field of the given host. 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.
-
getPGPUs
public Set<PGPU> getPGPUs(Connection c) throws Types.BadServerResponse, Types.XenAPIException, IOException Get the PGPUs field of the given host. 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.
-
getPUSBs
public Set<PUSB> getPUSBs(Connection c) throws Types.BadServerResponse, Types.XenAPIException, IOException Get the PUSBs field of the given host. 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.
-
getSslLegacy
@Deprecated(since="Citrix Hypervisor 8.2") public Boolean getSslLegacy(Connection c) throws Types.BadServerResponse, Types.XenAPIException, IOException Deprecated.since Citrix Hypervisor 8.2Get the ssl_legacy field of the given host. 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.
-
getGuestVCPUsParams
public Map<String,String> getGuestVCPUsParams(Connection c) throws Types.BadServerResponse, Types.XenAPIException, IOException Get the guest_VCPUs_params field of the given host. Minimum allowed role: read-only First published in XenServer 6.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.
-
getDisplay
public Types.HostDisplay getDisplay(Connection c) throws Types.BadServerResponse, Types.XenAPIException, IOException Get the display field of the given host. Minimum allowed role: read-only First published in XenServer 6.5 SP1.- 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.
-
getVirtualHardwarePlatformVersions
public Set<Long> getVirtualHardwarePlatformVersions(Connection c) throws Types.BadServerResponse, Types.XenAPIException, IOException Get the virtual_hardware_platform_versions field of the given host. Minimum allowed role: read-only First published in XenServer 6.5 SP1.- 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.
-
getControlDomain
public VM getControlDomain(Connection c) throws Types.BadServerResponse, Types.XenAPIException, IOException Get the control_domain field of the given host. 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.
-
getUpdatesRequiringReboot
public Set<PoolUpdate> getUpdatesRequiringReboot(Connection c) throws Types.BadServerResponse, Types.XenAPIException, IOException Get the updates_requiring_reboot field of the given host. 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.
-
getFeatures
public Set<Feature> getFeatures(Connection c) throws Types.BadServerResponse, Types.XenAPIException, IOException Get the features field of the given host. Minimum allowed role: read-only First published in XenServer 7.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.
-
getIscsiIqn
public String getIscsiIqn(Connection c) throws Types.BadServerResponse, Types.XenAPIException, IOException Get the iscsi_iqn field of the given host. Minimum allowed role: read-only First published in XenServer 7.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.
-
getMultipathing
public Boolean getMultipathing(Connection c) throws Types.BadServerResponse, Types.XenAPIException, IOException Get the multipathing field of the given host. Minimum allowed role: read-only First published in XenServer 7.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.
-
getUefiCertificates
@Deprecated(since="22.16.0") public String getUefiCertificates(Connection c) throws Types.BadServerResponse, Types.XenAPIException, IOException Deprecated.since 22.16.0Get the uefi_certificates field of the given host. 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.
-
getCertificates
public Set<Certificate> getCertificates(Connection c) throws Types.BadServerResponse, Types.XenAPIException, IOException Get the certificates field of the given host. Minimum allowed role: read-only First published in Citrix Hypervisor 8.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.
-
getEditions
public Set<String> getEditions(Connection c) throws Types.BadServerResponse, Types.XenAPIException, IOException Get the editions field of the given host. Minimum allowed role: read-only First published in Citrix Hypervisor 8.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.
-
getPendingGuidances
public Set<Types.UpdateGuidances> getPendingGuidances(Connection c) throws Types.BadServerResponse, Types.XenAPIException, IOException Get the pending_guidances field of the given host. Minimum allowed role: read-only First published in 1.303.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.
-
getTlsVerificationEnabled
public Boolean getTlsVerificationEnabled(Connection c) throws Types.BadServerResponse, Types.XenAPIException, IOException Get the tls_verification_enabled field of the given host. Minimum allowed role: read-only First published in 1.313.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.
-
getLastSoftwareUpdate
public Date getLastSoftwareUpdate(Connection c) throws Types.BadServerResponse, Types.XenAPIException, IOException Get the last_software_update field of the given host. Minimum allowed role: read-only Experimental. First published in 22.20.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.
-
getHttpsOnly
public Boolean getHttpsOnly(Connection c) throws Types.BadServerResponse, Types.XenAPIException, IOException Get the https_only field of the given host. Minimum allowed role: read-only Experimental. First published in 22.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.
-
getLatestSyncedUpdatesApplied
public Types.LatestSyncedUpdatesAppliedState getLatestSyncedUpdatesApplied(Connection c) throws Types.BadServerResponse, Types.XenAPIException, IOException Get the latest_synced_updates_applied field of the given host. 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.
-
getNumaAffinityPolicy
public Types.HostNumaAffinityPolicy getNumaAffinityPolicy(Connection c) throws Types.BadServerResponse, Types.XenAPIException, IOException Get the numa_affinity_policy field of the given host. 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.
-
getPendingGuidancesRecommended
public Set<Types.UpdateGuidances> getPendingGuidancesRecommended(Connection c) throws Types.BadServerResponse, Types.XenAPIException, IOException Get the pending_guidances_recommended field of the given host. Minimum allowed role: read-only Experimental. First published in 24.10.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.
-
getPendingGuidancesFull
public Set<Types.UpdateGuidances> getPendingGuidancesFull(Connection c) throws Types.BadServerResponse, Types.XenAPIException, IOException Get the pending_guidances_full field of the given host. Minimum allowed role: read-only Experimental. First published in 24.10.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.
-
getLastUpdateHash
public String getLastUpdateHash(Connection c) throws Types.BadServerResponse, Types.XenAPIException, IOException Get the last_update_hash field of the given host. Minimum allowed role: read-only Experimental. First published in 24.10.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.
-
setNameLabel
public void setNameLabel(Connection c, String label) throws Types.BadServerResponse, Types.XenAPIException, IOException Set the name/label field of the given host. Minimum allowed role: pool-operator First published in XenServer 4.0.- Parameters:
c
- The connection the call is made onlabel
- 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 description) throws Types.BadServerResponse, Types.XenAPIException, IOException Set the name/description field of the given host. Minimum allowed role: pool-operator First published in XenServer 4.0.- Parameters:
c
- The connection the call is made ondescription
- 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 host. 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 host. 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 host. 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.
-
setLogging
public void setLogging(Connection c, Map<String, String> logging) throws Types.BadServerResponse, Types.XenAPIException, IOExceptionSet the logging field of the given host. Minimum allowed role: pool-operator First published in XenServer 4.0.- Parameters:
c
- The connection the call is made onlogging
- 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.
-
addToLogging
public void addToLogging(Connection c, String key, String value) throws Types.BadServerResponse, Types.XenAPIException, IOException Add the given key-value pair to the logging field of the given host. 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.
-
removeFromLogging
public void removeFromLogging(Connection c, String key) throws Types.BadServerResponse, Types.XenAPIException, IOException Remove the given key and its corresponding value from the logging field of the given host. 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.
-
setSuspendImageSr
public void setSuspendImageSr(Connection c, SR suspendImageSr) throws Types.BadServerResponse, Types.XenAPIException, IOException Set the suspend_image_sr field of the given host. 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 host. 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.
-
setHostname
public void setHostname(Connection c, String hostname) throws Types.BadServerResponse, Types.XenAPIException, IOException Set the hostname field of the given host. Minimum allowed role: pool-operator First published in XenServer 4.0.- Parameters:
c
- The connection the call is made onhostname
- 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.
-
setAddress
public void setAddress(Connection c, String address) throws Types.BadServerResponse, Types.XenAPIException, IOException Set the address field of the given host. Minimum allowed role: pool-operator First published in XenServer 4.0.- Parameters:
c
- The connection the call is made onaddress
- 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 host. 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 host. 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 host. 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.
-
setLicenseServer
public void setLicenseServer(Connection c, Map<String, String> licenseServer) throws Types.BadServerResponse, Types.XenAPIException, IOExceptionSet the license_server field of the given host. Minimum allowed role: pool-operator First published in XenServer 5.6.- Parameters:
c
- The connection the call is made onlicenseServer
- 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.
-
addToLicenseServer
public void addToLicenseServer(Connection c, String key, String value) throws Types.BadServerResponse, Types.XenAPIException, IOException Add the given key-value pair to the license_server field of the given host. Minimum allowed role: pool-operator First published in XenServer 5.6.- 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.
-
removeFromLicenseServer
public void removeFromLicenseServer(Connection c, String key) throws Types.BadServerResponse, Types.XenAPIException, IOException Remove the given key and its corresponding value from the license_server field of the given host. If the key is not in that Map, then do nothing. Minimum allowed role: pool-operator First published in XenServer 5.6.- 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.
-
setGuestVCPUsParams
public void setGuestVCPUsParams(Connection c, Map<String, String> guestVCPUsParams) throws Types.BadServerResponse, Types.XenAPIException, IOExceptionSet the guest_VCPUs_params field of the given host. Minimum allowed role: pool-operator First published in XenServer 6.1.- Parameters:
c
- The connection the call is made onguestVCPUsParams
- 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.
-
addToGuestVCPUsParams
public void addToGuestVCPUsParams(Connection c, String key, String value) throws Types.BadServerResponse, Types.XenAPIException, IOException Add the given key-value pair to the guest_VCPUs_params field of the given host. Minimum allowed role: pool-operator First published in XenServer 6.1.- 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.
-
removeFromGuestVCPUsParams
public void removeFromGuestVCPUsParams(Connection c, String key) throws Types.BadServerResponse, Types.XenAPIException, IOException Remove the given key and its corresponding value from the guest_VCPUs_params field of the given host. If the key is not in that Map, then do nothing. Minimum allowed role: pool-operator First published in XenServer 6.1.- 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.
-
setDisplay
public void setDisplay(Connection c, Types.HostDisplay display) throws Types.BadServerResponse, Types.XenAPIException, IOException Set the display field of the given host. Minimum allowed role: pool-operator First published in XenServer 6.5 SP1.- Parameters:
c
- The connection the call is made ondisplay
- 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.
-
disable
public void disable(Connection c) throws Types.BadServerResponse, Types.XenAPIException, IOException Puts the host into a state in which no new VMs can be started. Currently active VMs on the host continue to execute. 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.
-
disableAsync
public Task disableAsync(Connection c) throws Types.BadServerResponse, Types.XenAPIException, IOException Puts the host into a state in which no new VMs can be started. Currently active VMs on the host continue to execute. 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.
-
enable
Puts the host into a state in which new VMs can be started. 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.
-
enableAsync
public Task enableAsync(Connection c) throws Types.BadServerResponse, Types.XenAPIException, IOException Puts the host into a state in which new VMs can be started. 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.
-
shutdown
public void shutdown(Connection c) throws Types.BadServerResponse, Types.XenAPIException, IOException Shutdown the host. (This function can only be called if there are no currently running VMs on the host and it is disabled.) 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.
-
shutdownAsync
public Task shutdownAsync(Connection c) throws Types.BadServerResponse, Types.XenAPIException, IOException Shutdown the host. (This function can only be called if there are no currently running VMs on the host and it is disabled.) 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.
-
reboot
Reboot the host. (This function can only be called if there are no currently running VMs on the host and it is disabled.) 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.
-
rebootAsync
public Task rebootAsync(Connection c) throws Types.BadServerResponse, Types.XenAPIException, IOException Reboot the host. (This function can only be called if there are no currently running VMs on the host and it is disabled.) 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.
-
dmesg
public String dmesg(Connection c) throws Types.BadServerResponse, Types.XenAPIException, IOException Get the host xen dmesg. Minimum allowed role: pool-operator First published in XenServer 4.0.- Parameters:
c
- The connection the call is made on- Returns:
- dmesg string
- 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.
-
dmesgAsync
public Task dmesgAsync(Connection c) throws Types.BadServerResponse, Types.XenAPIException, IOException Get the host xen dmesg. 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.
-
dmesgClear
public String dmesgClear(Connection c) throws Types.BadServerResponse, Types.XenAPIException, IOException Get the host xen dmesg, and clear the buffer. Minimum allowed role: pool-operator First published in XenServer 4.0.- Parameters:
c
- The connection the call is made on- Returns:
- dmesg string
- 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.
-
dmesgClearAsync
public Task dmesgClearAsync(Connection c) throws Types.BadServerResponse, Types.XenAPIException, IOException Get the host xen dmesg, and clear the buffer. 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.
-
getLog
public String getLog(Connection c) throws Types.BadServerResponse, Types.XenAPIException, IOException Get the host's log file Minimum allowed role: read-only First published in XenServer 4.0.- Parameters:
c
- The connection the call is made on- Returns:
- The contents of the host's primary log file
- 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.
-
getLogAsync
public Task getLogAsync(Connection c) throws Types.BadServerResponse, Types.XenAPIException, IOException Get the host's log file Minimum allowed role: read-only 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.
-
sendDebugKeys
public void sendDebugKeys(Connection c, String keys) throws Types.BadServerResponse, Types.XenAPIException, IOException Inject the given string as debugging keys into Xen Minimum allowed role: pool-admin First published in XenServer 4.0.- Parameters:
c
- The connection the call is made onkeys
- The keys to send- 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.
-
sendDebugKeysAsync
public Task sendDebugKeysAsync(Connection c, String keys) throws Types.BadServerResponse, Types.XenAPIException, IOException Inject the given string as debugging keys into Xen Minimum allowed role: pool-admin First published in XenServer 4.0.- Parameters:
c
- The connection the call is made onkeys
- The keys to send- 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.
-
bugreportUpload
public void bugreportUpload(Connection c, String url, Map<String, String> options) throws Types.BadServerResponse, Types.XenAPIException, IOExceptionRun xen-bugtool --yestoall and upload the output to support Minimum allowed role: pool-operator First published in XenServer 4.0.- Parameters:
c
- The connection the call is made onurl
- The URL to upload tooptions
- Extra configuration operations- 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.
-
bugreportUploadAsync
public Task bugreportUploadAsync(Connection c, String url, Map<String, String> options) throws Types.BadServerResponse, Types.XenAPIException, IOExceptionRun xen-bugtool --yestoall and upload the output to support Minimum allowed role: pool-operator First published in XenServer 4.0.- Parameters:
c
- The connection the call is made onurl
- The URL to upload tooptions
- Extra configuration operations- 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.
-
listMethods
public static Set<String> listMethods(Connection c) throws Types.BadServerResponse, Types.XenAPIException, IOException List all supported methods Minimum allowed role: read-only First published in XenServer 4.0.- Parameters:
c
- The connection the call is made on- Returns:
- The name of every supported method.
- 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.
-
licenseApply
@Deprecated(since="XenServer 6.2") public void licenseApply(Connection c, String contents) throws Types.BadServerResponse, Types.XenAPIException, IOException, Types.LicenseProcessingError Deprecated.since XenServer 6.2Apply a new license to a host Minimum allowed role: pool-operator First published in XenServer 4.0.- Parameters:
c
- The connection the call is made oncontents
- The contents of the license file, base64 encoded- 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.LicenseProcessingError
- There was an error processing your license. Please contact your support representative.
-
licenseApplyAsync
@Deprecated(since="XenServer 6.2") public Task licenseApplyAsync(Connection c, String contents) throws Types.BadServerResponse, Types.XenAPIException, IOException, Types.LicenseProcessingError Deprecated.since XenServer 6.2Apply a new license to a host Minimum allowed role: pool-operator First published in XenServer 4.0.- Parameters:
c
- The connection the call is made oncontents
- The contents of the license file, base64 encoded- 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.LicenseProcessingError
- There was an error processing your license. Please contact your support representative.
-
licenseAdd
public void licenseAdd(Connection c, String contents) throws Types.BadServerResponse, Types.XenAPIException, IOException, Types.LicenseProcessingError Apply a new license to a host Minimum allowed role: pool-operator First published in XenServer 6.5 SP1 Hotfix 31.- Parameters:
c
- The connection the call is made oncontents
- The contents of the license file, base64 encoded- 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.LicenseProcessingError
- There was an error processing your license. Please contact your support representative.
-
licenseAddAsync
public Task licenseAddAsync(Connection c, String contents) throws Types.BadServerResponse, Types.XenAPIException, IOException, Types.LicenseProcessingError Apply a new license to a host Minimum allowed role: pool-operator First published in XenServer 6.5 SP1 Hotfix 31.- Parameters:
c
- The connection the call is made oncontents
- The contents of the license file, base64 encoded- 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.LicenseProcessingError
- There was an error processing your license. Please contact your support representative.
-
licenseRemove
public void licenseRemove(Connection c) throws Types.BadServerResponse, Types.XenAPIException, IOException Remove any license file from the specified host, and switch that host to the unlicensed edition Minimum allowed role: pool-operator First published in XenServer 6.5 SP1 Hotfix 31.- 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.
-
licenseRemoveAsync
public Task licenseRemoveAsync(Connection c) throws Types.BadServerResponse, Types.XenAPIException, IOException Remove any license file from the specified host, and switch that host to the unlicensed edition Minimum allowed role: pool-operator First published in XenServer 6.5 SP1 Hotfix 31.- 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.
-
destroy
public void destroy(Connection c) throws Types.BadServerResponse, Types.XenAPIException, IOException Destroy specified host record in database 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.
-
destroyAsync
public Task destroyAsync(Connection c) throws Types.BadServerResponse, Types.XenAPIException, IOException Destroy specified host record in database 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.
-
powerOn
public void powerOn(Connection c) throws Types.BadServerResponse, Types.XenAPIException, IOException Attempt to power-on the host (if the capability exists). Minimum allowed role: pool-operator First published in XenServer 5.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.
-
powerOnAsync
public Task powerOnAsync(Connection c) throws Types.BadServerResponse, Types.XenAPIException, IOException Attempt to power-on the host (if the capability exists). Minimum allowed role: pool-operator First published in XenServer 5.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.
-
emergencyHaDisable
public static void emergencyHaDisable(Connection c, Boolean soft) throws Types.BadServerResponse, Types.XenAPIException, IOException This call disables HA on the local host. This should only be used with extreme care. Minimum allowed role: pool-operator First published in XenServer 5.0.- Parameters:
c
- The connection the call is made onsoft
- Disable HA temporarily, revert upon host reboot or further changes, idempotent First published in XenServer 7.1.- 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.
-
getDataSources
public Set<DataSource.Record> getDataSources(Connection c) throws Types.BadServerResponse, Types.XenAPIException, IOException Minimum allowed role: read-only First published in XenServer 5.0.- Parameters:
c
- The connection the call is made on- Returns:
- A set of data sources
- 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.
-
recordDataSource
public void recordDataSource(Connection c, String dataSource) throws Types.BadServerResponse, Types.XenAPIException, IOException Start recording the specified data source Minimum allowed role: pool-operator First published in XenServer 5.0.- Parameters:
c
- The connection the call is made ondataSource
- The data source to record- 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.
-
queryDataSource
public Double queryDataSource(Connection c, String dataSource) throws Types.BadServerResponse, Types.XenAPIException, IOException Query the latest value of the specified data source Minimum allowed role: read-only First published in XenServer 5.0.- Parameters:
c
- The connection the call is made ondataSource
- The data source to query- Returns:
- The latest value, averaged over the last 5 seconds
- 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.
-
forgetDataSourceArchives
public void forgetDataSourceArchives(Connection c, String dataSource) throws Types.BadServerResponse, Types.XenAPIException, IOException Forget the recorded statistics related to the specified data source Minimum allowed role: pool-operator First published in XenServer 5.0.- Parameters:
c
- The connection the call is made ondataSource
- The data source whose archives are to be forgotten- 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.
-
assertCanEvacuate
public void assertCanEvacuate(Connection c) throws Types.BadServerResponse, Types.XenAPIException, IOException Check this host can be evacuated. 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.
-
assertCanEvacuateAsync
public Task assertCanEvacuateAsync(Connection c) throws Types.BadServerResponse, Types.XenAPIException, IOException Check this host can be evacuated. 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.
-
getVmsWhichPreventEvacuation
public Map<VM,Set<String>> getVmsWhichPreventEvacuation(Connection c) throws Types.BadServerResponse, Types.XenAPIException, IOException Return a set of VMs which prevent the host being evacuated, with per-VM error codes Minimum allowed role: read-only First published in XenServer 5.0.- Parameters:
c
- The connection the call is made on- Returns:
- VMs which block evacuation together with reasons
- 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.
-
getVmsWhichPreventEvacuationAsync
public Task getVmsWhichPreventEvacuationAsync(Connection c) throws Types.BadServerResponse, Types.XenAPIException, IOException Return a set of VMs which prevent the host being evacuated, with per-VM error codes Minimum allowed role: read-only First published in XenServer 5.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.
-
getUncooperativeResidentVMs
@Deprecated(since="XenServer 6.1") public Set<VM> getUncooperativeResidentVMs(Connection c) throws Types.BadServerResponse, Types.XenAPIException, IOException Deprecated.since XenServer 6.1Return a set of VMs which are not co-operating with the host's memory control system Minimum allowed role: read-only First published in XenServer 5.6.- Parameters:
c
- The connection the call is made on- Returns:
- VMs which are not co-operating
- 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.
-
getUncooperativeResidentVMsAsync
@Deprecated(since="XenServer 6.1") public Task getUncooperativeResidentVMsAsync(Connection c) throws Types.BadServerResponse, Types.XenAPIException, IOException Deprecated.since XenServer 6.1Return a set of VMs which are not co-operating with the host's memory control system Minimum allowed role: read-only 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.
-
evacuate
public void evacuate(Connection c) throws Types.BadServerResponse, Types.XenAPIException, IOException Migrate all VMs off of this host, where possible. 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.
-
evacuate
public void evacuate(Connection c, Network network) throws Types.BadServerResponse, Types.XenAPIException, IOException Migrate all VMs off of this host, where possible. Minimum allowed role: pool-operator First published in XenServer 4.1.- Parameters:
c
- The connection the call is made onnetwork
- Optional preferred network for migration First published in 1.297.0.- 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.
-
evacuate
public void evacuate(Connection c, Network network, Long evacuateBatchSize) throws Types.BadServerResponse, Types.XenAPIException, IOException Migrate all VMs off of this host, where possible. Minimum allowed role: pool-operator First published in XenServer 4.1.- Parameters:
c
- The connection the call is made onnetwork
- Optional preferred network for migration First published in 1.297.0.evacuateBatchSize
- The maximum number of VMs to be migrated per batch 0 will use the value `evacuation-batch-size` defined in xapi.conf First published in 23.27.0.- 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.
-
evacuateAsync
public Task evacuateAsync(Connection c) throws Types.BadServerResponse, Types.XenAPIException, IOException Migrate all VMs off of this host, where possible. 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.
-
evacuateAsync
public Task evacuateAsync(Connection c, Network network) throws Types.BadServerResponse, Types.XenAPIException, IOException Migrate all VMs off of this host, where possible. Minimum allowed role: pool-operator First published in XenServer 4.1.- Parameters:
c
- The connection the call is made onnetwork
- Optional preferred network for migration First published in 1.297.0.- 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.
-
evacuateAsync
public Task evacuateAsync(Connection c, Network network, Long evacuateBatchSize) throws Types.BadServerResponse, Types.XenAPIException, IOException Migrate all VMs off of this host, where possible. Minimum allowed role: pool-operator First published in XenServer 4.1.- Parameters:
c
- The connection the call is made onnetwork
- Optional preferred network for migration First published in 1.297.0.evacuateBatchSize
- The maximum number of VMs to be migrated per batch 0 will use the value `evacuation-batch-size` defined in xapi.conf First published in 23.27.0.- 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.
-
syslogReconfigure
public void syslogReconfigure(Connection c) throws Types.BadServerResponse, Types.XenAPIException, IOException Re-configure syslog logging 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.
-
syslogReconfigureAsync
public Task syslogReconfigureAsync(Connection c) throws Types.BadServerResponse, Types.XenAPIException, IOException Re-configure syslog logging 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.
-
managementReconfigure
public static void managementReconfigure(Connection c, PIF pif) throws Types.BadServerResponse, Types.XenAPIException, IOException Reconfigure the management network interface Minimum allowed role: pool-operator First published in XenServer 4.1.- Parameters:
c
- The connection the call is made onpif
- reference to a PIF object corresponding to the management interface- 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.
-
managementReconfigureAsync
public static Task managementReconfigureAsync(Connection c, PIF pif) throws Types.BadServerResponse, Types.XenAPIException, IOException Reconfigure the management network interface Minimum allowed role: pool-operator First published in XenServer 4.1.- Parameters:
c
- The connection the call is made onpif
- reference to a PIF object corresponding to the management 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.
-
localManagementReconfigure
public static void localManagementReconfigure(Connection c, String iface) throws Types.BadServerResponse, Types.XenAPIException, IOException Reconfigure the management network interface. Should only be used if Host.management_reconfigure is impossible because the network configuration is broken. Minimum allowed role: pool-operator First published in XenServer 4.1.- Parameters:
c
- The connection the call is made oniface
- name of the interface to use as a management interface- 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.
-
managementDisable
public static void managementDisable(Connection c) throws Types.BadServerResponse, Types.XenAPIException, IOException Disable the management network interface 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.
-
getManagementIface
public PIF getManagementIface(Connection c) throws Types.BadServerResponse, Types.XenAPIException, IOException Returns the management interface for the specified host Minimum allowed role: pool-operator First published in XenServer 6.1.- Parameters:
c
- The connection the call is made on- Returns:
- The management interface for the host
- 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.
-
getManagementIfaceAsync
public Task getManagementIfaceAsync(Connection c) throws Types.BadServerResponse, Types.XenAPIException, IOException Returns the management interface for the specified host Minimum allowed role: pool-operator First published in XenServer 6.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.
-
getSystemStatusCapabilities
public String getSystemStatusCapabilities(Connection c) throws Types.BadServerResponse, Types.XenAPIException, IOException Minimum allowed role: read-only First published in XenServer 4.1.- Parameters:
c
- The connection the call is made on- Returns:
- An XML fragment containing the system status capabilities.
- 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.
-
restartAgent
public void restartAgent(Connection c) throws Types.BadServerResponse, Types.XenAPIException, IOException Restarts the agent after a 10 second pause. WARNING: this is a dangerous operation. Any operations in progress will be aborted, and unrecoverable data loss may occur. The caller is responsible for ensuring that there are no operations in progress when this method is called. 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.
-
restartAgentAsync
public Task restartAgentAsync(Connection c) throws Types.BadServerResponse, Types.XenAPIException, IOException Restarts the agent after a 10 second pause. WARNING: this is a dangerous operation. Any operations in progress will be aborted, and unrecoverable data loss may occur. The caller is responsible for ensuring that there are no operations in progress when this method is called. 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.
-
shutdownAgent
public static void shutdownAgent(Connection c) throws Types.BadServerResponse, Types.XenAPIException, IOException Shuts the agent down after a 10 second pause. WARNING: this is a dangerous operation. Any operations in progress will be aborted, and unrecoverable data loss may occur. The caller is responsible for ensuring that there are no operations in progress when this method is called. Minimum allowed role: pool-operator First published in XenServer 5.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.
-
setHostnameLive
public void setHostnameLive(Connection c, String hostname) throws Types.BadServerResponse, Types.XenAPIException, IOException, Types.HostNameInvalid Sets the host name to the specified string. Both the API and lower-level system hostname are changed immediately. Minimum allowed role: pool-operator First published in XenServer 4.1.- Parameters:
c
- The connection the call is made onhostname
- The new host 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.Types.HostNameInvalid
- The server name is invalid.
-
computeFreeMemory
public Long computeFreeMemory(Connection c) throws Types.BadServerResponse, Types.XenAPIException, IOException Computes the amount of free memory on the host. Minimum allowed role: read-only First published in XenServer 5.0.- Parameters:
c
- The connection the call is made on- Returns:
- the amount of free memory on the host.
- 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.
-
computeFreeMemoryAsync
public Task computeFreeMemoryAsync(Connection c) throws Types.BadServerResponse, Types.XenAPIException, IOException Computes the amount of free memory on the host. Minimum allowed role: read-only First published in XenServer 5.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.
-
computeMemoryOverhead
public Long computeMemoryOverhead(Connection c) throws Types.BadServerResponse, Types.XenAPIException, IOException Computes the virtualization memory overhead of a host. Minimum allowed role: read-only First published in XenServer 5.6.- Parameters:
c
- The connection the call is made on- Returns:
- the virtualization memory overhead of the host.
- 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.
-
computeMemoryOverheadAsync
public Task computeMemoryOverheadAsync(Connection c) throws Types.BadServerResponse, Types.XenAPIException, IOException Computes the virtualization memory overhead of a host. Minimum allowed role: read-only 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.
-
syncData
public void syncData(Connection c) throws Types.BadServerResponse, Types.XenAPIException, IOException This causes the synchronisation of the non-database data (messages, RRDs and so on) stored on the master to be synchronised with the host Minimum allowed role: pool-admin First published in XenServer 5.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.
-
backupRrds
public void backupRrds(Connection c, Double delay) throws Types.BadServerResponse, Types.XenAPIException, IOException This causes the RRDs to be backed up to the master Minimum allowed role: pool-admin First published in XenServer 5.0.- Parameters:
c
- The connection the call is made ondelay
- Delay in seconds from when the call is received to perform the backup- 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 host 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 host 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 host 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 host 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.
-
callPlugin
public String callPlugin(Connection c, String plugin, String fn, Map<String, String> args) throws Types.BadServerResponse, Types.XenAPIException, IOExceptionCall an API plugin on this host Minimum allowed role: pool-admin First published in XenServer 5.0.- Parameters:
c
- The connection the call is made onplugin
- The name of the pluginfn
- The name of the function within the pluginargs
- Arguments for the function- Returns:
- Result from the plugin
- 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.
-
callPluginAsync
public Task callPluginAsync(Connection c, String plugin, String fn, Map<String, String> args) throws Types.BadServerResponse, Types.XenAPIException, IOExceptionCall an API plugin on this host Minimum allowed role: pool-admin First published in XenServer 5.0.- Parameters:
c
- The connection the call is made onplugin
- The name of the pluginfn
- The name of the function within the pluginargs
- Arguments for the function- 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 host Minimum allowed role: pool-admin First published in XenServer 7.1.- 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 host Minimum allowed role: pool-admin First published in XenServer 7.1.- 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.
-
callExtension
public String callExtension(Connection c, String call) throws Types.BadServerResponse, Types.XenAPIException, IOException Call an API extension on this host Minimum allowed role: pool-admin First published in XenServer 7.1.- Parameters:
c
- The connection the call is made oncall
- Rpc call for the extension- Returns:
- Result from the extension
- 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.
-
getServertime
public Date getServertime(Connection c) throws Types.BadServerResponse, Types.XenAPIException, IOException This call queries the host's clock for the current time Minimum allowed role: read-only First published in XenServer 5.0.- Parameters:
c
- The connection the call is made on- Returns:
- The current time
- 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.
-
getServerLocaltime
public Date getServerLocaltime(Connection c) throws Types.BadServerResponse, Types.XenAPIException, IOException This call queries the host's clock for the current time in the host's local timezone Minimum allowed role: read-only First published in XenServer 5.6 FP1.- Parameters:
c
- The connection the call is made on- Returns:
- The current local time
- 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 a host 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 the local host 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.
-
retrieveWlbEvacuateRecommendations
public Map<VM,Set<String>> retrieveWlbEvacuateRecommendations(Connection c) throws Types.BadServerResponse, Types.XenAPIException, IOException Retrieves recommended host migrations to perform when evacuating the host from the wlb server. If a VM cannot be migrated from the host the reason is listed instead of a recommendation. Minimum allowed role: read-only First published in XenServer 5.5.- Parameters:
c
- The connection the call is made on- Returns:
- VMs and the reasons why they would block evacuation, or their target host recommended by the wlb 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.
-
retrieveWlbEvacuateRecommendationsAsync
public Task retrieveWlbEvacuateRecommendationsAsync(Connection c) throws Types.BadServerResponse, Types.XenAPIException, IOException Retrieves recommended host migrations to perform when evacuating the host from the wlb server. If a VM cannot be migrated from the host the reason is listed instead of a recommendation. 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.
-
getServerCertificate
public String getServerCertificate(Connection c) throws Types.BadServerResponse, Types.XenAPIException, IOException Get the installed server public TLS certificate. Minimum allowed role: read-only First published in XenServer 5.5.- Parameters:
c
- The connection the call is made on- Returns:
- The installed server public TLS certificate, in PEM form.
- 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.
-
getServerCertificateAsync
public Task getServerCertificateAsync(Connection c) throws Types.BadServerResponse, Types.XenAPIException, IOException Get the installed server public TLS certificate. 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.
-
refreshServerCertificate
public void refreshServerCertificate(Connection c) throws Types.BadServerResponse, Types.XenAPIException, IOException Replace the internal self-signed host certficate with a new one. Minimum allowed role: pool-admin First published in 1.307.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.
-
refreshServerCertificateAsync
public Task refreshServerCertificateAsync(Connection c) throws Types.BadServerResponse, Types.XenAPIException, IOException Replace the internal self-signed host certficate with a new one. Minimum allowed role: pool-admin First published in 1.307.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.
-
installServerCertificate
public void installServerCertificate(Connection c, String certificate, String privateKey, String certificateChain) throws Types.BadServerResponse, Types.XenAPIException, IOException Install the TLS server certificate. Minimum allowed role: pool-admin First published in Citrix Hypervisor 8.2.- Parameters:
c
- The connection the call is made oncertificate
- The server certificate, in PEM formprivateKey
- The unencrypted private key used to sign the certificate, in PKCS#8 formcertificateChain
- The certificate chain, in PEM form- 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.
-
installServerCertificateAsync
public Task installServerCertificateAsync(Connection c, String certificate, String privateKey, String certificateChain) throws Types.BadServerResponse, Types.XenAPIException, IOException Install the TLS server certificate. Minimum allowed role: pool-admin First published in Citrix Hypervisor 8.2.- Parameters:
c
- The connection the call is made oncertificate
- The server certificate, in PEM formprivateKey
- The unencrypted private key used to sign the certificate, in PKCS#8 formcertificateChain
- The certificate chain, in PEM form- 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.
-
emergencyResetServerCertificate
public static void emergencyResetServerCertificate(Connection c) throws Types.BadServerResponse, Types.XenAPIException, IOException Delete the current TLS server certificate and replace by a new, self-signed one. This should only be used with extreme care. Minimum allowed role: Not Applicable First published in Citrix Hypervisor 8.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.
-
resetServerCertificate
public void resetServerCertificate(Connection c) throws Types.BadServerResponse, Types.XenAPIException, IOException Delete the current TLS server certificate and replace by a new, self-signed one. This should only be used with extreme care. 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.
-
resetServerCertificateAsync
public Task resetServerCertificateAsync(Connection c) throws Types.BadServerResponse, Types.XenAPIException, IOException Delete the current TLS server certificate and replace by a new, self-signed one. This should only be used with extreme care. Minimum allowed role: pool-admin First published in 1.290.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.
-
applyEdition
public void applyEdition(Connection c, String edition) throws Types.BadServerResponse, Types.XenAPIException, IOException Change to another edition, or reactivate the current edition after a license has expired. This may be subject to the successful checkout of an appropriate license. Minimum allowed role: pool-operator First published in XenServer 5.6.- 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.
-
applyEdition
public void applyEdition(Connection c, String edition, Boolean force) throws Types.BadServerResponse, Types.XenAPIException, IOException Change to another edition, or reactivate the current edition after a license has expired. This may be subject to the successful checkout of an appropriate license. Minimum allowed role: pool-operator First published in XenServer 5.6.- Parameters:
c
- The connection the call is made onedition
- The requested editionforce
- Update the license params even if the apply call fails First published in XenServer 6.2.- 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.
-
refreshPackInfo
@Deprecated(since="XenServer 7.1") public void refreshPackInfo(Connection c) throws Types.BadServerResponse, Types.XenAPIException, IOException Deprecated.since XenServer 7.1Refresh the list of installed Supplemental Packs. 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.
-
refreshPackInfoAsync
@Deprecated(since="XenServer 7.1") public Task refreshPackInfoAsync(Connection c) throws Types.BadServerResponse, Types.XenAPIException, IOException Deprecated.since XenServer 7.1Refresh the list of installed Supplemental Packs. 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.
-
setPowerOnMode
public void setPowerOnMode(Connection c, String powerOnMode, Map<String, String> powerOnConfig) throws Types.BadServerResponse, Types.XenAPIException, IOExceptionSet the power-on-mode, host, user and password Minimum allowed role: pool-operator First published in XenServer 5.6 FP1.- Parameters:
c
- The connection the call is made onpowerOnMode
- power-on-mode can be empty, wake-on-lan, IPMI or otherpowerOnConfig
- Power on config- 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.
-
setPowerOnModeAsync
public Task setPowerOnModeAsync(Connection c, String powerOnMode, Map<String, String> powerOnConfig) throws Types.BadServerResponse, Types.XenAPIException, IOExceptionSet the power-on-mode, host, user and password Minimum allowed role: pool-operator First published in XenServer 5.6 FP1.- Parameters:
c
- The connection the call is made onpowerOnMode
- power-on-mode can be empty, wake-on-lan, IPMI or otherpowerOnConfig
- Power on config- 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.
-
setCpuFeatures
@Deprecated(since="XenServer 7.0") public void setCpuFeatures(Connection c, String features) throws Types.BadServerResponse, Types.XenAPIException, IOException Deprecated.since XenServer 7.0Set the CPU features to be used after a reboot, if the given features string is valid. Minimum allowed role: pool-operator First published in XenServer 5.6.- Parameters:
c
- The connection the call is made onfeatures
- The features string (32 hexadecimal digits)- 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.
-
resetCpuFeatures
@Deprecated(since="XenServer 7.0") public void resetCpuFeatures(Connection c) throws Types.BadServerResponse, Types.XenAPIException, IOException Deprecated.since XenServer 7.0Remove the feature mask, such that after a reboot all features of the CPU are 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.
-
enableLocalStorageCaching
public void enableLocalStorageCaching(Connection c, SR sr) throws Types.BadServerResponse, Types.XenAPIException, IOException Enable the use of a local SR for caching purposes Minimum allowed role: pool-operator First published in XenServer 5.6 FP1.- Parameters:
c
- The connection the call is made onsr
- The SR to use as a local cache- 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 Disable the use of a local SR for caching purposes 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.
-
migrateReceive
public Map<String,String> migrateReceive(Connection c, Network network, Map<String, String> options) throws Types.BadServerResponse, Types.XenAPIException, IOExceptionPrepare to receive a VM, returning a token which can be passed to VM.migrate. Minimum allowed role: vm-power-admin First published in XenServer 6.1.- Parameters:
c
- The connection the call is made onnetwork
- The network through which migration traffic should be received.options
- Extra configuration operations- Returns:
- A value which should be passed to VM.migrate
- 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.
-
migrateReceiveAsync
public Task migrateReceiveAsync(Connection c, Network network, Map<String, String> options) throws Types.BadServerResponse, Types.XenAPIException, IOExceptionPrepare to receive a VM, returning a token which can be passed to VM.migrate. Minimum allowed role: vm-power-admin First published in XenServer 6.1.- Parameters:
c
- The connection the call is made onnetwork
- The network through which migration traffic should be received.options
- Extra configuration operations- 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.
-
declareDead
public void declareDead(Connection c) throws Types.BadServerResponse, Types.XenAPIException, IOException Declare that a host is dead. This is a dangerous operation, and should only be called if the administrator is absolutely sure the host is definitely dead Minimum allowed role: pool-operator First published in XenServer 6.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.
-
declareDeadAsync
public Task declareDeadAsync(Connection c) throws Types.BadServerResponse, Types.XenAPIException, IOException Declare that a host is dead. This is a dangerous operation, and should only be called if the administrator is absolutely sure the host is definitely dead Minimum allowed role: pool-operator 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.
-
enableDisplay
public Types.HostDisplay enableDisplay(Connection c) throws Types.BadServerResponse, Types.XenAPIException, IOException Enable console output to the physical display device next time this host boots Minimum allowed role: pool-operator First published in XenServer 6.5 SP1.- Parameters:
c
- The connection the call is made on- Returns:
- This host's physical display usage
- 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.
-
enableDisplayAsync
public Task enableDisplayAsync(Connection c) throws Types.BadServerResponse, Types.XenAPIException, IOException Enable console output to the physical display device next time this host boots Minimum allowed role: pool-operator First published in XenServer 6.5 SP1.- 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.
-
disableDisplay
public Types.HostDisplay disableDisplay(Connection c) throws Types.BadServerResponse, Types.XenAPIException, IOException Disable console output to the physical display device next time this host boots Minimum allowed role: pool-operator First published in XenServer 6.5 SP1.- Parameters:
c
- The connection the call is made on- Returns:
- This host's physical display usage
- 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.
-
disableDisplayAsync
public Task disableDisplayAsync(Connection c) throws Types.BadServerResponse, Types.XenAPIException, IOException Disable console output to the physical display device next time this host boots Minimum allowed role: pool-operator First published in XenServer 6.5 SP1.- 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.
-
setSslLegacy
public void setSslLegacy(Connection c, Boolean value) throws Types.BadServerResponse, Types.XenAPIException, IOException Enable/disable SSLv3 for interoperability with older server versions. When this is set to a different value, the host immediately restarts its SSL/TLS listening service; typically this takes less than a second but existing connections to it will be broken. API login sessions will remain valid. Minimum allowed role: pool-operator First published in XenServer 7.0.- Parameters:
c
- The connection the call is made onvalue
- True to allow SSLv3 and ciphersuites as used in old XenServer versions- 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.
-
setSslLegacyAsync
public Task setSslLegacyAsync(Connection c, Boolean value) throws Types.BadServerResponse, Types.XenAPIException, IOException Enable/disable SSLv3 for interoperability with older server versions. When this is set to a different value, the host immediately restarts its SSL/TLS listening service; typically this takes less than a second but existing connections to it will be broken. API login sessions will remain valid. Minimum allowed role: pool-operator First published in XenServer 7.0.- Parameters:
c
- The connection the call is made onvalue
- True to allow SSLv3 and ciphersuites as used in old XenServer versions- 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.
-
setIscsiIqn
public void setIscsiIqn(Connection c, String value) throws Types.BadServerResponse, Types.XenAPIException, IOException Sets the initiator IQN for the host Minimum allowed role: pool-operator First published in XenServer 7.5.- Parameters:
c
- The connection the call is made onvalue
- The value to which the IQN should be 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.
-
setIscsiIqnAsync
public Task setIscsiIqnAsync(Connection c, String value) throws Types.BadServerResponse, Types.XenAPIException, IOException Sets the initiator IQN for the host Minimum allowed role: pool-operator First published in XenServer 7.5.- Parameters:
c
- The connection the call is made onvalue
- The value to which the IQN should be 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.
-
setMultipathing
public void setMultipathing(Connection c, Boolean value) throws Types.BadServerResponse, Types.XenAPIException, IOException Specifies whether multipathing is enabled Minimum allowed role: pool-operator First published in XenServer 7.5.- Parameters:
c
- The connection the call is made onvalue
- Whether multipathing should 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.
-
setMultipathingAsync
public Task setMultipathingAsync(Connection c, Boolean value) throws Types.BadServerResponse, Types.XenAPIException, IOException Specifies whether multipathing is enabled Minimum allowed role: pool-operator First published in XenServer 7.5.- Parameters:
c
- The connection the call is made onvalue
- Whether multipathing should 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.
-
setUefiCertificates
@Deprecated(since="22.16.0") public void setUefiCertificates(Connection c, String value) throws Types.BadServerResponse, Types.XenAPIException, IOException Deprecated.since 22.16.0Sets the UEFI certificates on a host Minimum allowed role: Not Applicable First published in Citrix Hypervisor 8.1.- Parameters:
c
- The connection the call is made onvalue
- The certificates to apply to a host- 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="22.16.0") public Task setUefiCertificatesAsync(Connection c, String value) throws Types.BadServerResponse, Types.XenAPIException, IOException Deprecated.since 22.16.0Sets the UEFI certificates on a host Minimum allowed role: Not Applicable First published in Citrix Hypervisor 8.1.- Parameters:
c
- The connection the call is made onvalue
- The certificates to apply to a host- 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.
-
setSchedGran
public void setSchedGran(Connection c, Types.HostSchedGran value) throws Types.BadServerResponse, Types.XenAPIException, IOException Sets xen's sched-gran on a host. See: https://xenbits.xen.org/docs/unstable/misc/xen-command-line.html#sched-gran-x86 Minimum allowed role: Not Applicable First published in 1.271.0.- Parameters:
c
- The connection the call is made onvalue
- The sched-gran to apply to a host- 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.
-
setSchedGranAsync
public Task setSchedGranAsync(Connection c, Types.HostSchedGran value) throws Types.BadServerResponse, Types.XenAPIException, IOException Sets xen's sched-gran on a host. See: https://xenbits.xen.org/docs/unstable/misc/xen-command-line.html#sched-gran-x86 Minimum allowed role: Not Applicable First published in 1.271.0.- Parameters:
c
- The connection the call is made onvalue
- The sched-gran to apply to a host- 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.
-
getSchedGran
public Types.HostSchedGran getSchedGran(Connection c) throws Types.BadServerResponse, Types.XenAPIException, IOException Gets xen's sched-gran on a host Minimum allowed role: Not Applicable First published in 1.271.0.- Parameters:
c
- The connection the call is made on- Returns:
- The host's sched-gran
- 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.
-
getSchedGranAsync
public Task getSchedGranAsync(Connection c) throws Types.BadServerResponse, Types.XenAPIException, IOException Gets xen's sched-gran on a host Minimum allowed role: Not Applicable First published in 1.271.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.
-
setNumaAffinityPolicy
public void setNumaAffinityPolicy(Connection c, Types.HostNumaAffinityPolicy value) throws Types.BadServerResponse, Types.XenAPIException, IOException Set VM placement NUMA affinity policy Minimum allowed role: pool-admin Experimental. First published in 24.0.0.- Parameters:
c
- The connection the call is made onvalue
- The NUMA affinity policy to apply to a host- 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.
-
setNumaAffinityPolicyAsync
public Task setNumaAffinityPolicyAsync(Connection c, Types.HostNumaAffinityPolicy value) throws Types.BadServerResponse, Types.XenAPIException, IOException Set VM placement NUMA affinity policy Minimum allowed role: pool-admin Experimental. First published in 24.0.0.- Parameters:
c
- The connection the call is made onvalue
- The NUMA affinity policy to apply to a host- 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.
-
emergencyDisableTlsVerification
public static void emergencyDisableTlsVerification(Connection c) throws Types.BadServerResponse, Types.XenAPIException, IOException Disable TLS verification for this host only Minimum allowed role: Not Applicable 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.
-
emergencyReenableTlsVerification
public static void emergencyReenableTlsVerification(Connection c) throws Types.BadServerResponse, Types.XenAPIException, IOException Reenable TLS verification for this host only Minimum allowed role: Not Applicable First published in 1.298.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.
-
applyUpdates
public Set<Set<String>> applyUpdates(Connection c, String hash) throws Types.BadServerResponse, Types.XenAPIException, IOException apply updates from current enabled repository on a host Minimum allowed role: pool-operator First published in 1.301.0.- Parameters:
c
- The connection the call is made onhash
- The hash of updateinfo to be applied which is returned by previous pool.sync_udpates- Returns:
- The list of results after applying updates, including livepatch apply failures and recommended guidances
- 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.
-
applyUpdatesAsync
public Task applyUpdatesAsync(Connection c, String hash) throws Types.BadServerResponse, Types.XenAPIException, IOException apply updates from current enabled repository on a host Minimum allowed role: pool-operator First published in 1.301.0.- Parameters:
c
- The connection the call is made onhash
- The hash of updateinfo to be applied which is returned by previous pool.sync_udpates- 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 the host firewall 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- 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 the host firewall 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- 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.
-
applyRecommendedGuidances
public void applyRecommendedGuidances(Connection c) throws Types.BadServerResponse, Types.XenAPIException, IOException apply all recommended guidances both on the host and on all HVM VMs on the host after updates are applied on the host Minimum allowed role: pool-operator Experimental. First published in 23.18.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.
-
applyRecommendedGuidancesAsync
public Task applyRecommendedGuidancesAsync(Connection c) throws Types.BadServerResponse, Types.XenAPIException, IOException apply all recommended guidances both on the host and on all HVM VMs on the host after updates are applied on the host Minimum allowed role: pool-operator Experimental. First published in 23.18.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.
-
emergencyClearMandatoryGuidance
public static void emergencyClearMandatoryGuidance(Connection c) throws Types.BadServerResponse, Types.XenAPIException, IOException Clear the pending mandatory guidance on this host Minimum allowed role: Not Applicable Experimental. First published in 24.10.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.
-
getAll
public static Set<Host> getAll(Connection c) throws Types.BadServerResponse, Types.XenAPIException, IOException Return a list of all the hosts 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<Host,Host.Record> getAllRecords(Connection c) throws Types.BadServerResponse, Types.XenAPIException, IOException Return a map of host references to host records for all hosts 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.
-