XenServer 4.0

Code name: "rio".

Changes

Change	Element	Description
Published class	PBD	The physical block devices through which hosts access SRs
Published class	PIF	A physical network interface (note separate VLANs are represented as several PIFs)
Published class	PIF_metrics	The metrics associated with a physical network interface
Published class	SM	A storage manager plugin
Published class	SR	A storage repository
Published class	VBD	A virtual block device
Published class	VBD_metrics	The metrics associated with a virtual block device
Published class	VDI	A virtual disk image
Published class	VIF	A virtual network interface
Published class	VIF_metrics	The metrics associated with a virtual network device
Published class	VM	A virtual machine (or 'guest').
Published class	VM_guest_metrics	The metrics reported by the guest (as opposed to inferred from outside)
Published class	VM_metrics	The metrics associated with a VM
Published class	console	A console
Published class	crashdump	A VM crashdump
Published class	event	Asynchronous event registration and handling
Published class	host	A physical host
Published class	host_cpu	A physical CPU
Published class	host_crashdump	Represents a host crash dump
Published class	host_metrics	The metrics associated with a host
Published class	host_patch	Represents a patch stored on a server
Published class	network	A virtual network
Published class	pool	Pool-wide information
Published class	session	A session
Published class	task	A long-running asynchronous task
Published class	user	A user of the system
Published field	Bond.uuid	Unique identifier/object reference
Published field	Cluster.allowed_operations	list of the operations allowed in this state. This list is advisory only and the server state may have changed by the time this field is read by a client.
Published field	Cluster.current_operations	links each of the running tasks using this object (by reference) to a current_operation enum which describes the nature of the task.
Published field	Cluster_host.allowed_operations	list of the operations allowed in this state. This list is advisory only and the server state may have changed by the time this field is read by a client.
Published field	Cluster_host.current_operations	links each of the running tasks using this object (by reference) to a current_operation enum which describes the nature of the task.
Published field	DR_task.introduced_SRs	All SRs introduced by this appliance
Published field	DR_task.uuid	Unique identifier/object reference
Published field	Feature.name_description	a notes field containing human-readable description
Published field	Feature.name_label	a human-readable name
Published field	LVHD.uuid	Unique identifier/object reference
Published field	Observer.name_description	a notes field containing human-readable description
Published field	Observer.name_label	a human-readable name
Published field	PBD.SR	the storage repository that the pbd realises
Published field	PBD.currently_attached	is the SR currently attached on this host?
Published field	PBD.device_config	a config string to string map that is provided to the host's SR-backend-driver
Published field	PBD.host	physical machine on which the pbd is available
Published field	PBD.uuid	Unique identifier/object reference
Published field	PIF.MAC	ethernet MAC address of physical interface
Published field	PIF.MTU	MTU in octets
Published field	PIF.VLAN	VLAN tag for all traffic passing through this interface
Published field	PIF.device	machine-readable name of the interface (e.g. eth0)
Published field	PIF.host	physical machine to which this pif is connected
Published field	PIF.metrics	metrics associated with this PIF
Published field	PIF.network	virtual network to which this pif is connected
Published field	PIF.uuid	Unique identifier/object reference
Published field	PIF_metrics.carrier	Report if the PIF got a carrier or not
Published field	PIF_metrics.device_id	Report device ID
Published field	PIF_metrics.device_name	Report device name
Published field	PIF_metrics.duplex	Full duplex capability of the link (if available)
Published field	PIF_metrics.io_read_kbs	Read bandwidth (KiB/s)
Published field	PIF_metrics.io_write_kbs	Write bandwidth (KiB/s)
Published field	PIF_metrics.last_updated	Time at which this information was last updated
Published field	PIF_metrics.pci_bus_path	PCI bus path of the pif (if available)
Published field	PIF_metrics.speed	Speed of the link in Mbit/s (if available)
Published field	PIF_metrics.uuid	Unique identifier/object reference
Published field	PIF_metrics.vendor_id	Report vendor ID
Published field	PIF_metrics.vendor_name	Report vendor name
Published field	Repository.name_description	a notes field containing human-readable description
Published field	Repository.name_label	a human-readable name
Published field	SM.configuration	names and descriptions of device config keys
Published field	SM.copyright	Entity which owns the copyright of this plugin
Published field	SM.name_description	a notes field containing human-readable description
Published field	SM.name_label	a human-readable name
Published field	SM.required_api_version	Minimum SM API version required on the server
Published field	SM.type	SR.type
Published field	SM.uuid	Unique identifier/object reference
Published field	SM.vendor	Vendor who created this plugin
Published field	SM.version	Version of the plugin
Published field	SR.PBDs	describes how particular hosts can see this storage repository
Published field	SR.VDIs	all virtual disks known to this storage repository
Published field	SR.allowed_operations	list of the operations allowed in this state. This list is advisory only and the server state may have changed by the time this field is read by a client.
Published field	SR.content_type	the type of the SR's content, if required (e.g. ISOs)
Published field	SR.current_operations	links each of the running tasks using this object (by reference) to a current_operation enum which describes the nature of the task.
Published field	SR.name_description	a notes field containing human-readable description
Published field	SR.name_label	a human-readable name
Published field	SR.other_config	additional configuration
Published field	SR.physical_size	total physical size of the repository (in bytes)
Published field	SR.physical_utilisation	physical space currently utilised on this storage repository (in bytes). Note that for sparse disk formats, physical_utilisation may be less than virtual_allocation
Published field	SR.shared	true if this SR is (capable of being) shared between multiple hosts
Published field	SR.type	type of the storage repository
Published field	SR.uuid	Unique identifier/object reference
Published field	SR.virtual_allocation	sum of virtual_sizes of all VDIs in this storage repository (in bytes)
Published field	VBD.VDI	the virtual disk
Published field	VBD.VM	the virtual machine
Published field	VBD.allowed_operations	list of the operations allowed in this state. This list is advisory only and the server state may have changed by the time this field is read by a client.
Published field	VBD.bootable	true if this VBD is bootable
Published field	VBD.current_operations	links each of the running tasks using this object (by reference) to a current_operation enum which describes the nature of the task.
Published field	VBD.currently_attached	is the device currently attached (erased on reboot)
Published field	VBD.device	device seen by the guest e.g. hda1
Published field	VBD.empty	if true this represents an empty drive
Published field	VBD.metrics	metrics associated with this VBD
Published field	VBD.mode	the mode the VBD should be mounted with
Published field	VBD.other_config	additional configuration
Published field	VBD.qos_algorithm_params	parameters for chosen QoS algorithm
Published field	VBD.qos_algorithm_type	QoS algorithm to use
Published field	VBD.qos_supported_algorithms	supported QoS algorithms for this VBD
Published field	VBD.runtime_properties	Device runtime properties
Published field	VBD.status_code	error/success code associated with last attach-operation (erased on reboot)
Published field	VBD.status_detail	error/success information associated with last attach-operation status (erased on reboot)
Published field	VBD.storage_lock	true if a storage level lock was acquired
Published field	VBD.type	how the VBD will appear to the guest (e.g. disk or CD)
Published field	VBD.userdevice	user-friendly device name e.g. 0,1,2,etc.
Published field	VBD.uuid	Unique identifier/object reference
Published field	VBD_metrics.io_read_kbs	Read bandwidth (KiB/s)
Published field	VBD_metrics.io_write_kbs	Write bandwidth (KiB/s)
Published field	VBD_metrics.last_updated	Time at which this information was last updated
Published field	VBD_metrics.uuid	Unique identifier/object reference
Published field	VDI.SR	storage repository in which the VDI resides
Published field	VDI.VBDs	list of vbds that refer to this disk
Published field	VDI.allowed_operations	list of the operations allowed in this state. This list is advisory only and the server state may have changed by the time this field is read by a client.
Published field	VDI.crash_dumps	list of crash dumps that refer to this disk
Published field	VDI.current_operations	links each of the running tasks using this object (by reference) to a current_operation enum which describes the nature of the task.
Published field	VDI.managed
Published field	VDI.missing	true if SR scan operation reported this VDI as not present on disk
Published field	VDI.name_description	a notes field containing human-readable description
Published field	VDI.name_label	a human-readable name
Published field	VDI.other_config	additional configuration
Published field	VDI.parent	This field is always null. Deprecated
Published field	VDI.physical_utilisation	amount of physical space that the disk image is currently taking up on the storage repository (in bytes)
Published field	VDI.read_only	true if this disk may ONLY be mounted read-only
Published field	VDI.sharable	true if this disk may be shared
Published field	VDI.storage_lock	true if this disk is locked at the storage level
Published field	VDI.type	type of the VDI
Published field	VDI.uuid	Unique identifier/object reference
Published field	VDI.virtual_size	size of disk as presented to the guest (in bytes). Note that, depending on storage backend type, requested size may not be respected exactly
Published field	VIF.MAC	ethernet MAC address of virtual interface, as exposed to guest
Published field	VIF.MTU	MTU in octets
Published field	VIF.VM	virtual machine to which this vif is connected
Published field	VIF.allowed_operations	list of the operations allowed in this state. This list is advisory only and the server state may have changed by the time this field is read by a client.
Published field	VIF.current_operations	links each of the running tasks using this object (by reference) to a current_operation enum which describes the nature of the task.
Published field	VIF.currently_attached	is the device currently attached (erased on reboot)
Published field	VIF.device	order in which VIF backends are created by xapi
Published field	VIF.metrics	metrics associated with this VIF
Published field	VIF.network	virtual network to which this vif is connected
Published field	VIF.other_config	additional configuration
Published field	VIF.qos_algorithm_params	parameters for chosen QoS algorithm
Published field	VIF.qos_algorithm_type	QoS algorithm to use
Published field	VIF.qos_supported_algorithms	supported QoS algorithms for this VIF
Published field	VIF.runtime_properties	Device runtime properties
Published field	VIF.status_code	error/success code associated with last attach-operation (erased on reboot)
Published field	VIF.status_detail	error/success information associated with last attach-operation status (erased on reboot)
Published field	VIF.uuid	Unique identifier/object reference
Published field	VIF_metrics.io_read_kbs	Read bandwidth (KiB/s)
Published field	VIF_metrics.io_write_kbs	Write bandwidth (KiB/s)
Published field	VIF_metrics.last_updated	Time at which this information was last updated
Published field	VIF_metrics.uuid	Unique identifier/object reference
Published field	VLAN.uuid	Unique identifier/object reference
Published field	VM.HVM_boot_params	HVM boot params
Published field	VM.HVM_boot_policy	HVM boot policy
Published field	VM.PCI_bus	PCI bus path for pass-through devices
Published field	VM.PV_args	kernel command-line arguments
Published field	VM.PV_bootloader	name of or path to bootloader
Published field	VM.PV_bootloader_args	miscellaneous arguments for the bootloader
Published field	VM.PV_kernel	path to the kernel
Published field	VM.PV_legacy_args	to make Zurich guests boot
Published field	VM.PV_ramdisk	path to the initrd
Published field	VM.VBDs	virtual block devices
Published field	VM.VCPUs_at_startup	Boot number of VCPUs
Published field	VM.VCPUs_max	Max number of VCPUs
Published field	VM.VCPUs_params	configuration parameters for the selected VCPU policy
Published field	VM.VIFs	virtual network interfaces
Published field	VM.VTPMs	virtual TPMs
Published field	VM.VUSBs	virtual usb devices
Published field	VM.actions_after_crash	action to take if the guest crashes
Published field	VM.actions_after_reboot	action to take after the guest has rebooted itself
Published field	VM.actions_after_shutdown	action to take after the guest has shutdown itself
Published field	VM.affinity	A host which the VM has some affinity for (or NULL). This is used as a hint to the start call when it decides where to run the VM. Resource constraints may cause the VM to be started elsewhere.
Published field	VM.allowed_operations	list of the operations allowed in this state. This list is advisory only and the server state may have changed by the time this field is read by a client.
Published field	VM.appliance	the appliance to which this VM belongs
Published field	VM.consoles	virtual console devices
Published field	VM.crash_dumps	crash dumps associated with this VM
Published field	VM.current_operations	links each of the running tasks using this object (by reference) to a current_operation enum which describes the nature of the task.
Published field	VM.domarch	Domain architecture (if available, null string otherwise)
Published field	VM.domid	domain ID (if available, -1 otherwise)
Published field	VM.guest_metrics	metrics associated with the running guest
Published field	VM.is_a_template	true if this is a template. Template VMs can never be started, they are used only for cloning other VMs
Published field	VM.is_control_domain	true if this is a control domain (domain 0 or a driver domain)
Published field	VM.last_boot_CPU_flags	describes the CPU flags on which the VM was last booted
Published field	VM.memory_dynamic_max	Dynamic maximum (bytes)
Published field	VM.memory_dynamic_min	Dynamic minimum (bytes)
Published field	VM.memory_overhead	Virtualization memory overhead (bytes).
Published field	VM.memory_static_max	Statically-set (i.e. absolute) maximum (bytes). The value of this field at VM start time acts as a hard limit of the amount of memory a guest can use. New values only take effect on reboot.
Published field	VM.memory_static_min	Statically-set (i.e. absolute) mininum (bytes). The value of this field indicates the least amount of memory this VM can boot with without crashing.
Published field	VM.memory_target	Dynamically-set memory target (bytes). The value of this field indicates the current target for memory available to this VM.
Published field	VM.metrics	metrics associated with this VM
Published field	VM.name_description	a notes field containing human-readable description
Published field	VM.name_label	a human-readable name
Published field	VM.other_config	additional configuration
Published field	VM.platform	platform-specific configuration
Published field	VM.power_state	Current power state of the machine
Published field	VM.recommendations	An XML specification of recommended values and ranges for properties of this VM
Published field	VM.resident_on	the host the VM is currently resident on
Published field	VM.scheduled_to_be_resident_on	the host on which the VM is due to be started/resumed/migrated. This acts as a memory reservation indicator
Published field	VM.suspend_VDI	The VDI that a suspend image is stored on. (Only has meaning if VM is currently suspended)
Published field	VM.user_version	Creators of VMs and templates may store version information here.
Published field	VM.uuid	Unique identifier/object reference
Published field	VMPP.name_description	a notes field containing human-readable description
Published field	VMPP.name_label	a human-readable name
Published field	VMSS.VMs	all VMs attached to this snapshot schedule
Published field	VMSS.enabled	enable or disable this snapshot schedule
Published field	VMSS.frequency	frequency of taking snapshot from snapshot schedule
Published field	VMSS.last_run_time	time of the last snapshot
Published field	VMSS.name_description	a notes field containing human-readable description
Published field	VMSS.name_label	a human-readable name
Published field	VMSS.retained_snapshots	maximum number of snapshots that should be stored at any time
Published field	VMSS.schedule	schedule of the snapshot containing 'hour', 'min', 'days'. Date/time-related information is in Local Timezone
Published field	VMSS.type	type of the snapshot schedule
Published field	VMSS.uuid	Unique identifier/object reference
Published field	VM_appliance.VMs	all VMs in this appliance
Published field	VM_appliance.allowed_operations	list of the operations allowed in this state. This list is advisory only and the server state may have changed by the time this field is read by a client.
Published field	VM_appliance.current_operations	links each of the running tasks using this object (by reference) to a current_operation enum which describes the nature of the task.
Published field	VM_appliance.name_description	a notes field containing human-readable description
Published field	VM_appliance.name_label	a human-readable name
Published field	VM_appliance.uuid	Unique identifier/object reference
Published field	VM_guest_metrics.PV_drivers_up_to_date	true if the PV drivers appear to be up to date
Published field	VM_guest_metrics.PV_drivers_version	version of the PV drivers
Published field	VM_guest_metrics.disks	Disk configuration/free space
Published field	VM_guest_metrics.last_updated	Time at which this information was last updated
Published field	VM_guest_metrics.memory	free/used/total
Published field	VM_guest_metrics.networks	network configuration
Published field	VM_guest_metrics.os_version	version of the OS
Published field	VM_guest_metrics.other	anything else
Published field	VM_guest_metrics.uuid	Unique identifier/object reference
Published field	VM_metrics.VCPUs_CPU	VCPU to PCPU map
Published field	VM_metrics.VCPUs_flags	CPU flags (blocked,online,running)
Published field	VM_metrics.VCPUs_number	Current number of VCPUs
Published field	VM_metrics.VCPUs_params	The live equivalent to VM.VCPUs_params
Published field	VM_metrics.VCPUs_utilisation	Utilisation for all of guest's current VCPUs
Published field	VM_metrics.install_time	Time at which the VM was installed
Published field	VM_metrics.last_updated	Time at which this information was last updated
Published field	VM_metrics.memory_actual	Guest's actual memory (bytes)
Published field	VM_metrics.start_time	Time at which this VM was last booted
Published field	VM_metrics.state	The state of the guest, eg blocked, dying etc
Published field	VM_metrics.uuid	Unique identifier/object reference
Published field	VTPM.VM	The virtual machine the TPM is attached to
Published field	VTPM.allowed_operations	list of the operations allowed in this state. This list is advisory only and the server state may have changed by the time this field is read by a client.
Published field	VTPM.backend	The domain where the backend is located (unused)
Published field	VTPM.current_operations	links each of the running tasks using this object (by reference) to a current_operation enum which describes the nature of the task.
Published field	VTPM.uuid	Unique identifier/object reference
Published field	VUSB.allowed_operations	list of the operations allowed in this state. This list is advisory only and the server state may have changed by the time this field is read by a client.
Published field	VUSB.current_operations	links each of the running tasks using this object (by reference) to a current_operation enum which describes the nature of the task.
Published field	VUSB.currently_attached	is the device currently attached
Published field	blob.last_updated	Time at which the data in the blob was last updated
Published field	blob.mime_type	The mime type associated with this object. Defaults to 'application/octet-stream' if the empty string is supplied
Published field	blob.name_description	a notes field containing human-readable description
Published field	blob.name_label	a human-readable name
Published field	blob.size	Size of the binary data, in bytes
Published field	blob.uuid	Unique identifier/object reference
Published field	console.VM	VM to which this console is attached
Published field	console.location	URI for the console service
Published field	console.other_config	additional configuration
Published field	console.protocol	the protocol used by this console
Published field	console.uuid	Unique identifier/object reference
Published field	crashdump.VDI	the virtual disk
Published field	crashdump.VM	the virtual machine
Published field	crashdump.uuid	Unique identifier/object reference
Published field	data_source.enabled	true if the data source is being logged
Published field	data_source.max	the maximum value of the data source
Published field	data_source.min	the minimum value of the data source
Published field	data_source.name_description	a notes field containing human-readable description
Published field	data_source.name_label	a human-readable name
Published field	data_source.standard	true if the data source is enabled by default. Non-default data sources cannot be disabled
Published field	data_source.units	the units of the value
Published field	data_source.value	current value of the data source
Published field	event.class	The name of the class of the object that changed
Published field	event.id	An ID, monotonically increasing, and local to the current session
Published field	event.obj_uuid	The uuid of the object that changed
Published field	event.operation	The operation that was performed
Published field	event.ref	A reference to the object that changed
Published field	event.timestamp	The time at which the event occurred
Published field	host.API_version_major	major version number
Published field	host.API_version_minor	minor version number
Published field	host.API_version_vendor	identification of vendor
Published field	host.API_version_vendor_implementation	details of vendor implementation
Published field	host.PBDs	physical blockdevices
Published field	host.PIFs	physical network interfaces
Published field	host.address	The address by which this host can be contacted from any other host in the pool
Published field	host.allowed_operations	list of the operations allowed in this state. This list is advisory only and the server state may have changed by the time this field is read by a client.
Published field	host.capabilities	Xen capabilities
Published field	host.cpu_configuration	The CPU configuration on this host. May contain keys such as "nr_nodes", "sockets_per_node", "cores_per_socket", or "threads_per_core"
Published field	host.crash_dump_sr	The SR in which VDIs for crash dumps are created
Published field	host.crashdumps	Set of host crash dumps
Published field	host.current_operations	links each of the running tasks using this object (by reference) to a current_operation enum which describes the nature of the task.
Published field	host.enabled	True if the host is currently enabled
Published field	host.host_CPUs	The physical CPUs on this host
Published field	host.hostname	The hostname of this host
Published field	host.license_params	State of the current license
Published field	host.logging	logging configuration
Published field	host.memory_overhead	Virtualization memory overhead (bytes).
Published field	host.metrics	metrics associated with this host
Published field	host.name_description	a notes field containing human-readable description
Published field	host.name_label	a human-readable name
Published field	host.other_config	additional configuration
Published field	host.patches	Set of host patches
Published field	host.resident_VMs	list of VMs currently resident on host
Published field	host.sched_policy	Scheduler policy currently in force on this host
Published field	host.software_version	version strings
Published field	host.supported_bootloaders	a list of the bootloaders installed on the machine
Published field	host.suspend_image_sr	The SR in which VDIs for suspend images are created
Published field	host.uuid	Unique identifier/object reference
Published field	host_cpu.family	the family (number) of the physical CPU
Published field	host_cpu.features	the physical CPU feature bitmap
Published field	host_cpu.flags	the flags of the physical CPU (a decoded version of the features field)
Published field	host_cpu.host	the host the CPU is in
Published field	host_cpu.model	the model number of the physical CPU
Published field	host_cpu.modelname	the model name of the physical CPU
Published field	host_cpu.number	the number of the physical CPU within the host
Published field	host_cpu.speed	the speed of the physical CPU
Published field	host_cpu.stepping	the stepping of the physical CPU
Published field	host_cpu.utilisation	the current CPU utilisation
Published field	host_cpu.uuid	Unique identifier/object reference
Published field	host_cpu.vendor	the vendor of the physical CPU
Published field	host_crashdump.host	Host the crashdump relates to
Published field	host_crashdump.size	Size of the crashdump
Published field	host_crashdump.timestamp	Time the crash happened
Published field	host_crashdump.uuid	Unique identifier/object reference
Published field	host_metrics.last_updated	Time at which this information was last updated
Published field	host_metrics.live	Pool master thinks this host is live
Published field	host_metrics.memory_free	Free host memory (bytes)
Published field	host_metrics.memory_total	Total host memory (bytes)
Published field	host_metrics.uuid	Unique identifier/object reference
Published field	host_patch.applied	True if the patch has been applied
Published field	host_patch.host	Host the patch relates to
Published field	host_patch.name_description	a notes field containing human-readable description
Published field	host_patch.name_label	a human-readable name
Published field	host_patch.size	Size of the patch
Published field	host_patch.timestamp_applied	Time the patch was applied
Published field	host_patch.uuid	Unique identifier/object reference
Published field	host_patch.version	Patch version number
Published field	message.body	The body of the message
Published field	message.name	The name of the message
Published field	message.obj_uuid	The uuid of the object this message is associated with
Published field	message.priority	The message priority, 0 being low priority
Published field	message.timestamp	The time at which the message was created
Published field	message.uuid	Unique identifier/object reference
Published field	network.PIFs	list of connected pifs
Published field	network.VIFs	list of connected vifs
Published field	network.allowed_operations	list of the operations allowed in this state. This list is advisory only and the server state may have changed by the time this field is read by a client.
Published field	network.bridge	name of the bridge corresponding to this network on the local host
Published field	network.current_operations	links each of the running tasks using this object (by reference) to a current_operation enum which describes the nature of the task.
Published field	network.name_description	a notes field containing human-readable description
Published field	network.name_label	a human-readable name
Published field	network.other_config	additional configuration
Published field	network.uuid	Unique identifier/object reference
Published field	network_sriov.uuid	Unique identifier/object reference
Published field	pool.allowed_operations	list of the operations allowed in this state. This list is advisory only and the server state may have changed by the time this field is read by a client.
Published field	pool.coordinator_bias	true if bias against pool master when scheduling vms is enabled, false otherwise
Published field	pool.crash_dump_SR	The SR in which VDIs for crash dumps are created
Published field	pool.current_operations	links each of the running tasks using this object (by reference) to a current_operation enum which describes the nature of the task.
Published field	pool.default_SR	Default SR for VDIs
Published field	pool.master	The host that is pool master
Published field	pool.name_description	Description
Published field	pool.name_label	Short name
Published field	pool.other_config	additional configuration
Published field	pool.suspend_image_SR	The SR in which VDIs for suspend images are created
Published field	pool.uuid	Unique identifier/object reference
Published field	pool_patch.name_description	a notes field containing human-readable description
Published field	pool_patch.name_label	a human-readable name
Published field	pool_patch.uuid	Unique identifier/object reference
Published field	pool_update.name_description	a notes field containing human-readable description
Published field	pool_update.name_label	a human-readable name
Published field	pool_update.uuid	Unique identifier/object reference
Published field	pool_update.vdi	VDI the update was uploaded to
Published field	role.uuid	Unique identifier/object reference
Published field	secret.other_config	other_config
Published field	secret.uuid	Unique identifier/object reference
Published field	secret.value	the secret
Published field	session.last_active	Timestamp for last time session was active
Published field	session.pool	True if this session relates to a intra-pool login, false otherwise
Published field	session.this_host	Currently connected host
Published field	session.this_user	Currently connected user
Published field	session.uuid	Unique identifier/object reference
Published field	subject.uuid	Unique identifier/object reference
Published field	task.allowed_operations	list of the operations allowed in this state. This list is advisory only and the server state may have changed by the time this field is read by a client.
Published field	task.created	Time task was created
Published field	task.current_operations	links each of the running tasks using this object (by reference) to a current_operation enum which describes the nature of the task.
Published field	task.error_info	if the task has failed, this field contains the set of associated error strings. Undefined otherwise.
Published field	task.finished	Time task finished (i.e. succeeded or failed). If task-status is pending, then the value of this field has no meaning
Published field	task.name_description	a notes field containing human-readable description
Published field	task.name_label	a human-readable name
Published field	task.progress	This field contains the estimated fraction of the task which is complete. This field should not be used to determine whether the task is complete - for this the status field of the task should be used.
Published field	task.resident_on	the host on which the task is running
Published field	task.result	if the task has completed successfully, this field contains the result value (either Void or an object reference). Undefined otherwise.
Published field	task.status	current status of the task
Published field	task.type	if the task has completed successfully, this field contains the type of the encoded result (i.e. name of the class whose reference is in the result field). Undefined otherwise.
Published field	task.uuid	Unique identifier/object reference
Published field	user.fullname	full name
Published field	user.short_name	short name (e.g. userid)
Published field	user.uuid	Unique identifier/object reference
Published message	PBD.plug	Activate the specified PBD, causing the referenced SR to be attached and scanned
Published message	PBD.unplug	Deactivate the specified PBD, causing the referenced SR to be detached and nolonger scanned
Published message	PIF.create_VLAN	Create a VLAN interface from an existing physical interface
Published message	PIF.destroy	Destroy the PIF object (provided it is a VLAN interface)
Published message	SR.create	Create a new Storage Repository and introduce it into the managed system, creating both SR record and PBD record to attach it to current host (with specified device_config parameters)
Published message	SR.destroy	Destroy specified SR, removing SR-record from database and remove SR from disk. (In order to affect this operation the appropriate device_config is read from the specified SR's PBD on current host)
Published message	SR.forget	Removing specified SR-record from database, without attempting to remove SR from disk
Published message	SR.get_supported_types	Return a set of all the SR types supported by the system
Published message	SR.introduce	Introduce a new Storage Repository into the managed system
Published message	SR.make	Create a new Storage Repository on disk
Published message	SR.scan	Refreshes the list of VDIs associated with an SR
Published message	SR.set_name_description	Set the name description of the SR
Published message	SR.set_name_label	Set the name label of the SR
Published message	SR.set_shared	Sets the shared flag on the SR
Published message	VBD.assert_attachable	Throws an error if this VBD could not be attached to this VM if the VM were running. Intended for debugging.
Published message	VBD.eject	Remove the media from the device and leave it empty
Published message	VBD.insert	Insert new media into the device
Published message	VBD.plug	Hotplug the specified VBD, dynamically attaching it to the running VM
Published message	VBD.set_mode	Sets the mode of the VBD. The power_state of the VM must be halted.
Published message	VBD.unplug	Hot-unplug the specified VBD, dynamically unattaching it from the running VM
Published message	VBD.unplug_force	Forcibly unplug the specified VBD
Published message	VDI.clone	Take an exact copy of the VDI and return a reference to the new disk. If any driver_params are specified then these are passed through to the storage-specific substrate driver that implements the clone operation. NB the clone lives in the same Storage Repository as its parent.
Published message	VDI.copy	Copies a VDI to an SR. There must be a host that can see both the source and destination SRs simultaneously
Published message	VDI.forget	Removes a VDI record from the database
Published message	VDI.resize	Resize the VDI.
Published message	VDI.resize_online	Resize the VDI which may or may not be attached to running guests.
Published message	VDI.set_name_description	Set the name description of the VDI. This can only happen when its SR is currently attached.
Published message	VDI.set_name_label	Set the name label of the VDI. This can only happen when then its SR is currently attached.
Published message	VDI.set_read_only	Sets the VDI's read_only field
Published message	VDI.snapshot	Take a read-only snapshot of the VDI, returning a reference to the snapshot. If any driver_params are specified then these are passed through to the storage-specific substrate driver that takes the snapshot. NB the snapshot lives in the same Storage Repository as its parent.
Published message	VIF.plug	Hotplug the specified VIF, dynamically attaching it to the running VM
Published message	VIF.unplug	Hot-unplug the specified VIF, dynamically unattaching it from the running VM
Published message	VM.add_to_VCPUs_params_live	Add the given key-value pair to VM.VCPUs_params, and apply that value on the running VM
Published message	VM.assert_can_boot_here	Returns an error if the VM could not boot on this host for some reason
Published message	VM.assert_operation_valid	Check to see whether this operation is acceptable in the current state of the system, raising an error if the operation is invalid for some reason
Published message	VM.clean_reboot	Attempt to cleanly shutdown the specified VM (Note: this may not be supported---e.g. if a guest agent is not installed). This can only be called when the specified VM is in the Running state.
Published message	VM.clean_shutdown	Attempt to cleanly shutdown the specified VM. (Note: this may not be supported---e.g. if a guest agent is not installed). This can only be called when the specified VM is in the Running state.
Published message	VM.clone	Clones the specified VM, making a new VM. Clone automatically exploits the capabilities of the underlying storage repository in which the VM's disk images are stored (e.g. Copy on Write). This function can only be called when the VM is in the Halted State.
Published message	VM.copy	Copies a VM to an SR. There must be a host that can see both the source and destination SRs simultaneously
Published message	VM.get_allowed_VBD_devices	Returns a list of the allowed values that a VBD device field can take
Published message	VM.get_allowed_VIF_devices	Returns a list of the allowed values that a VIF device field can take
Published message	VM.get_boot_record	Returns a record describing the VM's dynamic state, initialised when the VM boots and updated to reflect runtime configuration changes e.g. CPU hotplug
Published message	VM.get_possible_hosts	Return the list of hosts on which this VM may run.
Published message	VM.hard_reboot	Stop executing the specified VM without attempting a clean shutdown and immediately restart the VM.
Published message	VM.hard_shutdown	Stop executing the specified VM without attempting a clean shutdown.
Published message	VM.pause	Pause the specified VM. This can only be called when the specified VM is in the Running state.
Published message	VM.pool_migrate	Migrate a VM to another Host.
Published message	VM.power_state_reset	Reset the power-state of the VM to halted in the database only. (Used to recover from slave failures in pooling scenarios by resetting the power-states of VMs running on dead slaves to halted.) This is a potentially dangerous operation; use with care.
Published message	VM.provision	Inspects the disk configuration contained within the VM's other_config, creates VDIs and VBDs and then executes any applicable post-install script.
Published message	VM.resume	Awaken the specified VM and resume it. This can only be called when the specified VM is in the Suspended state.
Published message	VM.resume_on	Awaken the specified VM and resume it on a particular Host. This can only be called when the specified VM is in the Suspended state.
Published message	VM.send_sysrq	Send the given key as a sysrq to this VM. The key is specified as a single character (a String of length 1). This can only be called when the specified VM is in the Running state.
Published message	VM.send_trigger	Send the named trigger to this VM. This can only be called when the specified VM is in the Running state.
Published message	VM.set_HVM_boot_policy	Set the VM.HVM_boot_policy field of the given VM, which will take effect when it is next started
Published message	VM.set_VCPUs_number_live	Set the number of VCPUs for a running VM
Published message	VM.set_actions_after_crash	Sets the actions_after_crash parameter
Published message	VM.set_memory_target_live	Set the memory target for a running VM
Published message	VM.set_shadow_multiplier_live	Set the shadow memory multiplier on a running VM
Published message	VM.start	Start the specified VM. This function can only be called with the VM is in the Halted State.
Published message	VM.start_on	Start the specified VM on a particular host. This function can only be called with the VM is in the Halted State.
Published message	VM.suspend	Suspend the specified VM to disk. This can only be called when the specified VM is in the Running state.
Published message	VM.unpause	Resume the specified VM. This can only be called when the specified VM is in the Paused state.
Published message	VM.update_allowed_operations	Recomputes the list of acceptable operations
Published message	crashdump.destroy	Destroy the specified crashdump
Published message	event.get_current_id	Return the ID of the next event to be generated by the system
Published message	event.next	Blocking call which returns a (possibly empty) batch of events. This method is only recommended for legacy use. New development should use event.from which supersedes this method.
Published message	event.register	Registers this session with the event system for a set of given classes. This method is only recommended for legacy use in conjunction with event.next.
Published message	event.unregister	Removes this session's registration with the event system for a set of given classes. This method is only recommended for legacy use in conjunction with event.next.
Published message	host.bugreport_upload	Run xen-bugtool --yestoall and upload the output to support
Published message	host.destroy	Destroy specified host record in database
Published message	host.disable	Puts the host into a state in which no new VMs can be started. Currently active VMs on the host continue to execute.
Published message	host.dmesg	Get the host xen dmesg.
Published message	host.dmesg_clear	Get the host xen dmesg, and clear the buffer.
Published message	host.enable	Puts the host into a state in which new VMs can be started.
Published message	host.get_log	Get the host's log file
Published message	host.license_apply	Apply a new license to a host
Published message	host.list_methods	List all supported methods
Published message	host.reboot	Reboot the host. (This function can only be called if there are no currently running VMs on the host and it is disabled.)
Published message	host.restart_agent	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.
Published message	host.send_debug_keys	Inject the given string as debugging keys into Xen
Published message	host.shutdown	Shutdown the host. (This function can only be called if there are no currently running VMs on the host and it is disabled.)
Published message	host_crashdump.destroy	Destroy specified host crash dump, removing it from the disk.
Published message	host_crashdump.upload	Upload the specified host crash dump to a specified URL
Published message	host_patch.apply	Apply the selected patch and return its output
Published message	host_patch.destroy	Destroy the specified host patch, removing it from the disk. This does NOT reverse the patch
Published message	pool.create_VLAN	Create PIFs, mapping a network to the same physical interface/VLAN on each host. This call is deprecated: use Pool.create_VLAN_from_PIF instead.
Published message	pool.create_VLAN_from_PIF	Create a pool-wide VLAN by taking the PIF.
Published message	pool.eject	Instruct a pool master to eject a host from the pool
Published message	pool.emergency_reset_master	Instruct a slave already in a pool that the master has changed
Published message	pool.emergency_transition_to_master	Instruct host that's currently a slave to transition to being master
Published message	pool.join	Instruct host to join a new pool
Published message	pool.join_force	Instruct host to join a new pool
Published message	pool.recover_slaves	Instruct a pool master, M, to try and contact its slaves and, if slaves are in emergency mode, reset their master address to M.
Published message	pool.sync_database	Forcibly synchronise the database now
Published message	session.change_password	Change the account password; if your session is authenticated with root privileges then the old_pwd is validated and the new_pwd is set regardless
Published message	session.login_with_password	Attempt to authenticate the user, returning a session reference if successful
Published message	session.logout	Log out of a session
Published message	task.cancel	Request that a task be cancelled. Note that a task may fail to be cancelled and may complete or fail normally and note that, even when a task does cancel, it might take an arbitrary amount of time.
Published message	task.create	Create a new task object which must be manually destroyed.
Published message	task.destroy	Destroy the task object