View Source XenAPI.Host (XenAPI v0.1.1)

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 (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.

Get a record containing the current state of the given host. (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

Link to this function

add_tags(xen_session, host_ref, value)

View Source

Add the given value to the tags field of the given host. If the value is already in that Set, then do nothing.

Link to this function

add_tags!(xen_session, host_ref, value)

View Source

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)

Link to this function

add_to_guest_VCPUs_params(xen_session, host_ref, key, value)

View Source

Add the given key-value pair to the guest_VCPUs_params field of the given host.

Link to this function

add_to_guest_VCPUs_params!(xen_session, host_ref, key, value)

View Source

Add the given key-value pair to the guest_VCPUs_params field of the given host. (Raise error on XMLRPC failure)

Link to this function

add_to_license_server(xen_session, host_ref, key, value)

View Source

Add the given key-value pair to the license_server field of the given host.

Link to this function

add_to_license_server!(xen_session, host_ref, key, value)

View Source

Add the given key-value pair to the license_server field of the given host. (Raise error on XMLRPC failure)

Link to this function

add_to_logging(xen_session, host_ref, key, value)

View Source

Add the given key-value pair to the logging field of the given host.

Link to this function

add_to_logging!(xen_session, host_ref, key, value)

View Source

Add the given key-value pair to the logging field of the given host. (Raise error on XMLRPC failure)

Link to this function

add_to_other_config(xen_session, host_ref, key, value)

View Source

Add the given key-value pair to the other_config field of the given host.

Link to this function

add_to_other_config!(xen_session, host_ref, key, value)

View Source

Add the given key-value pair to the other_config field of the given host. (Raise error on XMLRPC failure)

Link to this function

apply_edition(xen_session, host, edition, force)

View Source

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.

Link to this function

apply_edition!(xen_session, host, edition, force)

View Source

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)

Link to this function

assert_can_evacuate(xen_session, host)

View Source

Check this host can be evacuated.

Link to this function

assert_can_evacuate!(xen_session, host)

View Source

Check this host can be evacuated. (Raise error on XMLRPC failure)

Link to this function

backup_rrds(xen_session, host, delay)

View Source

This causes the RRDs to be backed up to the master

Link to this function

backup_rrds!(xen_session, host, delay)

View Source

This causes the RRDs to be backed up to the master (Raise error on XMLRPC failure)

Link to this function

bugreport_upload(xen_session, host, url, options)

View Source

Run xen-bugtool --yestoall and upload the output to support

Link to this function

bugreport_upload!(xen_session, host, url, options)

View Source

Run xen-bugtool --yestoall and upload the output to support (Raise error on XMLRPC failure)

Link to this function

call_extension(xen_session, host, call)

View Source

Call an API extension on this host

Link to this function

call_extension!(xen_session, host, call)

View Source

Call an API extension on this host (Raise error on XMLRPC failure)

Link to this function

call_plugin(xen_session, host, plugin, function, args)

View Source

Call an API plugin on this host

Link to this function

call_plugin!(xen_session, host, plugin, function, args)

View Source

Call an API plugin on this host (Raise error on XMLRPC failure)

Link to this function

compute_free_memory(xen_session, host)

View Source

Computes the amount of free memory on the host.

Link to this function

compute_free_memory!(xen_session, host)

View Source

Computes the amount of free memory on the host. (Raise error on XMLRPC failure)

Link to this function

compute_memory_overhead(xen_session, host)

View Source

Computes the virtualization memory overhead of a host.

Link to this function

compute_memory_overhead!(xen_session, host)

View Source

Computes the virtualization memory overhead of a host. (Raise error on XMLRPC failure)

Link to this function

create_new_blob(xen_session, host, name, mime_type, public)

View Source

Create a placeholder for a named binary blob of data that is associated with this host

Link to this function

create_new_blob!(xen_session, host, name, mime_type, public)

View Source

Create a placeholder for a named binary blob of data that is associated with this host (Raise error on XMLRPC failure)

Link to this function

declare_dead(xen_session, host)

View Source

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

Link to this function

declare_dead!(xen_session, host)

View Source

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)

Link to this function

destroy(xen_session, host_ref)

View Source

Destroy specified host record in database

Link to this function

destroy!(xen_session, host_ref)

View Source

Destroy specified host record in database (Raise error on XMLRPC failure)

Link to this function

disable(xen_session, host)

View Source

Puts the host into a state in which no new VMs can be started. Currently active VMs on the host continue to execute.

Link to this function

disable!(xen_session, host)

View Source

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)

Link to this function

disable_display(xen_session, host)

View Source

Disable console output to the physical display device next time this host boots

Link to this function

disable_display!(xen_session, host)

View Source

