Christoph: New page: '''`xl`''' is a CLI tool that is based on the xenlight library (libxl), a library designed to provide a common "bottom third" for any Xen tool...

2013-12-25T05:51:23Z

New page: '''<tt>xl</tt>''' is a CLI tool that is based on the xenlight library (libxl), a library designed to provide a common "bottom third" for any Xen tool...

New page

'''<tt>xl</tt>''' is a [[:Category:Linux Command Line Tools|CLI]] tool that is based on the xenlight library (libxl), a library designed to provide a common "bottom third" for any Xen toolstack. The <code>xl</code> toolstack is intended to remain backwards compatible with existing <code>`[[xm (XenClassic)|xm]]`</code> (for ''[[:Category:XenClassic|XenClassic]]'') domain configuration files.

==Usage==
xl [-v] <subcommand> [args]

==List of commands==
Below is a full list of <code>`xl`</code> subcommands:

; <code>create</code> : Create a domain from config file <filename>
; <code>list</code> : List information about all/some domains
; <code>destroy</code> : Terminate a domain immediately
; <code>shutdown</code> : Issue a shutdown signal to a domain
; <code>reboot</code> : Issue a reboot signal to a domain
; <code>pci-attach</code> : Insert a new pass-through pci device
; <code>pci-detach</code> : Remove a domain's pass-through pci device
; <code>pci-list</code> : List pass-through pci devices for a domain
; <code>pci-list-assignable-devices</code> : List all the assignable pci devices
; <code>pause</code> : Pause execution of a domain
; <code>unpause</code> : Unpause a paused domain
; <code>console</code> : Attach to domain's console
; <code>vncviewer</code> : Attach to domain's VNC server.
; <code>save</code> : Save a domain state to restore later
; <code>migrate</code> : Save a domain state to restore later
; <code>dump-core</code> : Core dump a domain
; <code>restore</code> : Restore a domain from a saved state
; <code>migrate-receive</code> : Restore a domain from a saved state
; <code>cd-insert</code> : Insert a cdrom into a guest's cd drive
; <code>cd-eject</code> : Eject a cdrom from a guest's cd drive
; <code>mem-max</code> : Set the maximum amount reservation for a domain
; <code>mem-set</code> : Set the current memory usage for a domain
; <code>button-press</code> : Indicate an ACPI button press to the domain
; <code>vcpu-list</code> : List the VCPUs for all/some domains
; <code>vcpu-pin</code> : Set which CPUs a VCPU can use
; <code>vcpu-set</code> : Set the number of active VCPUs allowed for the domain
; <code>list-vm</code> : List the VMs,without DOM0
; <code>info</code> : Get information about Xen host
; <code>sched-credit</code> : Get/set credit scheduler parameters
; <code>domid</code> : Convert a domain name to domain id
; <code>domname</code> : Convert a domain id to domain name
; <code>rename</code> : Rename a domain
; <code>trigger</code> : Send a trigger to a domain
; <code>sysrq</code> : Send a sysrq to a domain
; <code>debug-keys</code> : Send debug keys to Xen
; <code>dmesg</code> : Read and/or clear dmesg buffer
; <code>top</code> : Monitor a host and the domains in real time
; <code>network-attach</code> : Create a new virtual network device
; <code>network-list</code> : List virtual network interfaces for a domain
; <code>network-detach</code> : Destroy a domain's virtual network device
; <code>block-attach</code> : Create a new virtual block device
; <code>block-list</code> : List virtual block devices for a domain
; <code>block-detach</code> : Destroy a domain's virtual block device
; <code>uptime</code> : Print uptime for all/some domains
; <code>tmem-list</code> : List tmem pools
; <code>tmem-freeze</code> : Freeze tmem pools
; <code>tmem-destroy</code> : Destroy tmem pools
; <code>tmem-thaw</code> : Thaw tmem pools
; <code>tmem-set</code> : Change tmem settings
; <code>tmem-shared-auth</code> : De/authenticate shared tmem pool
; <code>tmem-freeable</code> : Get information about how much freeable memory (MB) is in-use by tmem
; <code>network2-attach</code> : Create a new version 2 virtual network device
; <code>network2-list</code> : list version 2 virtual network interfaces for a domain
; <code>network2-detach</code> : destroy a domain's version 2 virtual network device
; <code>cpupool-create</code> : Create a CPU pool based an ConfigFile
; <code>cpupool-list</code> : List CPU pools on host
; <code>cpupool-destroy</code> : Deactivates a CPU pool
; <code>cpupool-rename</code> : Renames a CPU pool
; <code>cpupool-cpu-add</code> : Adds a CPU to a CPU pool
; <code>cpupool-cpu-remove</code> : Removes a CPU from a CPU pool
; <code>cpupool-migrate</code> : Moves a domain into a CPU pool
; <code>cpupool-numa-split</code> : Splits up the machine into one CPU pool per NUMA node

==Examples==
*Get a list of all domains on your host:
<pre>
$ xl list
Name ID Mem VCPUs State Time(s)
Domain-0 0 752 2 r----- 11335.8
</pre>

* Below is the output from my ''XenServer'' sandbox machine:
<pre>
$ xl info
host : legacy.thirdcraft.com
release : 2.6.32.43-0.4.1.xs1.8.0.835.170778xen
version : #1 SMP Wed May 29 18:06:30 EDT 2013
machine : i686
nr_cpus : 2
max_cpu_id : 1
nr_nodes : 1
cores_per_socket : 2
threads_per_core : 1
cpu_mhz : 2926
hw_caps : bfebfbff:20100800:00000000:00000940:0008e3bd:00000000:00000001:00000000
virt_caps : hvm
total_memory : 3931
free_memory : 3065
free_cpus : 0
xen_major : 4
xen_minor : 1
xen_extra : .5
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=0xff800000
xen_changeset : 23509:aa273b47bcbe, pq 572:5c414f7cb3b1
xen_commandline : mem=1024G dom0_max_vcpus=2 dom0_mem=752M,max:752M watchdog_timeout=300 \
lowmem_emergency_pool=1M crashkernel=64M@32M cpuid_mask_xsave_eax=0 \
console=vga vga=mode-0x0311
cc_compiler : gcc version 4.1.2 20080704 (Red Hat 4.1.2-46)
cc_compile_by : root
cc_compile_domain : uk.xensource.com
cc_compile_date : Fri Jun 14 09:04:06 EDT 2013
xend_config_format : 4
</pre>

==External links==
* [http://wiki.xen.org/wiki/XL `xl` information] — on the Xen.org wiki
* [http://wiki.xen.org/wiki/Choice_of_Toolstacks Choice of Toolstacks] — on the Xen.org wiki

[[Category:XenServer]]

Xl (XenServer) - Revision history

Christoph: New page: '''xl''' is a CLI tool that is based on the xenlight library (libxl), a library designed to provide a common "bottom third" for any Xen tool...

Christoph: New page: '''`xl`''' is a CLI tool that is based on the xenlight library (libxl), a library designed to provide a common "bottom third" for any Xen tool...