Citrix Systems 5.6 manual Host XenServer host commands, Host selectors, Host parameters

Blocks other commands from executing until an object exists that satisfies the conditions given on the command line. x=y means "wait for field x to take value y", and x=/=y means "wait for field x to take any value other than y".

Example: wait for a specific VM to be running

xe event-wait class=vm name-label=myvm power-state=running

Blocks other commands until a VM called myvm is in the power-state"running."

Example: wait for a specific VM to reboot:

xe event-wait class=vm uuid=$VM start-time=/=$(xe vm-list uuid=$VM params=start-time --minimal)

Blocks other commands until a VM with UUID $VM reboots (i.e. has a different start-timevalue).

The class name can be any of the Event classes listed at the beginning of this section, and the parameters can be any of those listed in the CLI command class-param-list.

Host (XenServer host) commands

Commands for interacting with XenServer host.

XenServer hosts are the physical servers running XenServer software. They have VMs running on them under the control of a special privileged Virtual Machine, known as the control domain or domain 0.

The XenServer host objects can be listed with the standard object listing command (xe host-list, xe host- cpu-list, and xe host-crashdump-list), and the parameters manipulated with the standard parameter commands. See the section called “Low-level param commands” for details.

Host selectors

Several of the commands listed here have a common mechanism for selecting one or more XenServer hosts on which to perform the operation. The simplest is by supplying the argument host=<uuid_or_name_label>. XenServer hosts can also be specified by filtering the full list of hosts on the values of fields. For example, specifying enabled=true will select all XenServer hosts whose enabled field is equal to true. Where multiple XenServer hosts are matching, and the operation can be performed on multiple XenServer hosts, the option --multiplemust be specified to perform the operation. The full list of parameters that can be matched is described at the beginning of this section, and can be obtained by running the command xe host-list params=all. If no parameters to select XenServer hosts are given, the operation will be performed on all XenServer hosts.

Host parameters

XenServer hosts have the following parameters:

Parameter Name	Description	Type
uuid	The unique identifier/object	read only
	reference for the XenServer
	host
name-label	The name of the XenServer	read/write
	host
name-description	The description string of the	read only
	XenServer host

151