Disable console output to the physical display device next time this host boots (Raise error on XMLRPC failure)

Link to this function

disable_external_auth(xen_session, host, config)

View Source

This call disables external authentication on the local host

Link to this function

disable_external_auth!(xen_session, host, config)

View Source

This call disables external authentication on the local host (Raise error on XMLRPC failure)

Link to this function

disable_local_storage_caching(xen_session, host)

View Source

Disable the use of a local SR for caching purposes

Link to this function

disable_local_storage_caching!(xen_session, host)

View Source

Disable the use of a local SR for caching purposes (Raise error on XMLRPC failure)

Link to this function

dmesg(xen_session, host)

View Source

Get the host xen dmesg.

Link to this function

dmesg!(xen_session, host)

View Source

Get the host xen dmesg. (Raise error on XMLRPC failure)

Link to this function

dmesg_clear(xen_session, host)

View Source

Get the host xen dmesg, and clear the buffer.

Link to this function

dmesg_clear!(xen_session, host)

View Source

Get the host xen dmesg, and clear the buffer. (Raise error on XMLRPC failure)

Link to this function

emergency_ha_disable(xen_session, soft)

View Source

This call disables HA on the local host. This should only be used with extreme care.

Link to this function

emergency_ha_disable!(xen_session, soft)

View Source

This call disables HA on the local host. This should only be used with extreme care. (Raise error on XMLRPC failure)

Link to this function

enable(xen_session, host)

View Source

Puts the host into a state in which new VMs can be started.

Link to this function

enable!(xen_session, host)

View Source

Puts the host into a state in which new VMs can be started. (Raise error on XMLRPC failure)

Link to this function

enable_display(xen_session, host)

View Source

Enable console output to the physical display device next time this host boots

Link to this function

enable_display!(xen_session, host)

View Source

Enable console output to the physical display device next time this host boots (Raise error on XMLRPC failure)

Link to this function

enable_external_auth(xen_session, host, config, service_name, auth_type)

View Source

This call enables external authentication on a host

Link to this function

enable_external_auth!(xen_session, host, config, service_name, auth_type)

View Source

This call enables external authentication on a host (Raise error on XMLRPC failure)

Link to this function

enable_local_storage_caching(xen_session, host, sr)

View Source

Enable the use of a local SR for caching purposes

Link to this function

enable_local_storage_caching!(xen_session, host, sr)

View Source

Enable the use of a local SR for caching purposes (Raise error on XMLRPC failure)

Link to this function

evacuate(xen_session, host)

View Source

Migrate all VMs off of this host, where possible.

Link to this function

evacuate!(xen_session, host)

View Source

Migrate all VMs off of this host, where possible. (Raise error on XMLRPC failure)

Link to this function

forget_data_source_archives(xen_session, host, data_source)

View Source

Forget the recorded statistics related to the specified data source

Link to this function

forget_data_source_archives!(xen_session, host, data_source)

View Source

Forget the recorded statistics related to the specified data source (Raise error on XMLRPC failure)

Link to this function

get_API_version_major(xen_session, host_ref)

View Source

Get the API_version/major field of the given host.

Link to this function

get_API_version_major!(xen_session, host_ref)

View Source

Get the API_version/major field of the given host. (Raise error on XMLRPC failure)

Link to this function

get_API_version_minor(xen_session, host_ref)

View Source

Get the API_version/minor field of the given host.

Link to this function

get_API_version_minor!(xen_session, host_ref)

View Source

Get the API_version/minor field of the given host. (Raise error on XMLRPC failure)

Link to this function

get_API_version_vendor(xen_session, host_ref)

View Source

Get the API_version/vendor field of the given host.

Link to this function

get_API_version_vendor!(xen_session, host_ref)

View Source

Get the API_version/vendor field of the given host. (Raise error on XMLRPC failure)

Link to this function

get_API_version_vendor_implementation(xen_session, host_ref)

View Source

Get the API_version/vendor_implementation field of the given host.

Link to this function

get_API_version_vendor_implementation!(xen_session, host_ref)

View Source

Get the API_version/vendor_implementation field of the given host. (Raise error on XMLRPC failure)

Link to this function

get_address(xen_session, host_ref)

View Source

Get the address field of the given host.

Link to this function

get_address!(xen_session, host_ref)

View Source

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)

Link to this function

get_all_records(xen_session)

View Source

Return a map of host references to host records for all hosts known to the system.

Link to this function

get_all_records!(xen_session)

View Source

Return a map of host references to host records for all hosts known to the system. (Raise error on XMLRPC failure)

Link to this function

get_allowed_operations(xen_session, host_ref)

View Source

Get the allowed_operations field of the given host.

Link to this function

get_allowed_operations!(xen_session, host_ref)

