Справочник Пользователя для Citrix Systems 6
115
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 writable. The
the RW indicates that this is a map parameter and is readable and writable. 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 writable.
and is readable but not writable.
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
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.
still works but is deprecated.
Low-level Parameter 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>
Lists all of the parameters and their associated values. Unlike the class-list command, this will list the values
of "expensive" fields.
of "expensive" fields.
<class>
-param-get
uuid=
<uuid>
param-name=
<parameter>
[param-key=
<key>
]
Returns the value of a particular parameter. If the parameter is a map, specifying the param-key will get the
value associated with that key in the map. If param-key is not specified, or if the parameter is a set, it will
return a string representation of the set or map.
value associated with that key in the map. If param-key is not specified, or if the parameter is a set, it will
return a string representation of the set or map.
<class>
-param-set
uuid=
<uuid>
param=
<value>
...
Sets the value of one or more parameters.
<class>
-param-add
uuid=
<uuid>
param-name=
<parameter>
[
<key>
=
<value>
...] [param-key=
<key>
]
Adds to either a map or a set parameter. If the parameter is a map, add key/value pairs using the
<key>
=
<value>
syntax. If the parameter is a set, add keys with the
<param-key>
=
<key>
syntax.
<class>
-param-remove
uuid=
<uuid>
param-name=
<parameter>
param-key=
<key>
Removes either a key/value pair from a map, or a key from a set.
<class>
-param-clear
uuid=
<uuid>
param-name=
<parameter>
Completely clears a set or a map.
Low-level List Commands
The
<class>
-list command lists the objects of type
<class>
. By default it will list all objects, printing a subset of the
parameters. This behavior can be modified in two ways: it can filter the objects so that it only outputs a subset,
and the parameters that are printed can be modified.
and the parameters that are printed can be modified.
To change the parameters that are printed, the argument params should be specified as a comma-separated list
of the required parameters. For example:
of the required parameters. For example:
xe vm-list params=name-label,other-config
Alternatively, to list all of the parameters, use the syntax: