HP BL680c XenServer Administrator's Guide 4.1.0 - Page 56

Parameter types, 3.2. Low-level param commands

Get HP BL680c - ProLiant - G5 PDF manuals and user guides
UPC - 884420396314
View all HP BL680c manuals
Add to My Manuals
Save this manual to your list of manuals

Page 56 highlights

Command line interface Note that not every value of class has the full set of class-param- commands; some have just a subset. 5.3.1. Parameter types The objects that are addressed with the xe commands have sets of parameters that identify them and define their states. Most parameters take a single value. For example, the name-label parameter of a VM contains a single string value. In the output from parameter list commands such as xe vm-param-list, such parameters have an indication in parentheses that defines whether they can be read and written to, or are read-only. For example, the output of xe vm-param-list on a specified VM might have the lines user-version ( RW): 1 is-control-domain ( RO): false The first parameter, user-version, is writeable and has the value 1. The second, is-control-domain, is read-only and has a value of false. The two other types of parameters are multi-valued. A set parameter contains a list of values. A map parameter is a set of key/value pairs. As an example, look at the following excerpt of some sample output of the xe vm-param-list on a specified VM: platform (MRW): acpi: true; apic: true; pae: true; nx: false allowed-operations (SRO): pause; clean_shutdown; clean_reboot; \ hard_shutdown; hard_reboot; suspend The platform parameter has a list of items that represent key/value pairs. The key names are followed by a colon character (:). Each key/value pair is separated from the next by a semicolon character (;). The M preceding the RW indicates that this is a map parameter and is readable and writeable. The allowed-operations parameter has a list that makes up a set of items. The S preceding the RO indicates that this is a set parameter and is readable but not writeable. In xe commands where you want to filter on a map parameter, or set a map parameter, use the separator : (colon) between the map parameter name and the key/value pair. For example, to set the value of the foo key of the other-config parameter of a VM to baa, the command would be xe vm-param-set uuid=VM uuid other-config:foo=baa Note In previous releases the separator - (dash) was used in specifying map parameters. This syntax still works but is deprecated. 5.3.2. Low-level param commands There are several commands for operating on parameters of objects: class-param-get,class-paramset,class-param-add,class-param-remove,class-param-clear and class-param-list. Each of these takes a uuid parameter to specify the particular object. Since these are considered low-level commands, they must be addressed by UUID and not by the VM name label. • [class]-param-list uuid=uuid 50

  • 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
50
Note that not every value of
class
has the full set of
class
-param-
commands; some have just a subset.
5.3.1. Parameter types
The objects that are addressed with the xe commands have sets of parameters that identify them and define
their states.
Most parameters take a single value. For example, the
name-label
parameter of a VM contains a single
string value. In the output from parameter list commands such as
xe vm-param-list
, such parameters have
an indication in parentheses that defines whether they can be read and written to, or are read-only. For
example, the output of
xe vm-param-list
on a specified VM might have the lines
user-version ( RW): 1
is-control-domain ( RO): false
The first parameter,
user-version
, is writeable and has the value 1. The second,
is-control-domain
,
is read-only and has a value of false.
The two other types of parameters are multi-valued. A
set
parameter contains a list of values. A
map
pa-
rameter is a set of key/value pairs. As an example, look at the following excerpt of some sample output of
the
xe vm-param-list
on a specified VM:
platform (MRW): acpi: true; apic: true; pae: true; nx: false
allowed-operations (SRO): pause; clean_shutdown; clean_reboot; \
hard_shutdown; hard_reboot; suspend
The
platform
parameter has a list of items that represent key/value pairs. The key names are followed
by a colon character (:). Each key/value pair is separated from the next by a semicolon character (;). The M
preceding the RW indicates that this is a map parameter and is readable and writeable. The
allowed-op-
erations
parameter has a list that makes up a set of items. The S preceding the RO indicates that this
is a set parameter and is readable but not writeable.
In xe commands where you want to filter on a map parameter, or set a map parameter, use the separator :
(colon) between the map parameter name and the key/value pair. For example, to set the value of the
foo
key of the
other-config
parameter of a VM to
baa
, the command would be
xe vm-param-set uuid=
VM uuid
other-config:foo=baa
Note
In previous releases the separator - (dash) was used in specifying map parameters. This syntax
still works but is deprecated.
5.3.2. Low-level param commands
There are several commands for operating on parameters of objects:
class
-param-get,
class
-param-
set,
class
-param-add,
class
-param-remove,
class
-param-clear and
class
-param-list. Each of these takes a
uuid
parameter to specify the particular object. Since these are considered low-level commands, they must
be addressed by UUID and not by the VM name label.
•
[class]
-param-list
uuid=
uuid