View Source

Get the allowed_operations field of the given host. (Raise error on XMLRPC failure)

Link to this function

get_bios_strings(xen_session, host_ref)

View Source

Get the bios_strings field of the given host.

Link to this function

get_bios_strings!(xen_session, host_ref)

View Source

Get the bios_strings field of the given host. (Raise error on XMLRPC failure)

Link to this function

get_blobs(xen_session, host_ref)

View Source

Get the blobs field of the given host.

Link to this function

get_blobs!(xen_session, host_ref)

View Source

Get the blobs field of the given host. (Raise error on XMLRPC failure)

Link to this function

get_by_name_label(xen_session, label)

View Source

Get all the host instances with the given label.

Link to this function

get_by_name_label!(xen_session, label)

View Source

Get all the host instances with the given label. (Raise error on XMLRPC failure)

Link to this function

get_by_uuid(xen_session, uuid)

View Source

Get a reference to the host instance with the specified UUID.

Link to this function

get_by_uuid!(xen_session, uuid)

View Source

Get a reference to the host instance with the specified UUID. (Raise error on XMLRPC failure)

Link to this function

get_capabilities(xen_session, host_ref)

View Source

Get the capabilities field of the given host.

Link to this function

get_capabilities!(xen_session, host_ref)

View Source

Get the capabilities field of the given host. (Raise error on XMLRPC failure)

Link to this function

get_chipset_info(xen_session, host_ref)

View Source

Get the chipset_info field of the given host.

Link to this function

get_chipset_info!(xen_session, host_ref)

View Source

Get the chipset_info field of the given host. (Raise error on XMLRPC failure)

Link to this function

get_control_domain(xen_session, host_ref)

View Source

Get the control_domain field of the given host.

Link to this function

get_control_domain!(xen_session, host_ref)

View Source

Get the control_domain field of the given host. (Raise error on XMLRPC failure)

Link to this function

get_cpu_configuration(xen_session, host_ref)

View Source

Get the cpu_configuration field of the given host.

Link to this function

get_cpu_configuration!(xen_session, host_ref)

View Source

Get the cpu_configuration field of the given host. (Raise error on XMLRPC failure)

Link to this function

get_cpu_info(xen_session, host_ref)

View Source

Get the cpu_info field of the given host.

Link to this function

get_cpu_info!(xen_session, host_ref)

View Source

Get the cpu_info field of the given host. (Raise error on XMLRPC failure)

Link to this function

get_crash_dump_sr(xen_session, host_ref)

View Source

Get the crash_dump_sr field of the given host.

Link to this function

get_crash_dump_sr!(xen_session, host_ref)

View Source

Get the crash_dump_sr field of the given host. (Raise error on XMLRPC failure)

Link to this function

get_crashdumps(xen_session, host_ref)

View Source

Get the crashdumps field of the given host.

Link to this function

get_crashdumps!(xen_session, host_ref)

View Source

Get the crashdumps field of the given host. (Raise error on XMLRPC failure)

Link to this function

get_current_operations(xen_session, host_ref)

View Source

Get the current_operations field of the given host.

Link to this function

get_current_operations!(xen_session, host_ref)

View Source

Get the current_operations field of the given host. (Raise error on XMLRPC failure)

Link to this function

get_data_sources(xen_session, host)

View Source
Link to this function

get_data_sources!(xen_session, host)

View Source

(Raise error on XMLRPC failure)

Link to this function

get_display(xen_session, host_ref)

View Source

Get the display field of the given host.

Link to this function

get_display!(xen_session, host_ref)

View Source

Get the display field of the given host. (Raise error on XMLRPC failure)

Link to this function

get_edition(xen_session, host_ref)

View Source

Get the edition field of the given host.

Link to this function

get_edition!(xen_session, host_ref)

View Source

Get the edition field of the given host. (Raise error on XMLRPC failure)

Link to this function

get_enabled(xen_session, host_ref)

View Source

Get the enabled field of the given host.

Link to this function

get_enabled!(xen_session, host_ref)

View Source

Get the enabled field of the given host. (Raise error on XMLRPC failure)

Link to this function

get_external_auth_configuration(xen_session, host_ref)

View Source

Get the external_auth_configuration field of the given host.

Link to this function

get_external_auth_configuration!(xen_session, host_ref)

View Source

Get the external_auth_configuration field of the given host. (Raise error on XMLRPC failure)

Link to this function

get_external_auth_service_name(xen_session, host_ref)

View Source

Get the external_auth_service_name field of the given host.

Link to this function

get_external_auth_service_name!(xen_session, host_ref)

View Source

Get the external_auth_service_name field of the given host. (Raise error on XMLRPC failure)

Link to this function

