xl man page on SuSE

xl man page on SuSE

Man page or keyword search:
man Server 14857 pages
apropos Keyword Search (all sections)
Output format

xl(1) Xen xl(1)

NAME
XL - Xen management tool, based on LibXenlight

SYNOPSIS
xl subcommand [args]

DESCRIPTION
The xl program is the new tool for managing Xen guest domains. The
program can be used to create, pause, and shutdown domains. It can also
be used to list current domains, enable or pin VCPUs, and attach or
detach virtual block devices. The xm tool continues to be supported on
SLE11 platforms and should still be used.

The basic structure of every xl command is almost always:

xl subcommand [OPTIONS] domain-id

Where subcommand is one of the subcommands listed below, domain-id is
the numeric domain id, or the domain name (which will be internally
translated to domain id), and OPTIONS are subcommand specific options.
There are a few exceptions to this rule in the cases where the
subcommand in question acts on all domains, the entire machine, or
directly on the Xen hypervisor. Those exceptions will be clear for
each of those subcommands.

NOTES
start the script /etc/init.d/xencommons at boot time
Most xl operations rely upon xenstored and xenconsoled: make sure
you start the script /etc/init.d/xencommons at boot time to
initialize all the daemons needed by xl.

setup a xenbr0 bridge in dom0
In the most common network configuration, you need to setup a
bridge in dom0 named xenbr0 in order to have a working network in
the guest domains. Please refer to the documentation of your Linux
distribution to know how to setup the bridge.

autoballoon
If you specify the amount of memory dom0 has, passing dom0_mem to
Xen, it is highly recommended to disable autoballoon. Edit
/etc/xen/xl.conf and set it to 0.

run xl as root
Most xl commands require root privileges to run due to the
communications channels used to talk to the hypervisor. Running as
non root will return an error.

GLOBAL OPTIONS
Some global options are always available:

-v Verbose.

-N Dry run: do not actually execute the command.

-f Force execution: xl will refuse to run some commands if it detects
that xend is also running, this option will force the execution of
those commands, even though it is unsafe.

DOMAIN SUBCOMMANDS
The following subcommands manipulate domains directly. As stated
previously, most commands take domain-id as the first parameter.

button-press domain-id button
This command is deprecated. Please use "xl trigger" in preference

Indicate an ACPI button press to the domain. button is may be
'power' or 'sleep'. This command is only available for HVM domains.

create [configfile] [OPTIONS]
The create subcommand takes a config file as first argument: see
xl.cfg for full details of that file format and possible options.
If configfile is missing XL creates the domain starting from the
default value for every option.

configfile has to be an absolute path to a file.

Create will return as soon as the domain is started. This does not
mean the guest OS in the domain has actually booted, or is
available for input.

OPTIONS

-q, --quiet
No console output.

-f=FILE, --defconfig=FILE
Use the given configuration file.

-p Leave the domain paused after it is created.

-V, --vncviewer
Attach to domain's VNC server, forking a vncviewer process.

-A, --vncviewer-autopass
Pass VNC password to vncviewer via stdin.

-c Attach console to the domain as soon as it has started. This
is useful for determining issues with crashing domains and just
as a general convenience since you often want to watch the
domain boot.

key=value
It is possible to pass key=value pairs on the command line to
provide options as if they were written in the configuration
file; these override whatever is in the configfile.

EXAMPLES

with config file
xl create DebianLenny

This creates a domain with the file /etc/xen/DebianLenny, and
returns as soon as it is run.

config-update domid [configfile] [OPTIONS]
Update the saved configuration for a running domain. This has no
immediate effect but will be applied when the guest is next
restarted. This command is useful to ensure that runtime
modifications made to the guest will be preserved when the guest is
restarted.

configfile has to be an absolute path to a file.

OPTIONS

-f=FILE, --defconfig=FILE
Use the given configuration file.

key=value
It is possible to pass key=value pairs on the command line to
provide options as if they were written in the configuration
file; these override whatever is in the configfile.

console [OPTIONS] domain-id
Attach to domain domain-id's console. If you've set up your
domains to have a traditional log in console this will look much
like a normal text log in screen.

Use the key combination Ctrl+] to detach the domain console.

OPTIONS

-t [pv|serial]
Connect to a PV console or connect to an emulated serial
console. PV consoles are the only consoles available for PV
domains while HVM domains can have both. If this option is not
specified it defaults to emulated serial for HVM guests and PV
console for PV guests.

-n NUM
Connect to console number NUM. Console numbers start from 0.

destroy domain-id
Immediately terminate the domain domain-id. This doesn't give the
domain OS any chance to react, and is the equivalent of ripping the
power cord out on a physical machine. In most cases you will want
to use the shutdown command instead.

domid domain-name
Converts a domain name to a domain id.

domname domain-id
Converts a domain id to a domain name.

rename domain-id new-name
Change the domain name of domain-id to new-name.

dump-core domain-id [filename]
Dumps the virtual machine's memory for the specified domain to the
filename specified, without pausing the domain. The dump file will
be written to a distribution specific directory for dump files.
Such as: /var/lib/xen/dump or /var/xen/dump.

help [--long]
Displays the short help message (i.e. common commands).

The --long option prints out the complete set of xl subcommands,
grouped by function.

list [OPTIONS] [domain-id ...]
Prints information about one or more domains. If no domains are
specified it prints out information about all domains.

OPTIONS

-l, --long
The output for xl list is not the table view shown below, but
instead presents the data in as a JSON data structure.

-Z, --context Also prints the security labels.
-v, --verbose
Also prints the domain UUIDs, the shutdown reason and security
labels.

EXAMPLE

An example format for the list is as follows:

Name ID Mem VCPUs State Time(s)
Domain-0 0 750 4 r----- 11794.3
win 1 1019 1 r----- 0.3
linux 2 2048 2 r----- 5624.2

Name is the name of the domain. ID the numeric domain id. Mem is
the desired amount of memory to allocate to the domain (although it
may not be the currently allocated amount). VCPUs is the number of
virtual CPUs allocated to the domain. State is the run state (see
below). Time is the total run time of the domain as accounted for
by Xen.

STATES

The State field lists 6 states for a Xen domain, and which ones the
current domain is in.

r - running
The domain is currently running on a CPU.

b - blocked
The domain is blocked, and not running or runnable. This can
be caused because the domain is waiting on IO (a traditional
wait state) or has gone to sleep because there was nothing else
for it to do.

p - paused
The domain has been paused, usually occurring through the
administrator running xl pause. When in a paused state the
domain will still consume allocated resources like memory, but
will not be eligible for scheduling by the Xen hypervisor.

s - shutdown
The guest OS has shut down (SCHEDOP_shutdown has been called)
but the domain is not dying yet.

c - crashed
The domain has crashed, which is always a violent ending.
Usually this state can only occur if the domain has been
configured not to restart on crash. See xl.cfg(5) for more
info.

d - dying
The domain is in process of dying, but hasn't completely
shutdown or crashed.

NOTES

The Time column is deceptive. Virtual IO (network and block
devices) used by domains requires coordination by Domain0,
which means that Domain0 is actually charged for much of the
time that a DomainU is doing IO. Use of this time value to
determine relative utilizations by domains is thus very
suspect, as a high IO workload may show as less utilized than a
high CPU workload. Consider yourself warned.

mem-max domain-id mem
Specify the maximum amount of memory the domain is able to use,
appending 't' for terabytes, 'g' for gigabytes, 'm' for megabytes,
'k' for kilobytes and 'b' for bytes.

The mem-max value may not correspond to the actual memory used in
the domain, as it may balloon down its memory to give more back to
the OS.

mem-set domain-id mem
Set the domain's used memory using the balloon driver; append 't'
for terabytes, 'g' for gigabytes, 'm' for megabytes, 'k' for
kilobytes and 'b' for bytes.

Because this operation requires cooperation from the domain
operating system, there is no guarantee that it will succeed. This
command will definitely not work unless the domain has the required
paravirt driver.

Warning: There is no good way to know in advance how small of a
mem-set will make a domain unstable and cause it to crash. Be very
careful when using this command on running domains.

migrate [OPTIONS] domain-id host
Migrate a domain to another host machine. By default xl relies on
ssh as a transport mechanism between the two hosts.

