167

vlan-create

vlan-create pif-uuid=<uuid_of_pif> vlan=<vlan_number> network-uuid=<uuid_of_network>
Create a new VLAN on a XenServer host.

pool-vlan-create

vlan-create pif-uuid=<uuid_of_pif> vlan=<vlan_number> network-uuid=<uuid_of_network>
Create a new VLAN on all hosts on a pool, by determining which interface (for example, eth0) the specified
network is on (on each host) and creating and plugging a new PIF object one each host accordingly.

vlan-destroy

vlan-destroy uuid=<uuid_of_pif_mapped_to_vlan>
Destroy a VLAN. Requires the UUID of the PIF that represents the VLAN.
VM Commands
Commands for controlling VMs and their attributes.

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>. An easy way to
get the uuid of an actual VM is to, for example, execute xe vm-list power-state=running. (The full list of fields
that can be matched can be obtained by the command xe vm-list params-all. ) 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.
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 the section called “Low-level Parameter Commands”
for details.

VM Parameters

VMs have the following parameters:
Note:
All writable 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
appliance the appliance/vApp to which
the VM belongs
read/write
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
order start order for vApp startup/
shutdown and for startup after
HA failover
read/write