get_external_auth_type(xen_session, host_ref)

View Source

Get the external_auth_type field of the given host.

Link to this function

get_external_auth_type!(xen_session, host_ref)

View Source

Get the external_auth_type field of the given host. (Raise error on XMLRPC failure)

Link to this function

get_features(xen_session, host_ref)

View Source

Get the features field of the given host.

Link to this function

get_features!(xen_session, host_ref)

View Source

Get the features field of the given host. (Raise error on XMLRPC failure)

Link to this function

get_guest_VCPUs_params(xen_session, host_ref)

View Source

Get the guest_VCPUs_params field of the given host.

Link to this function

get_guest_VCPUs_params!(xen_session, host_ref)

View Source

Get the guest_VCPUs_params field of the given host. (Raise error on XMLRPC failure)

Link to this function

get_ha_network_peers(xen_session, host_ref)

View Source

Get the ha_network_peers field of the given host.

Link to this function

get_ha_network_peers!(xen_session, host_ref)

View Source

Get the ha_network_peers field of the given host. (Raise error on XMLRPC failure)

Link to this function

get_ha_statefiles(xen_session, host_ref)

View Source

Get the ha_statefiles field of the given host.

Link to this function

get_ha_statefiles!(xen_session, host_ref)

View Source

Get the ha_statefiles field of the given host. (Raise error on XMLRPC failure)

Link to this function

get_host_CPUs(xen_session, host_ref)

View Source

Get the host_CPUs field of the given host.

Link to this function

get_host_CPUs!(xen_session, host_ref)

View Source

Get the host_CPUs field of the given host. (Raise error on XMLRPC failure)

Link to this function

get_hostname(xen_session, host_ref)

View Source

Get the hostname field of the given host.

Link to this function

get_hostname!(xen_session, host_ref)

View Source

Get the hostname field of the given host. (Raise error on XMLRPC failure)

Link to this function

get_iscsi_iqn(xen_session, host_ref)

View Source

Get the iscsi_iqn field of the given host.

Link to this function

get_iscsi_iqn!(xen_session, host_ref)

View Source

Get the iscsi_iqn field of the given host. (Raise error on XMLRPC failure)

Link to this function

get_license_params(xen_session, host_ref)

View Source

Get the license_params field of the given host.

Link to this function

get_license_params!(xen_session, host_ref)

View Source

Get the license_params field of the given host. (Raise error on XMLRPC failure)

Link to this function

get_license_server(xen_session, host_ref)

View Source

Get the license_server field of the given host.

Link to this function

get_license_server!(xen_session, host_ref)

View Source

Get the license_server field of the given host. (Raise error on XMLRPC failure)

Link to this function

get_local_cache_sr(xen_session, host_ref)

View Source

Get the local_cache_sr field of the given host.

Link to this function

get_local_cache_sr!(xen_session, host_ref)

View Source

Get the local_cache_sr field of the given host. (Raise error on XMLRPC failure)

Link to this function

get_log(xen_session, host)

View Source

Get the host's log file

Link to this function

get_log!(xen_session, host)

View Source

Get the host's log file (Raise error on XMLRPC failure)

Link to this function

get_logging(xen_session, host_ref)

View Source

Get the logging field of the given host.

Link to this function

get_logging!(xen_session, host_ref)

View Source

Get the logging field of the given host. (Raise error on XMLRPC failure)

Link to this function

get_management_interface(xen_session, host)

View Source

Returns the management interface for the specified host

Link to this function

get_management_interface!(xen_session, host)

View Source

Returns the management interface for the specified host (Raise error on XMLRPC failure)

Link to this function

get_memory_overhead(xen_session, host_ref)

View Source

Get the memory/overhead field of the given host.

Link to this function

get_memory_overhead!(xen_session, host_ref)

View Source

Get the memory/overhead field of the given host. (Raise error on XMLRPC failure)

Link to this function

get_metrics(xen_session, host_ref)

View Source

Get the metrics field of the given host.

Link to this function

get_metrics!(xen_session, host_ref)

View Source

Get the metrics field of the given host. (Raise error on XMLRPC failure)

Link to this function

get_multipathing(xen_session, host_ref)

View Source

Get the multipathing field of the given host.

Link to this function

get_multipathing!(xen_session, host_ref)

View Source

Get the multipathing field of the given host. (Raise error on XMLRPC failure)

Link to this function

get_name_description(xen_session, host_ref)

View Source

Get the name/description field of the given host.

Link to this function

get_name_description!(xen_session, host_ref)

View Source

Get the name/description field of the given host. (Raise error on XMLRPC failure)

Link to this function

get_name_label(xen_session, host_ref)

View Source

Get the name/label field of the given host.

Link to this function