OPTIONS

-s sshcommand
Use <sshcommand> instead of ssh. String will be passed to sh.
If empty, run <host> instead of ssh <host> xl migrate-receive
[-d -e].

-e On the new host, do not wait in the background (on <host>) for
the death of the domain. See the corresponding option of the
create subcommand.

-C config
Send <config> instead of config file from creation.

remus [OPTIONS] domain-id host
Enable Remus HA for domain. By default xl relies on ssh as a
transport mechanism between the two hosts.

N.B: Remus support in xl is still in experimental (proof-of-
concept) phase.
There is no support for network or disk buffering at the
moment.

OPTIONS

-i MS
Checkpoint domain memory every MS milliseconds (default 200ms).

-b Replicate memory checkpoints to /dev/null (blackhole).
Generally useful for debugging.

-u Disable memory checkpoint compression.

-s sshcommand
Use <sshcommand> instead of ssh. String will be passed to sh.
If empty, run <host> instead of ssh <host> xl migrate-receive
-r [-e].

-e On the new host, do not wait in the background (on <host>) for
the death of the domain. See the corresponding option of the
create subcommand.

pause domain-id
Pause a domain. When in a paused state the domain will still
consume allocated resources such as memory, but will not be
eligible for scheduling by the Xen hypervisor.

reboot [OPTIONS] domain-id
Reboot a domain. This acts just as if the domain had the reboot
command run from the console. The command returns as soon as it
has executed the reboot action, which may be significantly before
the domain actually reboots.

For HVM domains this requires PV drivers to be installed in your
guest OS. If PV drivers are not present but you have configured the
guest OS to behave appropriately you may be able to use the -F
option trigger a reset button press.

The behavior of what happens to a domain when it reboots is set by
the on_reboot parameter of the domain configuration file when the
domain was created.

OPTIONS

