XenServer Administrator's Guide 4.1.0

Command line interface

xe vm-list HVM-boot-policy="BIOS order" power-state=halted

will only list those VMs for which both the field [power-state] has the value halted, and for which the field

[HVM-boot-policy] has the value BIOS order.

It is also possible to filter the list based on the value of keys in maps, or on the existence of values in a set.

The syntax for the first of these is map-name:key=value, and the second is set-name:contains=value

For scripting, a useful technique is passing [--minimal] on the command line, causing xe to print only the

first field in a comma-separated list. For example, the command xe vm-list --minimal on a XenServer Host

with three VMs installed gives the three UUIDs of the VMs, for example:

a85d6717-7264-d00e-069b-3b1d19d56ad9,aaa3eec5-9499-bcf3-4c03-af10baea96b7, \

42c044de-df69-4b30-89d9-2c199564581d

5.4. xe command reference

This section provides a reference to the xe commands. They are grouped by objects that the commands

address, and listed alphabetically.

5.4.1. Bonding commands

Commands for working with network bonds, for resilience with physical interface failover. See Section 4.2.4,

“Creating NIC bonds” for details.

The bond object is a reference object which glues together master and member PIFs. The master PIF is

the bonding interface which must be used as the overall PIF to refer to the bond. The member PIFs are a

set of 2 or more physical interfaces which have been combined into the high-level bonded interface.

Bond parameters

Bonds have the following parameters:

Parameter Name Description Type

uuid unique identifier/object reference for the

bond

read only

master UUID for the master bond PIF read only

members set of UUIDs for the underlying bonded

PIFs

read only set parameter

5.4.1.1. bond-create

bond-create network-uuid=network UUID pif-uuids=PIF UUID 1,PIF UUID 2,...

Create a bonded network interface on the network specified from a list of existing PIF objects. The command

will fail if PIFs are in another bond already, if any member has a VLAN tag set, if the referenced PIFs are

not on the same XenServer Host, or if fewer than 2 PIFs are supplied.

5.4.1.2. bond-destroy

host-bond-destroy uuid=bond UUID