get_name_label!(xen_session, host_ref)

View Source

Get the name/label field of the given host. (Raise error on XMLRPC failure)

Link to this function

get_other_config(xen_session, host_ref)

View Source

Get the other_config field of the given host.

Link to this function

get_other_config!(xen_session, host_ref)

View Source

Get the other_config field of the given host. (Raise error on XMLRPC failure)

Link to this function

get_PBDs(xen_session, host_ref)

View Source

Get the PBDs field of the given host.

Link to this function

get_PBDs!(xen_session, host_ref)

View Source

Get the PBDs field of the given host. (Raise error on XMLRPC failure)

Link to this function

get_PCIs(xen_session, host_ref)

View Source

Get the PCIs field of the given host.

Link to this function

get_PCIs!(xen_session, host_ref)

View Source

Get the PCIs field of the given host. (Raise error on XMLRPC failure)

Link to this function

get_PGPUs(xen_session, host_ref)

View Source

Get the PGPUs field of the given host.

Link to this function

get_PGPUs!(xen_session, host_ref)

View Source

Get the PGPUs field of the given host. (Raise error on XMLRPC failure)

Link to this function

get_PIFs(xen_session, host_ref)

View Source

Get the PIFs field of the given host.

Link to this function

get_PIFs!(xen_session, host_ref)

View Source

Get the PIFs field of the given host. (Raise error on XMLRPC failure)

Link to this function

get_PUSBs(xen_session, host_ref)

View Source

Get the PUSBs field of the given host.

Link to this function

get_PUSBs!(xen_session, host_ref)

View Source

Get the PUSBs field of the given host. (Raise error on XMLRPC failure)

Link to this function

get_patches(xen_session, host_ref)

View Source

Get the patches field of the given host.

Link to this function

get_patches!(xen_session, host_ref)

View Source

Get the patches field of the given host. (Raise error on XMLRPC failure)

Link to this function

get_power_on_config(xen_session, host_ref)

View Source

Get the power_on_config field of the given host.

Link to this function

get_power_on_config!(xen_session, host_ref)

View Source

Get the power_on_config field of the given host. (Raise error on XMLRPC failure)

Link to this function

get_power_on_mode(xen_session, host_ref)

View Source

Get the power_on_mode field of the given host.

Link to this function

get_power_on_mode!(xen_session, host_ref)

View Source

Get the power_on_mode field of the given host. (Raise error on XMLRPC failure)

Link to this function

get_record(xen_session, host_ref)

View Source

Get a record containing the current state of the given host.

Link to this function

get_record!(xen_session, host_ref)

View Source

Get a record containing the current state of the given host. (Raise error on XMLRPC failure)

Link to this function

get_resident_VMs(xen_session, host_ref)

View Source

Get the resident_VMs field of the given host.

Link to this function

get_resident_VMs!(xen_session, host_ref)

View Source

Get the resident_VMs field of the given host. (Raise error on XMLRPC failure)

Link to this function

get_sched_policy(xen_session, host_ref)

View Source

Get the sched_policy field of the given host.

Link to this function

get_sched_policy!(xen_session, host_ref)

View Source

Get the sched_policy field of the given host. (Raise error on XMLRPC failure)

Link to this function

get_server_certificate(xen_session, host)

View Source

Get the installed server public TLS certificate.

Link to this function

get_server_certificate!(xen_session, host)

View Source

Get the installed server public TLS certificate. (Raise error on XMLRPC failure)

Link to this function

get_server_localtime(xen_session, host)

View Source

This call queries the host's clock for the current time in the host's local timezone

Link to this function

get_server_localtime!(xen_session, host)

View Source

This call queries the host's clock for the current time in the host's local timezone (Raise error on XMLRPC failure)

Link to this function

get_servertime(xen_session, host)

View Source

This call queries the host's clock for the current time

Link to this function

get_servertime!(xen_session, host)

View Source

This call queries the host's clock for the current time (Raise error on XMLRPC failure)

Link to this function

get_software_version(xen_session, host_ref)

View Source

Get the software_version field of the given host.

Link to this function

get_software_version!(xen_session, host_ref)

View Source

Get the software_version field of the given host. (Raise error on XMLRPC failure)

Link to this function

get_ssl_legacy(xen_session, host_ref)

View Source

Get the ssl_legacy field of the given host.

Link to this function

get_ssl_legacy!(xen_session, host_ref)

View Source

Get the ssl_legacy field of the given host. (Raise error on XMLRPC failure)

Link to this function

get_supported_bootloaders(xen_session, host_ref)

View Source

Get the supported_bootloaders field of the given host.

Link to this function

get_supported_bootloaders!(xen_session, host_ref)

View Source

Get the supported_bootloaders field of the given host. (Raise error on XMLRPC failure)

