HP BL680c XenServer Administrator's Guide 4.1.0 - Page 94

VM selectors, VM parameters

Page 94 highlights

Command line interface 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 power-state=halted will select all VMs whose power-state parameter is equal to halted. Where multiple 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 uuid name-label name-description user-version is-a-template Description Type The unique identifier/object reference for read only the VM The name of the VM read/write The description string of the VM read/write string for creators of VMs and templates to read/write put version information false unless this is a template; template VMs can never be started, they are used only for cloning other VMs read/write is-control-domain power-state memory-dynamic-max memory-dynamic-min memory-static-max Note that setting is-a-template using the CLI is not supported. true if this is a control domain (domain 0 or read only a driver domain) Current power state read only dynamic maximum in bytes read/write dynamic minimum in bytes read/write statically-set (absolute) maximum in bytes. read/write memory-static-min If you want to change this value, the VM must be shut down. statically-set (absolute) minimum in bytes read/write If you want to change this value, the VM must be shut down. 88

  • 1
  • 2
  • 3
  • 4
  • 5
  • 6
  • 7
  • 8
  • 9
  • 10
  • 11
  • 12
  • 13
  • 14
  • 15
  • 16
  • 17
  • 18
  • 19
  • 20
  • 21
  • 22
  • 23
  • 24
  • 25
  • 26
  • 27
  • 28
  • 29
  • 30
  • 31
  • 32
  • 33
  • 34
  • 35
  • 36
  • 37
  • 38
  • 39
  • 40
  • 41
  • 42
  • 43
  • 44
  • 45
  • 46
  • 47
  • 48
  • 49
  • 50
  • 51
  • 52
  • 53
  • 54
  • 55
  • 56
  • 57
  • 58
  • 59
  • 60
  • 61
  • 62
  • 63
  • 64
  • 65
  • 66
  • 67
  • 68
  • 69
  • 70
  • 71
  • 72
  • 73
  • 74
  • 75
  • 76
  • 77
  • 78
  • 79
  • 80
  • 81
  • 82
  • 83
  • 84
  • 85
  • 86
  • 87
  • 88
  • 89
  • 90
  • 91
  • 92
  • 93
  • 94
  • 95
  • 96
  • 97
  • 98
  • 99
  • 100
  • 101
  • 102
  • 103
  • 104
  • 105
  • 106
  • 107
  • 108

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