View Source XenAPI.Host (XenAPI v0.3.0)
A physical host
Link to this section Summary
Functions
Add the given value to the tags field of the given host. If the value is already in that Set, then do nothing.
Add the given value to the tags field of the given host. If the value is already in that Set, then do nothing. (Raise error on XMLRPC failure)
Add the given key-value pair to the guest_VCPUs_params field of the given host.
Add the given key-value pair to the guest_VCPUs_params field of the given host. (Raise error on XMLRPC failure)
Add the given key-value pair to the license_server field of the given host.
Add the given key-value pair to the license_server field of the given host. (Raise error on XMLRPC failure)
Add the given key-value pair to the logging field of the given host.
Add the given key-value pair to the logging field of the given host. (Raise error on XMLRPC failure)
Add the given key-value pair to the other_config field of the given host.
Add the given key-value pair to the other_config field of the given host. (Raise error on XMLRPC failure)
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.
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. (Raise error on XMLRPC failure)
Check this host can be evacuated.
Check this host can be evacuated. (Raise error on XMLRPC failure)
This causes the RRDs to be backed up to the master
This causes the RRDs to be backed up to the master (Raise error on XMLRPC failure)
Run xen-bugtool --yestoall and upload the output to support
Run xen-bugtool --yestoall and upload the output to support (Raise error on XMLRPC failure)
Call an API extension on this host
Call an API extension on this host (Raise error on XMLRPC failure)
Call an API plugin on this host
Call an API plugin on this host (Raise error on XMLRPC failure)
Computes the amount of free memory on the host.
Computes the amount of free memory on the host. (Raise error on XMLRPC failure)
Computes the virtualization memory overhead of a host.
Computes the virtualization memory overhead of a host. (Raise error on XMLRPC failure)
Create a placeholder for a named binary blob of data that is associated with this host
Create a placeholder for a named binary blob of data that is associated with this host (Raise error on XMLRPC failure)
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
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 (Raise error on XMLRPC failure)
Destroy specified host record in database
Destroy specified host record in database (Raise error on XMLRPC failure)
Puts the host into a state in which no new VMs can be started. Currently active VMs on the host continue to execute.
Puts the host into a state in which no new VMs can be started. Currently active VMs on the host continue to execute. (Raise error on XMLRPC failure)
Disable console output to the physical display device next time this host boots
Disable console output to the physical display device next time this host boots (Raise error on XMLRPC failure)
This call disables external authentication on the local host
This call disables external authentication on the local host (Raise error on XMLRPC failure)
Disable the use of a local SR for caching purposes
Disable the use of a local SR for caching purposes (Raise error on XMLRPC failure)
Get the host xen dmesg.
Get the host xen dmesg. (Raise error on XMLRPC failure)
Get the host xen dmesg, and clear the buffer.
Get the host xen dmesg, and clear the buffer. (Raise error on XMLRPC failure)
This call disables HA on the local host. This should only be used with extreme care.
This call disables HA on the local host. This should only be used with extreme care. (Raise error on XMLRPC failure)
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. (Raise error on XMLRPC failure)
Enable console output to the physical display device next time this host boots
Enable console output to the physical display device next time this host boots (Raise error on XMLRPC failure)
This call enables external authentication on a host
This call enables external authentication on a host (Raise error on XMLRPC failure)
Enable the use of a local SR for caching purposes
Enable the use of a local SR for caching purposes (Raise error on XMLRPC failure)
Migrate all VMs off of this host, where possible.
Migrate all VMs off of this host, where possible. (Raise error on XMLRPC failure)
Forget the recorded statistics related to the specified data source
Forget the recorded statistics related to the specified data source (Raise error on XMLRPC failure)
Get the API_version/major field of the given host.
Get the API_version/major field of the given host. (Raise error on XMLRPC failure)
Get the API_version/minor field of the given host.
Get the API_version/minor field of the given host. (Raise error on XMLRPC failure)
Get the API_version/vendor field of the given host.
Get the API_version/vendor field of the given host. (Raise error on XMLRPC failure)
Get the API_version/vendor_implementation field of the given host.
Get the API_version/vendor_implementation field of the given host. (Raise error on XMLRPC failure)
Get the address field of the given host.
Get the address field of the given host. (Raise error on XMLRPC failure)
Return a list of all the hosts known to the system.
Return a list of all the hosts known to the system. (Raise error on XMLRPC failure)
Return a map of host references to host records for all hosts known to the system.
Return a map of host references to host records for all hosts known to the system. (Raise error on XMLRPC failure)
Get the allowed_operations field of the given host.
Get the allowed_operations field of the given host. (Raise error on XMLRPC failure)
Get the bios_strings field of the given host.
Get the bios_strings field of the given host. (Raise error on XMLRPC failure)
Get the blobs field of the given host.
Get the blobs field of the given host. (Raise error on XMLRPC failure)
Get all the host instances with the given label.
Get all the host instances with the given label. (Raise error on XMLRPC failure)
Get a reference to the host instance with the specified UUID.
Get a reference to the host instance with the specified UUID. (Raise error on XMLRPC failure)
Get the capabilities field of the given host.
Get the capabilities field of the given host. (Raise error on XMLRPC failure)
Get the chipset_info field of the given host.
Get the chipset_info field of the given host. (Raise error on XMLRPC failure)
Get the control_domain field of the given host.
Get the control_domain field of the given host. (Raise error on XMLRPC failure)
Get the cpu_configuration field of the given host.
Get the cpu_configuration field of the given host. (Raise error on XMLRPC failure)
Get the cpu_info field of the given host.
Get the cpu_info field of the given host. (Raise error on XMLRPC failure)
Get the crash_dump_sr field of the given host.
Get the crash_dump_sr field of the given host. (Raise error on XMLRPC failure)
Get the crashdumps field of the given host.
Get the crashdumps field of the given host. (Raise error on XMLRPC failure)
Get the current_operations field of the given host.
Get the current_operations field of the given host. (Raise error on XMLRPC failure)
(Raise error on XMLRPC failure)
Get the display field of the given host.
Get the display field of the given host. (Raise error on XMLRPC failure)
Get the edition field of the given host.
Get the edition field of the given host. (Raise error on XMLRPC failure)
Get the enabled field of the given host.
Get the enabled field of the given host. (Raise error on XMLRPC failure)
Get the external_auth_configuration field of the given host.
Get the external_auth_configuration field of the given host. (Raise error on XMLRPC failure)
Get the external_auth_service_name field of the given host.
Get the external_auth_service_name field of the given host. (Raise error on XMLRPC failure)
Get the external_auth_type field of the given host.
Get the external_auth_type field of the given host. (Raise error on XMLRPC failure)
Get the features field of the given host.
Get the features field of the given host. (Raise error on XMLRPC failure)
Get the guest_VCPUs_params field of the given host.
Get the guest_VCPUs_params field of the given host. (Raise error on XMLRPC failure)
Get the ha_network_peers field of the given host.
Get the ha_network_peers field of the given host. (Raise error on XMLRPC failure)
Get the ha_statefiles field of the given host.
Get the ha_statefiles field of the given host. (Raise error on XMLRPC failure)
Get the host_CPUs field of the given host.
Get the host_CPUs field of the given host. (Raise error on XMLRPC failure)
Get the hostname field of the given host.
Get the hostname field of the given host. (Raise error on XMLRPC failure)
Get the iscsi_iqn field of the given host.
Get the iscsi_iqn field of the given host. (Raise error on XMLRPC failure)
Get the license_params field of the given host.
Get the license_params field of the given host. (Raise error on XMLRPC failure)
Get the license_server field of the given host.
Get the license_server field of the given host. (Raise error on XMLRPC failure)
Get the local_cache_sr field of the given host.
Get the local_cache_sr field of the given host. (Raise error on XMLRPC failure)
Get the host's log file
Get the host's log file (Raise error on XMLRPC failure)
Get the logging field of the given host.
Get the logging field of the given host. (Raise error on XMLRPC failure)
Returns the management interface for the specified host
Returns the management interface for the specified host (Raise error on XMLRPC failure)
Get the memory/overhead field of the given host.
Get the memory/overhead field of the given host. (Raise error on XMLRPC failure)
Get the metrics field of the given host.
Get the metrics field of the given host. (Raise error on XMLRPC failure)
Get the multipathing field of the given host.
Get the multipathing field of the given host. (Raise error on XMLRPC failure)
Get the name/description field of the given host.
Get the name/description field of the given host. (Raise error on XMLRPC failure)
Get the name/label field of the given host.
Get the name/label field of the given host. (Raise error on XMLRPC failure)
Get the other_config field of the given host.
Get the other_config field of the given host. (Raise error on XMLRPC failure)
Get the PBDs field of the given host.
Get the PBDs field of the given host. (Raise error on XMLRPC failure)
Get the PCIs field of the given host.
Get the PCIs field of the given host. (Raise error on XMLRPC failure)
Get the PGPUs field of the given host.
Get the PGPUs field of the given host. (Raise error on XMLRPC failure)
Get the PIFs field of the given host.
Get the PIFs field of the given host. (Raise error on XMLRPC failure)
Get the PUSBs field of the given host.
Get the PUSBs field of the given host. (Raise error on XMLRPC failure)
Get the patches field of the given host.
Get the patches field of the given host. (Raise error on XMLRPC failure)
Get the power_on_config field of the given host.
Get the power_on_config field of the given host. (Raise error on XMLRPC failure)
Get the power_on_mode field of the given host.
Get the power_on_mode field of the given host. (Raise error on XMLRPC failure)
Get a record containing the current state of the given host. Returns XenAPI.Host
struct.
Get a record containing the current state of the given host. Returns XenAPI.Host
struct. (Raise error on XMLRPC failure)
Get the resident_VMs field of the given host.
Get the resident_VMs field of the given host. (Raise error on XMLRPC failure)
Get the sched_policy field of the given host.
Get the sched_policy field of the given host. (Raise error on XMLRPC failure)
Get the installed server public TLS certificate.
Get the installed server public TLS certificate. (Raise error on XMLRPC failure)
This call queries the host's clock for the current time in the host's local timezone
This call queries the host's clock for the current time in the host's local timezone (Raise error on XMLRPC failure)
This call queries the host's clock for the current time
This call queries the host's clock for the current time (Raise error on XMLRPC failure)
Get the software_version field of the given host.
Get the software_version field of the given host. (Raise error on XMLRPC failure)
Get the ssl_legacy field of the given host.
Get the ssl_legacy field of the given host. (Raise error on XMLRPC failure)
Get the supported_bootloaders field of the given host.
Get the supported_bootloaders field of the given host. (Raise error on XMLRPC failure)
Get the suspend_image_sr field of the given host.
Get the suspend_image_sr field of the given host. (Raise error on XMLRPC failure)
(Raise error on XMLRPC failure)
Get the tags field of the given host.
Get the tags field of the given host. (Raise error on XMLRPC failure)
Get the uefi_certificates field of the given host.
Get the uefi_certificates field of the given host. (Raise error on XMLRPC failure)
Return a set of VMs which are not co-operating with the host's memory control system
Return a set of VMs which are not co-operating with the host's memory control system (Raise error on XMLRPC failure)
Get the updates field of the given host.
Get the updates field of the given host. (Raise error on XMLRPC failure)
Get the updates_requiring_reboot field of the given host.
Get the updates_requiring_reboot field of the given host. (Raise error on XMLRPC failure)
Get the uuid field of the given host.
Get the uuid field of the given host. (Raise error on XMLRPC failure)
Get the virtual_hardware_platform_versions field of the given host.
Get the virtual_hardware_platform_versions field of the given host. (Raise error on XMLRPC failure)
Return a set of VMs which prevent the host being evacuated, with per-VM error codes
Return a set of VMs which prevent the host being evacuated, with per-VM error codes (Raise error on XMLRPC failure)
Return true if the extension is available on the host
Return true if the extension is available on the host (Raise error on XMLRPC failure)
Apply a new license to a host
Apply a new license to a host (Raise error on XMLRPC failure)
Apply a new license to a host
Apply a new license to a host (Raise error on XMLRPC failure)
Remove any license file from the specified host, and switch that host to the unlicensed edition
Remove any license file from the specified host, and switch that host to the unlicensed edition (Raise error on XMLRPC failure)
List all supported methods
List all supported methods (Raise error on XMLRPC failure)
Reconfigure the management network interface. Should only be used if Host.management_reconfigure is impossible because the network configuration is broken.
Reconfigure the management network interface. Should only be used if Host.management_reconfigure is impossible because the network configuration is broken. (Raise error on XMLRPC failure)
Disable the management network interface
Disable the management network interface (Raise error on XMLRPC failure)
Reconfigure the management network interface
Reconfigure the management network interface (Raise error on XMLRPC failure)
Prepare to receive a VM, returning a token which can be passed to VM.migrate.
Prepare to receive a VM, returning a token which can be passed to VM.migrate. (Raise error on XMLRPC failure)
Attempt to power-on the host (if the capability exists).
Attempt to power-on the host (if the capability exists). (Raise error on XMLRPC failure)
Query the latest value of the specified data source
Query the latest value of the specified data source (Raise error on XMLRPC failure)
Reboot the host. (This function can only be called if there are no currently running VMs on the host and it is disabled.)
Reboot the host. (This function can only be called if there are no currently running VMs on the host and it is disabled.) (Raise error on XMLRPC failure)
Start recording the specified data source
Start recording the specified data source (Raise error on XMLRPC failure)
Refresh the list of installed Supplemental Packs.
Refresh the list of installed Supplemental Packs. (Raise error on XMLRPC failure)
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.
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. (Raise error on XMLRPC failure)
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.
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. (Raise error on XMLRPC failure)
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.
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. (Raise error on XMLRPC failure)
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.
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. (Raise error on XMLRPC failure)
Remove the given value from the tags field of the given host. If the value is not in that Set, then do nothing.
Remove the given value from the tags field of the given host. If the value is not in that Set, then do nothing. (Raise error on XMLRPC failure)
Remove the feature mask, such that after a reboot all features of the CPU are enabled.
Remove the feature mask, such that after a reboot all features of the CPU are enabled. (Raise error on XMLRPC failure)
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.
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. (Raise error on XMLRPC failure)
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.
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. (Raise error on XMLRPC failure)
Inject the given string as debugging keys into Xen
Inject the given string as debugging keys into Xen (Raise error on XMLRPC failure)
Set the address field of the given host.
Set the address field of the given host. (Raise error on XMLRPC failure)
Set the CPU features to be used after a reboot, if the given features string is valid.
Set the CPU features to be used after a reboot, if the given features string is valid. (Raise error on XMLRPC failure)
Set the crash_dump_sr field of the given host.
Set the crash_dump_sr field of the given host. (Raise error on XMLRPC failure)
Set the display field of the given host.
Set the display field of the given host. (Raise error on XMLRPC failure)
Set the guest_VCPUs_params field of the given host.
Set the guest_VCPUs_params field of the given host. (Raise error on XMLRPC failure)
Set the hostname field of the given host.
Set the hostname field of the given host. (Raise error on XMLRPC failure)
Sets the host name to the specified string. Both the API and lower-level system hostname are changed immediately.
Sets the host name to the specified string. Both the API and lower-level system hostname are changed immediately. (Raise error on XMLRPC failure)
Sets the initiator IQN for the host
Sets the initiator IQN for the host (Raise error on XMLRPC failure)
Set the license_server field of the given host.
Set the license_server field of the given host. (Raise error on XMLRPC failure)
Set the logging field of the given host.
Set the logging field of the given host. (Raise error on XMLRPC failure)
Specifies whether multipathing is enabled
Specifies whether multipathing is enabled (Raise error on XMLRPC failure)
Set the name/description field of the given host.
Set the name/description field of the given host. (Raise error on XMLRPC failure)
Set the name/label field of the given host.
Set the name/label field of the given host. (Raise error on XMLRPC failure)
Set the other_config field of the given host.
Set the other_config field of the given host. (Raise error on XMLRPC failure)
Set the power-on-mode, host, user and password
Set the power-on-mode, host, user and password (Raise error on XMLRPC failure)
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.
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. (Raise error on XMLRPC failure)
Set the suspend_image_sr field of the given host.
Set the suspend_image_sr field of the given host. (Raise error on XMLRPC failure)
Set the tags field of the given host.
Set the tags field of the given host. (Raise error on XMLRPC failure)
Sets the UEFI certificates on a host
Sets the UEFI certificates on a host (Raise error on XMLRPC failure)
Shutdown the host. (This function can only be called if there are no currently running VMs on the host and it is disabled.)
Shutdown the host. (This function can only be called if there are no currently running VMs on the host and it is disabled.) (Raise error on XMLRPC failure)
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.
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. (Raise error on XMLRPC failure)
This causes the synchronisation of the non-database data (messages, RRDs and so on) stored on the master to be synchronised with the host
This causes the synchronisation of the non-database data (messages, RRDs and so on) stored on the master to be synchronised with the host (Raise error on XMLRPC failure)
Re-configure syslog logging
Re-configure syslog logging (Raise error on XMLRPC failure)
Link to this section Functions
Add the given value to the tags field of the given host. If the value is already in that Set, then do nothing.
Add the given value to the tags field of the given host. If the value is already in that Set, then do nothing. (Raise error on XMLRPC failure)
Add the given key-value pair to the guest_VCPUs_params field of the given host.
Add the given key-value pair to the guest_VCPUs_params field of the given host. (Raise error on XMLRPC failure)
Add the given key-value pair to the license_server field of the given host.
Add the given key-value pair to the license_server field of the given host. (Raise error on XMLRPC failure)
Add the given key-value pair to the logging field of the given host.
Add the given key-value pair to the logging field of the given host. (Raise error on XMLRPC failure)
Add the given key-value pair to the other_config field of the given host.
Add the given key-value pair to the other_config field of the given host. (Raise error on XMLRPC failure)
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.
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. (Raise error on XMLRPC failure)
Check this host can be evacuated.
Check this host can be evacuated. (Raise error on XMLRPC failure)
This causes the RRDs to be backed up to the master
This causes the RRDs to be backed up to the master (Raise error on XMLRPC failure)
Run xen-bugtool --yestoall and upload the output to support
Run xen-bugtool --yestoall and upload the output to support (Raise error on XMLRPC failure)
Call an API extension on this host
Call an API extension on this host (Raise error on XMLRPC failure)
Call an API plugin on this host
Call an API plugin on this host (Raise error on XMLRPC failure)
Computes the amount of free memory on the host.
Computes the amount of free memory on the host. (Raise error on XMLRPC failure)
Computes the virtualization memory overhead of a host.
Computes the virtualization memory overhead of a host. (Raise error on XMLRPC failure)
Create a placeholder for a named binary blob of data that is associated with this host
Create a placeholder for a named binary blob of data that is associated with this host (Raise error on XMLRPC failure)
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
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 (Raise error on XMLRPC failure)
Destroy specified host record in database
Destroy specified host record in database (Raise error on XMLRPC failure)
Puts the host into a state in which no new VMs can be started. Currently active VMs on the host continue to execute.
Puts the host into a state in which no new VMs can be started. Currently active VMs on the host continue to execute. (Raise error on XMLRPC failure)
Disable console output to the physical display device next time this host boots
Disable console output to the physical display device next time this host boots (Raise error on XMLRPC failure)
This call disables external authentication on the local host
This call disables external authentication on the local host (Raise error on XMLRPC failure)
Disable the use of a local SR for caching purposes
Disable the use of a local SR for caching purposes (Raise error on XMLRPC failure)
Get the host xen dmesg.
Get the host xen dmesg. (Raise error on XMLRPC failure)
Get the host xen dmesg, and clear the buffer.
Get the host xen dmesg, and clear the buffer. (Raise error on XMLRPC failure)
This call disables HA on the local host. This should only be used with extreme care.
This call disables HA on the local host. This should only be used with extreme care. (Raise error on XMLRPC failure)
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. (Raise error on XMLRPC failure)
Enable console output to the physical display device next time this host boots
Enable console output to the physical display device next time this host boots (Raise error on XMLRPC failure)
enable_external_auth(xen_session, host, config, service_name, auth_type)
View SourceThis call enables external authentication on a host
enable_external_auth!(xen_session, host, config, service_name, auth_type)
View SourceThis call enables external authentication on a host (Raise error on XMLRPC failure)
Enable the use of a local SR for caching purposes
Enable the use of a local SR for caching purposes (Raise error on XMLRPC failure)
Migrate all VMs off of this host, where possible.
Migrate all VMs off of this host, where possible. (Raise error on XMLRPC failure)
Forget the recorded statistics related to the specified data source
Forget the recorded statistics related to the specified data source (Raise error on XMLRPC failure)
Get the API_version/major field of the given host.
Get the API_version/major field of the given host. (Raise error on XMLRPC failure)
Get the API_version/minor field of the given host.
Get the API_version/minor field of the given host. (Raise error on XMLRPC failure)
Get the API_version/vendor field of the given host.
Get the API_version/vendor field of the given host. (Raise error on XMLRPC failure)
Get the API_version/vendor_implementation field of the given host.
Get the API_version/vendor_implementation field of the given host. (Raise error on XMLRPC failure)
Get the address field of the given host.
Get the address field of the given host. (Raise error on XMLRPC failure)
Return a list of all the hosts known to the system.
Return a list of all the hosts known to the system. (Raise error on XMLRPC failure)
Return a map of host references to host records for all hosts known to the system.
Return a map of host references to host records for all hosts known to the system. (Raise error on XMLRPC failure)
Get the allowed_operations field of the given host.
Get the allowed_operations field of the given host. (Raise error on XMLRPC failure)
Get the bios_strings field of the given host.
Get the bios_strings field of the given host. (Raise error on XMLRPC failure)
Get the blobs field of the given host.
Get the blobs field of the given host. (Raise error on XMLRPC failure)
Get all the host instances with the given label.
Get all the host instances with the given label. (Raise error on XMLRPC failure)
Get a reference to the host instance with the specified UUID.
Get a reference to the host instance with the specified UUID. (Raise error on XMLRPC failure)
Get the capabilities field of the given host.
Get the capabilities field of the given host. (Raise error on XMLRPC failure)
Get the chipset_info field of the given host.
Get the chipset_info field of the given host. (Raise error on XMLRPC failure)
Get the control_domain field of the given host.
Get the control_domain field of the given host. (Raise error on XMLRPC failure)
Get the cpu_configuration field of the given host.
Get the cpu_configuration field of the given host. (Raise error on XMLRPC failure)
Get the cpu_info field of the given host.
Get the cpu_info field of the given host. (Raise error on XMLRPC failure)
Get the crash_dump_sr field of the given host.
Get the crash_dump_sr field of the given host. (Raise error on XMLRPC failure)
Get the crashdumps field of the given host.
Get the crashdumps field of the given host. (Raise error on XMLRPC failure)
Get the current_operations field of the given host.
Get the current_operations field of the given host. (Raise error on XMLRPC failure)
(Raise error on XMLRPC failure)
Get the display field of the given host.
Get the display field of the given host. (Raise error on XMLRPC failure)
Get the edition field of the given host.
Get the edition field of the given host. (Raise error on XMLRPC failure)
Get the enabled field of the given host.
Get the enabled field of the given host. (Raise error on XMLRPC failure)
Get the external_auth_configuration field of the given host.
Get the external_auth_configuration field of the given host. (Raise error on XMLRPC failure)
Get the external_auth_service_name field of the given host.
Get the external_auth_service_name field of the given host. (Raise error on XMLRPC failure)
Get the external_auth_type field of the given host.
Get the external_auth_type field of the given host. (Raise error on XMLRPC failure)
Get the features field of the given host.
Get the features field of the given host. (Raise error on XMLRPC failure)
Get the guest_VCPUs_params field of the given host.
Get the guest_VCPUs_params field of the given host. (Raise error on XMLRPC failure)
Get the ha_network_peers field of the given host.
Get the ha_network_peers field of the given host. (Raise error on XMLRPC failure)
Get the ha_statefiles field of the given host.
Get the ha_statefiles field of the given host. (Raise error on XMLRPC failure)
Get the host_CPUs field of the given host.
Get the host_CPUs field of the given host. (Raise error on XMLRPC failure)
Get the hostname field of the given host.
Get the hostname field of the given host. (Raise error on XMLRPC failure)
Get the iscsi_iqn field of the given host.
Get the iscsi_iqn field of the given host. (Raise error on XMLRPC failure)
Get the license_params field of the given host.
Get the license_params field of the given host. (Raise error on XMLRPC failure)
Get the license_server field of the given host.
Get the license_server field of the given host. (Raise error on XMLRPC failure)
Get the local_cache_sr field of the given host.
Get the local_cache_sr field of the given host. (Raise error on XMLRPC failure)
Get the host's log file
Get the host's log file (Raise error on XMLRPC failure)
Get the logging field of the given host.
Get the logging field of the given host. (Raise error on XMLRPC failure)
Returns the management interface for the specified host
Returns the management interface for the specified host (Raise error on XMLRPC failure)
Get the memory/overhead field of the given host.
Get the memory/overhead field of the given host. (Raise error on XMLRPC failure)
Get the metrics field of the given host.
Get the metrics field of the given host. (Raise error on XMLRPC failure)
Get the multipathing field of the given host.
Get the multipathing field of the given host. (Raise error on XMLRPC failure)
Get the name/description field of the given host.
Get the name/description field of the given host. (Raise error on XMLRPC failure)
Get the name/label field of the given host.
Get the name/label field of the given host. (Raise error on XMLRPC failure)
Get the other_config field of the given host.
Get the other_config field of the given host. (Raise error on XMLRPC failure)
Get the PBDs field of the given host.
Get the PBDs field of the given host. (Raise error on XMLRPC failure)
Get the PCIs field of the given host.
Get the PCIs field of the given host. (Raise error on XMLRPC failure)
Get the PGPUs field of the given host.
Get the PGPUs field of the given host. (Raise error on XMLRPC failure)
Get the PIFs field of the given host.
Get the PIFs field of the given host. (Raise error on XMLRPC failure)
Get the PUSBs field of the given host.
Get the PUSBs field of the given host. (Raise error on XMLRPC failure)
Get the patches field of the given host.
Get the patches field of the given host. (Raise error on XMLRPC failure)
Get the power_on_config field of the given host.
Get the power_on_config field of the given host. (Raise error on XMLRPC failure)
Get the power_on_mode field of the given host.
Get the power_on_mode field of the given host. (Raise error on XMLRPC failure)
Get a record containing the current state of the given host. Returns XenAPI.Host
struct.
Get a record containing the current state of the given host. Returns XenAPI.Host
struct. (Raise error on XMLRPC failure)
Get the resident_VMs field of the given host.
Get the resident_VMs field of the given host. (Raise error on XMLRPC failure)
Get the sched_policy field of the given host.
Get the sched_policy field of the given host. (Raise error on XMLRPC failure)
Get the installed server public TLS certificate.
Get the installed server public TLS certificate. (Raise error on XMLRPC failure)
This call queries the host's clock for the current time in the host's local timezone
This call queries the host's clock for the current time in the host's local timezone (Raise error on XMLRPC failure)
This call queries the host's clock for the current time
This call queries the host's clock for the current time (Raise error on XMLRPC failure)
Get the software_version field of the given host.
Get the software_version field of the given host. (Raise error on XMLRPC failure)
Get the ssl_legacy field of the given host.
Get the ssl_legacy field of the given host. (Raise error on XMLRPC failure)
Get the supported_bootloaders field of the given host.
Get the supported_bootloaders field of the given host. (Raise error on XMLRPC failure)
Get the suspend_image_sr field of the given host.
Get the suspend_image_sr field of the given host. (Raise error on XMLRPC failure)
(Raise error on XMLRPC failure)
Get the tags field of the given host.
Get the tags field of the given host. (Raise error on XMLRPC failure)
Get the uefi_certificates field of the given host.
Get the uefi_certificates field of the given host. (Raise error on XMLRPC failure)
Return a set of VMs which are not co-operating with the host's memory control system
Return a set of VMs which are not co-operating with the host's memory control system (Raise error on XMLRPC failure)
Get the updates field of the given host.
Get the updates field of the given host. (Raise error on XMLRPC failure)
Get the updates_requiring_reboot field of the given host.
Get the updates_requiring_reboot field of the given host. (Raise error on XMLRPC failure)
Get the uuid field of the given host.
Get the uuid field of the given host. (Raise error on XMLRPC failure)
Get the virtual_hardware_platform_versions field of the given host.
Get the virtual_hardware_platform_versions field of the given host. (Raise error on XMLRPC failure)
Return a set of VMs which prevent the host being evacuated, with per-VM error codes
Return a set of VMs which prevent the host being evacuated, with per-VM error codes (Raise error on XMLRPC failure)
Return true if the extension is available on the host
Return true if the extension is available on the host (Raise error on XMLRPC failure)
Apply a new license to a host
Apply a new license to a host (Raise error on XMLRPC failure)
Apply a new license to a host
Apply a new license to a host (Raise error on XMLRPC failure)
Remove any license file from the specified host, and switch that host to the unlicensed edition
Remove any license file from the specified host, and switch that host to the unlicensed edition (Raise error on XMLRPC failure)
List all supported methods
List all supported methods (Raise error on XMLRPC failure)
Reconfigure the management network interface. Should only be used if Host.management_reconfigure is impossible because the network configuration is broken.
Reconfigure the management network interface. Should only be used if Host.management_reconfigure is impossible because the network configuration is broken. (Raise error on XMLRPC failure)
Disable the management network interface
Disable the management network interface (Raise error on XMLRPC failure)
Reconfigure the management network interface
Reconfigure the management network interface (Raise error on XMLRPC failure)
Prepare to receive a VM, returning a token which can be passed to VM.migrate.
Prepare to receive a VM, returning a token which can be passed to VM.migrate. (Raise error on XMLRPC failure)
Attempt to power-on the host (if the capability exists).
Attempt to power-on the host (if the capability exists). (Raise error on XMLRPC failure)
Query the latest value of the specified data source
Query the latest value of the specified data source (Raise error on XMLRPC failure)
Reboot the host. (This function can only be called if there are no currently running VMs on the host and it is disabled.)
Reboot the host. (This function can only be called if there are no currently running VMs on the host and it is disabled.) (Raise error on XMLRPC failure)
Start recording the specified data source
Start recording the specified data source (Raise error on XMLRPC failure)
Refresh the list of installed Supplemental Packs.
Refresh the list of installed Supplemental Packs. (Raise error on XMLRPC failure)
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.
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. (Raise error on XMLRPC failure)
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.
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. (Raise error on XMLRPC failure)
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.
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. (Raise error on XMLRPC failure)
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.
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. (Raise error on XMLRPC failure)
Remove the given value from the tags field of the given host. If the value is not in that Set, then do nothing.
Remove the given value from the tags field of the given host. If the value is not in that Set, then do nothing. (Raise error on XMLRPC failure)
Remove the feature mask, such that after a reboot all features of the CPU are enabled.
Remove the feature mask, such that after a reboot all features of the CPU are enabled. (Raise error on XMLRPC failure)
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.
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. (Raise error on XMLRPC failure)
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.
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. (Raise error on XMLRPC failure)
Inject the given string as debugging keys into Xen
Inject the given string as debugging keys into Xen (Raise error on XMLRPC failure)
Set the address field of the given host.
Set the address field of the given host. (Raise error on XMLRPC failure)
Set the CPU features to be used after a reboot, if the given features string is valid.
Set the CPU features to be used after a reboot, if the given features string is valid. (Raise error on XMLRPC failure)
Set the crash_dump_sr field of the given host.
Set the crash_dump_sr field of the given host. (Raise error on XMLRPC failure)
Set the display field of the given host.
Set the display field of the given host. (Raise error on XMLRPC failure)
Set the guest_VCPUs_params field of the given host.
Set the guest_VCPUs_params field of the given host. (Raise error on XMLRPC failure)
Set the hostname field of the given host.
Set the hostname field of the given host. (Raise error on XMLRPC failure)
Sets the host name to the specified string. Both the API and lower-level system hostname are changed immediately.
Sets the host name to the specified string. Both the API and lower-level system hostname are changed immediately. (Raise error on XMLRPC failure)
Sets the initiator IQN for the host
Sets the initiator IQN for the host (Raise error on XMLRPC failure)
Set the license_server field of the given host.
Set the license_server field of the given host. (Raise error on XMLRPC failure)
Set the logging field of the given host.
Set the logging field of the given host. (Raise error on XMLRPC failure)
Specifies whether multipathing is enabled
Specifies whether multipathing is enabled (Raise error on XMLRPC failure)
Set the name/description field of the given host.
Set the name/description field of the given host. (Raise error on XMLRPC failure)
Set the name/label field of the given host.
Set the name/label field of the given host. (Raise error on XMLRPC failure)
Set the other_config field of the given host.
Set the other_config field of the given host. (Raise error on XMLRPC failure)
set_power_on_mode(xen_session, host_ref, power_on_mode, power_on_config)
View SourceSet the power-on-mode, host, user and password
set_power_on_mode!(xen_session, host_ref, power_on_mode, power_on_config)
View SourceSet the power-on-mode, host, user and password (Raise error on XMLRPC failure)
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.
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. (Raise error on XMLRPC failure)
Set the suspend_image_sr field of the given host.
Set the suspend_image_sr field of the given host. (Raise error on XMLRPC failure)
Set the tags field of the given host.
Set the tags field of the given host. (Raise error on XMLRPC failure)
Sets the UEFI certificates on a host
Sets the UEFI certificates on a host (Raise error on XMLRPC failure)
Shutdown the host. (This function can only be called if there are no currently running VMs on the host and it is disabled.)
Shutdown the host. (This function can only be called if there are no currently running VMs on the host and it is disabled.) (Raise error on XMLRPC failure)
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.
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. (Raise error on XMLRPC failure)
This causes the synchronisation of the non-database data (messages, RRDs and so on) stored on the master to be synchronised with the host
This causes the synchronisation of the non-database data (messages, RRDs and so on) stored on the master to be synchronised with the host (Raise error on XMLRPC failure)
Re-configure syslog logging
Re-configure syslog logging (Raise error on XMLRPC failure)