Link to this function

get_suspend_image_sr(xen_session, host_ref)

View Source

Get the suspend_image_sr field of the given host.

Link to this function

get_suspend_image_sr!(xen_session, host_ref)

View Source

Get the suspend_image_sr field of the given host. (Raise error on XMLRPC failure)

Link to this function

get_system_status_capabilities(xen_session, host)

View Source
Link to this function

get_system_status_capabilities!(xen_session, host)

View Source

(Raise error on XMLRPC failure)

Link to this function

get_tags(xen_session, host_ref)

View Source

Get the tags field of the given host.

Link to this function

get_tags!(xen_session, host_ref)

View Source

Get the tags field of the given host. (Raise error on XMLRPC failure)

Link to this function

get_uefi_certificates(xen_session, host_ref)

View Source

Get the uefi_certificates field of the given host.

Link to this function

get_uefi_certificates!(xen_session, host_ref)

View Source

Get the uefi_certificates field of the given host. (Raise error on XMLRPC failure)

Link to this function

get_uncooperative_resident_VMs(xen_session, host_ref)

View Source

Return a set of VMs which are not co-operating with the host's memory control system

Link to this function

get_uncooperative_resident_VMs!(xen_session, host_ref)

View Source

Return a set of VMs which are not co-operating with the host's memory control system (Raise error on XMLRPC failure)

Link to this function

get_updates(xen_session, host_ref)

View Source

Get the updates field of the given host.

Link to this function

get_updates!(xen_session, host_ref)

View Source

Get the updates field of the given host. (Raise error on XMLRPC failure)

Link to this function

get_updates_requiring_reboot(xen_session, host_ref)

View Source

Get the updates_requiring_reboot field of the given host.

Link to this function

get_updates_requiring_reboot!(xen_session, host_ref)

View Source

Get the updates_requiring_reboot field of the given host. (Raise error on XMLRPC failure)

Link to this function

get_uuid(xen_session, host_ref)

View Source

Get the uuid field of the given host.

Link to this function

get_uuid!(xen_session, host_ref)

View Source

Get the uuid field of the given host. (Raise error on XMLRPC failure)

Link to this function

get_virtual_hardware_platform_versions(xen_session, host_ref)

View Source

Get the virtual_hardware_platform_versions field of the given host.

Link to this function

get_virtual_hardware_platform_versions!(xen_session, host_ref)

View Source

Get the virtual_hardware_platform_versions field of the given host. (Raise error on XMLRPC failure)

Link to this function

get_vms_which_prevent_evacuation(xen_session, host_ref)

View Source

Return a set of VMs which prevent the host being evacuated, with per-VM error codes

Link to this function

get_vms_which_prevent_evacuation!(xen_session, host_ref)

View Source

Return a set of VMs which prevent the host being evacuated, with per-VM error codes (Raise error on XMLRPC failure)

Link to this function

has_extension(xen_session, host, name)

View Source

Return true if the extension is available on the host

Link to this function

has_extension!(xen_session, host, name)

View Source

Return true if the extension is available on the host (Raise error on XMLRPC failure)

Link to this function

license_add(xen_session, host, contents)

View Source

Apply a new license to a host

Link to this function

license_add!(xen_session, host, contents)

View Source

Apply a new license to a host (Raise error on XMLRPC failure)

Link to this function

license_apply(xen_session, host, contents)

View Source

Apply a new license to a host

Link to this function

license_apply!(xen_session, host, contents)

View Source

Apply a new license to a host (Raise error on XMLRPC failure)

Link to this function

license_remove(xen_session, host)

View Source

Remove any license file from the specified host, and switch that host to the unlicensed edition

Link to this function

license_remove!(xen_session, host)

View Source

Remove any license file from the specified host, and switch that host to the unlicensed edition (Raise error on XMLRPC failure)

Link to this function

list_methods(xen_session)

View Source

List all supported methods

Link to this function

list_methods!(xen_session)

View Source

List all supported methods (Raise error on XMLRPC failure)

Link to this function

local_management_reconfigure(xen_session, interface)

View Source

Reconfigure the management network interface. Should only be used if Host.management_reconfigure is impossible because the network configuration is broken.

Link to this function

local_management_reconfigure!(xen_session, interface)

View Source

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)

Link to this function

management_disable(xen_session)

View Source

Disable the management network interface

Link to this function

management_disable!(xen_session)

View Source

Disable the management network interface (Raise error on XMLRPC failure)

Link to this function

management_reconfigure(xen_session, pif)

View Source

Reconfigure the management network interface

Link to this function

management_reconfigure!(xen_session, pif)

View Source

Reconfigure the management network interface (Raise error on XMLRPC failure)

