XenServer Administrator's Guide 4.1.0

Command line interface
88
VM selectors
Several of the commands listed here have a common mechanism for selecting one or more VMs on which
to perform the operation. The simplest way is by supplying the argument vm=name or uuid . VMs
can also be specified by filtering the full list of VMs on the values of fields. For example, specifying pow-
er-state=halted will select all VMs whose power-state parameter is equal to halted. Where mul-
tiple VMs are matching, the option --multiple must 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
the command xe vm-list params=all. If no parameters to select VMs are given, the operation will
be performed on all VMs.
The VM objects can be listed with the standard object listing command (xe vm-list), and the parameters
manipulated with the standard parameter commands. See Section 5.3.2, “Low-level param commands” for
details.
VM parameters
VMs have the following parameters:
Note
All writeable VM parameter values can be changed while the VM is running, but the new parameters
are not applied dynamically and will not be applied until the VM is rebooted.
Parameter Name Description Type
uuid The unique identifier/object reference for
the VM
read only
name-label The name of the VM read/write
name-description The description string of the VM read/write
user-version string for creators of VMs and templates to
put version information
read/write
is-a-template false unless this is a template; template
VMs can never be started, they are used
only for cloning other VMs
Note that setting is-a-template using the
CLI is not supported.
read/write
is-control-domain true if this is a control domain (domain 0 or
a driver domain)
read only
power-state Current power state read only
memory-dynamic-max dynamic maximum in bytes read/write
memory-dynamic-min dynamic minimum in bytes read/write
memory-static-max statically-set (absolute) maximum in bytes.
If you want to change this value, the VM
must be shut down.
read/write
memory-static-min statically-set (absolute) minimum in bytes
If you want to change this value, the VM
must be shut down.
read/write