-F If the guest does not support PV reboot control then fallback
to sending an ACPI power event (equivalent to the reset option
to trigger.

You should ensure that the guest is configured to behave as
expected in response to this event.

restore [OPTIONS] [ConfigFile] CheckpointFile
Build a domain from an xl save state file. See save for more info.

OPTIONS

-p Do not unpause domain after restoring it.

-e Do not wait in the background for the death of the domain on
the new host. See the corresponding option of the create
subcommand.

-d Enable debug messages.

-V, --vncviewer
Attach to domain's VNC server, forking a vncviewer process.

-A, --vncviewer-autopass
Pass VNC password to vncviewer via stdin.

save [OPTIONS] domain-id CheckpointFile [ConfigFile]
Saves a running domain to a state file so that it can be restored
later. Once saved, the domain will no longer be running on the
system, unless the -c option is used. xl restore restores from
this checkpoint file. Passing a config file argument allows the
user to manually select the VM config file used to create the
domain.

-c Leave domain running after creating the snapshot.

sharing [domain-id]
List count of shared pages.

OPTIONS

domain_id
List specifically for that domain. Otherwise, list for all
domains.

shutdown [OPTIONS] domain-id
Gracefully shuts down a domain. This coordinates with the domain
OS to perform graceful shutdown, so there is no guarantee that it
will succeed, and may take a variable length of time depending on
what services must be shutdown in the domain.

The command returns immediately after signally the domain unless
that -w flag is used.

The behavior of what happens to a domain when it reboots is set by
the on_shutdown parameter of the domain configuration file when the
domain was created.

OPTIONS

-w, --wait
Wait for the domain to complete shutdown before returning.

-F If the guest does not support PV shutdown control then fallback
to sending an ACPI power event (equivalent to the power option
to trigger.

You should ensure that the guest is configured to behave as
expected in response to this event.

sysrq domain-id letter
Send a <Magic System Request> to the domain, each type of request
is represented by a different letter. It can be used to send SysRq
requests to Linux guests, see sysrq.txt in your Linux Kernel
sources for more information. It requires PV drivers to be
installed in your guest OS.

trigger domain-id nmi|reset|init|power|sleep|s3resume [VCPU]
Send a trigger to a domain, where the trigger can be: nmi, reset,
init, power or sleep. Optionally a specific vcpu number can be
passed as an argument. This command is only available for HVM
domains.

unpause domain-id
Moves a domain out of the paused state. This will allow a
previously paused domain to now be eligible for scheduling by the
Xen hypervisor.

vcpu-set domain-id vcpu-count
Enables the vcpu-count virtual CPUs for the domain in question.
Like mem-set, this command can only allocate up to the maximum
virtual CPU count configured at boot for the domain.

If the vcpu-count is smaller than the current number of active
VCPUs, the highest number VCPUs will be hotplug removed. This may
be important for pinning purposes.

Attempting to set the VCPUs to a number larger than the initially
configured VCPU count is an error. Trying to set VCPUs to < 1 will
be quietly ignored.

Some guests may need to actually bring the newly added CPU online
after vcpu-set, go to SEE ALSO section for information.

vcpu-list [domain-id]
Lists VCPU information for a specific domain. If no domain is
specified, VCPU information for all domains will be provided.

vcpu-pin domain-id vcpu cpus
Pins the VCPU to only run on the specific CPUs. The keyword all
can be used to apply the cpus list to all VCPUs in the domain.

Normally VCPUs can float between available CPUs whenever Xen deems
a different run state is appropriate. Pinning can be used to
restrict this, by ensuring certain VCPUs can only run on certain
physical CPUs.

vm-list
Prints information about guests. This list excludes information
about service or auxiliary domains such as dom0 and stubdoms.

EXAMPLE

An example format for the list is as follows:

UUID ID name
59e1cf6c-6ab9-4879-90e7-adc8d1c63bf5 2 win
50bc8f75-81d0-4d53-b2e6-95cb44e2682e 3 linux

vncviewer [OPTIONS] domain-id
Attach to domain's VNC server, forking a vncviewer process.

OPTIONS

--autopass
Pass VNC password to vncviewer via stdin.

XEN HOST SUBCOMMANDS
debug-keys keys
Send debug keys to Xen. It is the same as pressing the Xen
"conswitch" (Ctrl-A by default) three times and then pressing
"keys".

dmesg [-c]
Reads the Xen message buffer, similar to dmesg on a Linux system.
The buffer contains informational, warning, and error messages
created during Xen's boot process. If you are having problems with
Xen, this is one of the first places to look as part of problem
determination.

OPTIONS

-c, --clear
Clears Xen's message buffer.

info [-n, --numa]
Print information about the Xen host in name : value format. When
reporting a Xen bug, please provide this information as part of the
bug report. See http://wiki.xen.org/xenwiki/ReportingBugs on how to
report Xen bugs.

Sample output looks as follows:

host : scarlett
release : 3.1.0-rc4+
version : #1001 SMP Wed Oct 19 11:09:54 UTC 2011
machine : x86_64
nr_cpus : 4
nr_nodes : 1
cores_per_socket : 4
threads_per_core : 1
cpu_mhz : 2266
hw_caps : bfebfbff:28100800:00000000:00003b40:009ce3bd:00000000:00000001:00000000
virt_caps : hvm hvm_directio
total_memory : 6141
free_memory : 4274
free_cpus : 0
xen_major : 4
xen_minor : 2
xen_extra : -unstable
xen_caps : xen-3.0-x86_64 xen-3.0-x86_32p hvm-3.0-x86_32 hvm-3.0-x86_32p hvm-3.0-x86_64
xen_scheduler : credit
xen_pagesize : 4096
platform_params : virt_start=0xffff800000000000
xen_changeset : Wed Nov 02 17:09:09 2011 +0000 24066:54a5e994a241
xen_commandline : com1=115200,8n1 guest_loglvl=all dom0_mem=750M console=com1
cc_compiler : gcc version 4.4.5 (Debian 4.4.5-8)
cc_compile_by : sstabellini
cc_compile_domain : uk.xensource.com
cc_compile_date : Tue Nov 8 12:03:05 UTC 2011
xend_config_format : 4

FIELDS

Not all fields will be explained here, but some of the less obvious
ones deserve explanation:

hw_caps
A vector showing what hardware capabilities are supported by
your processor. This is equivalent to, though more cryptic,
the flags field in /proc/cpuinfo on a normal Linux machine:
they both derive from the feature bits returned by the cpuid
command on x86 platforms.

free_memory
Available memory (in MB) not allocated to Xen, or any other
domains.

xen_caps
The Xen version and architecture. Architecture values can be
one of: x86_32, x86_32p (i.e. PAE enabled), x86_64, ia64.

xen_changeset
The Xen mercurial changeset id. Very useful for determining
exactly what version of code your Xen system was built from.

OPTIONS

-n, --numa
List host NUMA topology information

top Executes the xentop command, which provides real time monitoring of
domains. Xentop is a curses interface, and reasonably self
explanatory.

uptime
Prints the current uptime of the domains running.

SCHEDULER SUBCOMMANDS
Xen ships with a number of domain schedulers, which can be set at boot
time with the sched= parameter on the Xen command line. By default
credit is used for scheduling.

sched-credit [OPTIONS]
Set or get credit scheduler parameters. The credit scheduler is a
proportional fair share CPU scheduler built from the ground up to
be work conserving on SMP hosts.

Each domain (including Domain0) is assigned a weight and a cap.

OPTIONS

-d DOMAIN, --domain=DOMAIN
Specify domain for which scheduler parameters are to be
modified or retrieved. Mandatory for modifying scheduler
parameters.

-w WEIGHT, --weight=WEIGHT
A domain with a weight of 512 will get twice as much CPU as a
domain with a weight of 256 on a contended host. Legal weights
range from 1 to 65535 and the default is 256.

-c CAP, --cap=CAP
The cap optionally fixes the maximum amount of CPU a domain
will be able to consume, even if the host system has idle CPU
cycles. The cap is expressed in percentage of one physical CPU:
100 is 1 physical CPU, 50 is half a CPU, 400 is 4 CPUs, etc.
The default, 0, means there is no upper cap.

-p CPUPOOL, --cpupool=CPUPOOL
Restrict output to domains in the specified cpupool.

-s, --schedparam
Specify to list or set pool-wide scheduler parameters.

-t TSLICE, --tslice_ms=TSLICE
Timeslice tells the scheduler how long to allow VMs to run
before pre-empting. The default is 30ms. Valid ranges are 1ms
to 1000ms. The length of the timeslice (in ms) must be higher
than the length of the ratelimit (see below).

-r RLIMIT, --ratelimit_us=RLIMIT
Ratelimit attempts to limit the number of schedules per second.
It sets a minimum amount of time (in microseconds) a VM must
run before we will allow a higher-priority VM to pre-empt it.
The default value is 1000 microseconds (1ms). Valid range is
100 to 500000 (500ms). The ratelimit length must be lower than
the timeslice length.

COMBINATION

The following is the effect of combining the above options:

<nothing> : List all domain params and sched params
from all pools
-d [domid] : List domain params for domain [domid]
-d [domid] [params] : Set domain params for domain [domid]
-p [pool] : list all domains and sched params for
[pool]
-s : List sched params for poolid 0
-s [params] : Set sched params for poolid 0
-p [pool] -s : List sched params for [pool]
-p [pool] -s [params] : Set sched params for [pool]
-p [pool] -d... : Illegal

sched-credit2 [OPTIONS]
Set or get credit2 scheduler parameters. The credit2 scheduler is
a proportional fair share CPU scheduler built from the ground up to
be work conserving on SMP hosts.

Each domain (including Domain0) is assigned a weight.

OPTIONS

-d DOMAIN, --domain=DOMAIN
Specify domain for which scheduler parameters are to be
modified or retrieved. Mandatory for modifying scheduler
parameters.

-w WEIGHT, --weight=WEIGHT
A domain with a weight of 512 will get twice as much CPU as a
domain with a weight of 256 on a contended host. Legal weights
range from 1 to 65535 and the default is 256.

-p CPUPOOL, --cpupool=CPUPOOL
Restrict output to domains in the specified cpupool.

sched-sedf [OPTIONS]
Set or get Simple EDF (Earliest Deadline First) scheduler
parameters. This scheduler provides weighted CPU sharing in an
intuitive way and uses realtime-algorithms to ensure time
guarantees. For more information see
docs/misc/sedf_scheduler_mini-HOWTO.txt in the Xen distribution.

OPTIONS

-d DOMAIN, --domain=DOMAIN
Specify domain for which scheduler parameters are to be
modified or retrieved. Mandatory for modifying scheduler
parameters.

-p PERIOD, --period=PERIOD
The normal EDF scheduling usage in milliseconds.

-s SLICE, --slice=SLICE
The normal EDF scheduling usage in milliseconds.

-l LATENCY, --latency=LATENCY
Scaled period if domain is doing heavy I/O.

-e EXTRA, --extra=EXTRA
Flag for allowing domain to run in extra time (0 or 1).

-w WEIGHT, --weight=WEIGHT
Another way of setting CPU slice.

-c CPUPOOL, --cpupool=CPUPOOL
Restrict output to domains in the specified cpupool.

CPUPOOLS COMMANDS
Xen can group the physical cpus of a server in cpu-pools. Each physical
CPU is assigned at most to one cpu-pool. Domains are each restricted to
a single cpu-pool. Scheduling does not cross cpu-pool boundaries, so
each cpu-pool has an own scheduler. Physical cpus and domains can be
moved from one cpu-pool to another only by an explicit command. Cpu-
pools can be specified either by name or by id.

cpupool-create [OPTIONS] [ConfigFile] [Variable=Value ...]
Create a cpu pool based an config from a ConfigFile or command-line
parameters. Variable settings from the ConfigFile may be altered
by specifying new or additional assignments on the command line.

See the xlcpupool.cfg(5) manpage for more information.

OPTIONS

-f=FILE, --defconfig=FILE
Use the given configuration file.

cpupool-list [-c|--cpus] [cpu-pool]
List CPU pools on the host. If -c is specified, xl prints a list
of CPUs used by cpu-pool.

cpupool-destroy cpu-pool
Deactivates a cpu pool. This is possible only if no domain is
active in the cpu-pool.

cpupool-rename cpu-pool <newname>
Renames a cpu-pool to newname.

cpupool-cpu-add cpu-pool cpu-nr|node:node-nr
Adds a cpu or all cpus of a numa node to a cpu-pool.

cpupool-cpu-remove cpu-nr|node:node-nr
Removes a cpu or all cpus of a numa node from a cpu-pool.

cpupool-migrate domain cpu-pool
Moves a domain specified by domain-id or domain-name into a cpu-
pool.

cpupool-numa-split
Splits up the machine into one cpu-pool per numa node.

VIRTUAL DEVICE COMMANDS
Most virtual devices can be added and removed while guests are running,
assuming that the necessary support exists in the guest. The effect to
the guest OS is much the same as any hotplug event.

BLOCK DEVICES

block-attach domain-id disc-spec-component(s) ...
Create a new virtual block device. This will trigger a hotplug
event for the guest.

OPTIONS

domain-id
The domain id of the guest domain that the device will be
attached to.

disc-spec-component
A disc specification in the same format used for the disk
variable in the domain config file. See
<http://xenbits.xen.org/docs/unstable/misc/xl-disk-configuration.txt>.

block-detach domain-id devid [--force]
Detach a domain's virtual block device. devid may be the symbolic
name or the numeric device id given to the device by domain 0. You
will need to run xl block-list to determine that number.

Detaching the device requires the cooperation of the domain. If
the domain fails to release the device (perhaps because the domain
is hung or is still using the device), the detach will fail. The
--force parameter will forcefully detach the device, but may cause
IO errors in the domain.

block-list domain-id
List virtual block devices for a domain.

cd-insert domain-id VirtualDevice target
Insert a cdrom into a guest domain's existing virtial cd drive. The
virtual drive must already exist but can be current empty.

Only works with HVM domains.

OPTIONS

VirtualDevice
How the device should be presented to the guest domain; for
example "hdc".

target
the target path in the backend domain (usually domain 0) to be
exported; Can be a block device or a file etc. See target in
docs/misc/xl-disk-configuration.txt.

cd-eject domain-id VirtualDevice
Eject a cdrom from a guest's virtual cd drive. Only works with HVM
domains.

OPTIONS

VirtualDevice
How the device should be presented to the guest domain; for
example "hdc".

NETWORK DEVICES

network-attach domain-id network-device
Creates a new network device in the domain specified by domain-id.
network-device describes the device to attach, using the same
format as the vif string in the domain config file. See xl.cfg and
<http://xenbits.xen.org/docs/unstable/misc/xl-network-configuration.html>
for more informations.

network-detach domain-id devid|mac
Removes the network device from the domain specified by domain-id.
devid is the virtual interface device number within the domain
(i.e. the 3 in vif22.3). Alternatively the mac address can be used
to select the virtual interface to detach.

network-list domain-id
List virtual network interfaces for a domain.

PCI PASS-THROUGH
pci-assignable-list
List all the assignable PCI devices. These are devices in the
system which are configured to be available for passthrough and are
bound to a suitable PCI backend driver in domain 0 rather than a
real driver.

pci-assignable-add BDF
Make the device at PCI Bus/Device/Function BDF assignable to
guests. This will bind the device to the pciback driver. If it is
already bound to a driver, it will first be unbound, and the
original driver stored so that it can be re-bound to the same
driver later if desired. If the device is already bound, it will
return success.

CAUTION: This will make the device unusable by Domain 0 until it is
returned with pci-assignable-remove. Care should therefore be
taken not to do this on a device critical to domain 0's operation,
such as storage controllers, network interfaces, or GPUs that are
currently being used.

pci-assignable-remove [-r] BDF
Make the device at PCI Bus/Device/Function BDF assignable to
guests. This will at least unbind the device from pciback. If the
-r option is specified, it will also attempt to re-bind the device
to its original driver, making it usable by Domain 0 again. If the
device is not bound to pciback, it will return success.

pci-attach domain-id BDF
Hot-plug a new pass-through pci device to the specified domain.
BDF is the PCI Bus/Device/Function of the physical device to pass-
through.

pci-detach [-f] domain-id BDF
Hot-unplug a previously assigned pci device from a domain. BDF is
the PCI Bus/Device/Function of the physical device to be removed
from the guest domain.

If -f is specified, xl is going to forcefully remove the device
even without guest's collaboration.

pci-list domain-id
List pass-through pci devices for a domain.

TMEM
tmem-list I[<-l>] domain-id
List tmem pools. If -l is specified, also list tmem stats.

tmem-freeze domain-id
Freeze tmem pools.

tmem-thaw domain-id
Thaw tmem pools.

tmem-set domain-id [OPTIONS]
Change tmem settings.

OPTIONS

-w WEIGHT
Weight (int)

-c CAP
Cap (int)

-p COMPRESS
Compress (int)

tmem-shared-auth domain-id [OPTIONS]
De/authenticate shared tmem pool.

OPTIONS

-u UUID
Specify uuid (abcdef01-2345-6789-1234-567890abcdef)

-a AUTH
0=auth,1=deauth

tmem-freeable
Get information about how much freeable memory (MB) is in-use by
tmem.

FLASK
FLASK is a security framework that defines a mandatory access control
policy providing fine-grained controls over Xen domains, allowing the
policy writer to define what interactions between domains, devices, and
the hypervisor are permitted. Some example of what you can do using
XSM/FLASK:
- Prevent two domains from communicating via event channels or grants
- Control which domains can use device passthrough (and which devices)
- Restrict or audit operations performed by privileged domains
- Prevent a privileged domain from arbitrarily mapping pages from
other
domains.

You can find more details on how to use FLASK and an example security
policy here: <http://xenbits.xen.org/docs/unstable/misc/xsm-flask.txt>

getenforce
Determine if the FLASK security module is loaded and enforcing its
policy.

setenforce 1|0|Enforcing|Permissive
Enable or disable enforcing of the FLASK access controls. The
default is permissive and can be changed using the flask_enforcing
option on the hypervisor's command line.

loadpolicy policy-file
Load FLASK policy from the given policy file. The initial policy is
provided to the hypervisor as a multiboot module; this command
allows runtime updates to the policy. Loading new security policy
will reset runtime changes to device labels.

TO BE DOCUMENTED
We need better documentation for:

tmem
Transcendent Memory.