Link to this function

migrate_receive(xen_session, host, network, options)

View Source

Prepare to receive a VM, returning a token which can be passed to VM.migrate.

Link to this function

migrate_receive!(xen_session, host, network, options)

View Source

Prepare to receive a VM, returning a token which can be passed to VM.migrate. (Raise error on XMLRPC failure)

Link to this function

power_on(xen_session, host)

View Source

Attempt to power-on the host (if the capability exists).

Link to this function

power_on!(xen_session, host)

View Source

Attempt to power-on the host (if the capability exists). (Raise error on XMLRPC failure)

Link to this function

query_data_source(xen_session, host, data_source)

View Source

Query the latest value of the specified data source

Link to this function

query_data_source!(xen_session, host, data_source)

View Source

Query the latest value of the specified data source (Raise error on XMLRPC failure)

Link to this function

reboot(xen_session, host)

View Source

Reboot the host. (This function can only be called if there are no currently running VMs on the host and it is disabled.)

Link to this function

reboot!(xen_session, host)

View Source

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)

Link to this function

record_data_source(xen_session, host, data_source)

View Source

Start recording the specified data source

Link to this function

record_data_source!(xen_session, host, data_source)

View Source

Start recording the specified data source (Raise error on XMLRPC failure)

Link to this function

refresh_pack_info(xen_session, host)

View Source

Refresh the list of installed Supplemental Packs.

Link to this function

refresh_pack_info!(xen_session, host)

View Source

Refresh the list of installed Supplemental Packs. (Raise error on XMLRPC failure)

Link to this function

remove_from_guest_VCPUs_params(xen_session, host_ref, key)

View Source

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.

Link to this function

remove_from_guest_VCPUs_params!(xen_session, host_ref, key)

View Source

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)

Link to this function

remove_from_license_server(xen_session, host_ref, key)

View Source

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.

Link to this function

remove_from_license_server!(xen_session, host_ref, key)

View Source

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)

Link to this function

remove_from_logging(xen_session, host_ref, key)

View Source

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.

Link to this function

remove_from_logging!(xen_session, host_ref, key)

View Source

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)

Link to this function

remove_from_other_config(xen_session, host_ref, key)

View Source

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.

Link to this function

remove_from_other_config!(xen_session, host_ref, key)

View Source

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)

Link to this function

remove_tags(xen_session, host_ref, value)

View Source

Remove the given value from the tags field of the given host. If the value is not in that Set, then do nothing.

Link to this function

remove_tags!(xen_session, host_ref, value)

View Source

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)

Link to this function

reset_cpu_features(xen_session, host)

View Source

Remove the feature mask, such that after a reboot all features of the CPU are enabled.

Link to this function

reset_cpu_features!(xen_session, host)

View Source

Remove the feature mask, such that after a reboot all features of the CPU are enabled. (Raise error on XMLRPC failure)

Link to this function

restart_agent(xen_session, host)

View Source

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.

Link to this function

restart_agent!(xen_session, host)

View Source

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)

Link to this function

retrieve_wlb_evacuate_recommendations(xen_session, host_ref)

View Source

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.

Link to this function

retrieve_wlb_evacuate_recommendations!(xen_session, host_ref)

View Source

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)

Link to this function

send_debug_keys(xen_session, host, keys)

View Source

Inject the given string as debugging keys into Xen

Link to this function

send_debug_keys!(xen_session, host, keys)

View Source

Inject the given string as debugging keys into Xen (Raise error on XMLRPC failure)

Link to this function

set_address(xen_session, host_ref, value)

View Source

Set the address field of the given host.

Link to this function

set_address!(xen_session, host_ref, value)

View Source

Set the address field of the given host. (Raise error on XMLRPC failure)

Link to this function

set_cpu_features(xen_session, host, features)

View Source

Set the CPU features to be used after a reboot, if the given features string is valid.

Link to this function

set_cpu_features!(xen_session, host, features)

View Source

Set the CPU features to be used after a reboot, if the given features string is valid. (Raise error on XMLRPC failure)

Link to this function

set_crash_dump_sr(xen_session, host_ref, value)

View Source

Set the crash_dump_sr field of the given host.

Link to this function

set_crash_dump_sr!(xen_session, host_ref, value)

View Source

Set the crash_dump_sr field of the given host. (Raise error on XMLRPC failure)

Link to this function

set_display(xen_session, host_ref, value)

View Source

Set the display field of the given host.

Link to this function

set_display!(xen_session, host_ref, value)

View Source

Set the display field of the given host. (Raise error on XMLRPC failure)

Link to this function

set_guest_VCPUs_params(xen_session, host_ref, value)

View Source

Set the guest_VCPUs_params field of the given host.

Link to this function

set_guest_VCPUs_params!(xen_session, host_ref, value)

View Source

Set the guest_VCPUs_params field of the given host. (Raise error on XMLRPC failure)

Link to this function

set_hostname(xen_session, host_ref, value)

View Source

Set the hostname field of the given host.

Link to this function

set_hostname!(xen_session, host_ref, value)

View Source

Set the hostname field of the given host. (Raise error on XMLRPC failure)

Link to this function

set_hostname_live(xen_session, host, hostname)

View Source

Sets the host name to the specified string. Both the API and lower-level system hostname are changed immediately.

Link to this function

set_hostname_live!(xen_session, host, hostname)

View Source

Sets the host name to the specified string. Both the API and lower-level system hostname are changed immediately. (Raise error on XMLRPC failure)

Link to this function

set_iscsi_iqn(xen_session, host, value)

View Source

Sets the initiator IQN for the host

Link to this function

set_iscsi_iqn!(xen_session, host, value)

View Source

Sets the initiator IQN for the host (Raise error on XMLRPC failure)

Link to this function

set_license_server(xen_session, host_ref, value)

View Source

Set the license_server field of the given host.

Link to this function

set_license_server!(xen_session, host_ref, value)

View Source

Set the license_server field of the given host. (Raise error on XMLRPC failure)

Link to this function

set_logging(xen_session, host_ref, value)

View Source

Set the logging field of the given host.

Link to this function

set_logging!(xen_session, host_ref, value)

View Source

Set the logging field of the given host. (Raise error on XMLRPC failure)

Link to this function

set_multipathing(xen_session, host, value)

View Source

Specifies whether multipathing is enabled

Link to this function

set_multipathing!(xen_session, host, value)

View Source

Specifies whether multipathing is enabled (Raise error on XMLRPC failure)

Link to this function

set_name_description(xen_session, host_ref, value)

View Source

Set the name/description field of the given host.

Link to this function

set_name_description!(xen_session, host_ref, value)

View Source

Set the name/description field of the given host. (Raise error on XMLRPC failure)

Link to this function

set_name_label(xen_session, host_ref, value)

View Source

Set the name/label field of the given host.

Link to this function

set_name_label!(xen_session, host_ref, value)

View Source

Set the name/label field of the given host. (Raise error on XMLRPC failure)

Link to this function

set_other_config(xen_session, host_ref, value)

View Source

Set the other_config field of the given host.

Link to this function

set_other_config!(xen_session, host_ref, value)

View Source

Set the other_config field of the given host. (Raise error on XMLRPC failure)

Link to this function

set_power_on_mode(xen_session, host_ref, power_on_mode, power_on_config)

View Source

Set the power-on-mode, host, user and password

Link to this function

set_power_on_mode!(xen_session, host_ref, power_on_mode, power_on_config)

View Source

Set the power-on-mode, host, user and password (Raise error on XMLRPC failure)

Link to this function

set_ssl_legacy(xen_session, host_ref, value)

View Source

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.

Link to this function

set_ssl_legacy!(xen_session, host_ref, value)

View Source

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)

Link to this function

set_suspend_image_sr(xen_session, host_ref, value)

View Source

Set the suspend_image_sr field of the given host.

Link to this function

set_suspend_image_sr!(xen_session, host_ref, value)

View Source

Set the suspend_image_sr field of the given host. (Raise error on XMLRPC failure)

Link to this function

set_tags(xen_session, host_ref, value)

View Source

Set the tags field of the given host.

Link to this function

set_tags!(xen_session, host_ref, value)

View Source

Set the tags field of the given host. (Raise error on XMLRPC failure)

Link to this function

set_uefi_certificates(xen_session, host, value)

View Source

Sets the UEFI certificates on a host

Link to this function

set_uefi_certificates!(xen_session, host, value)

View Source

Sets the UEFI certificates on a host (Raise error on XMLRPC failure)

Link to this function

shutdown(xen_session, host)

View Source

Shutdown the host. (This function can only be called if there are no currently running VMs on the host and it is disabled.)

Link to this function

shutdown!(xen_session, host)

View Source

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)

Link to this function

shutdown_agent(xen_session)

View Source

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.

Link to this function

shutdown_agent!(xen_session)

View Source

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)

Link to this function

sync_data(xen_session, host)

View Source

This causes the synchronisation of the non-database data (messages, RRDs and so on) stored on the master to be synchronised with the host

Link to this function

sync_data!(xen_session, host)

View Source

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)

Link to this function

syslog_reconfigure(xen_session, host)

View Source

Re-configure syslog logging

Link to this function

syslog_reconfigure!(xen_session, host)

View Source

Re-configure syslog logging (Raise error on XMLRPC failure)