Lines Matching refs:B
7 B<xl> I<subcommand> [I<args>]
11 The B<xl> program is the new tool for managing Xen guest
16 The basic structure of every B<xl> command is almost always:
20 B<xl> I<subcommand> [I<OPTIONS>] I<domain-id>
36 =item start the script B</etc/init.d/xencommons> at boot time
38 Most B<xl> operations rely upon B<xenstored> and B<xenconsoled>: make
39 sure you start the script B</etc/init.d/xencommons> at boot time to
40 initialize all the daemons needed by B<xl>.
42 =item setup a B<xenbr0> bridge in dom0
45 named B<xenbr0> in order to have a working network in the guest domains.
49 =item B<autoballoon>
51 If you specify the amount of memory dom0 has, passing B<dom0_mem> to
52 Xen, it is highly recommended to disable B<autoballoon>. Edit
53 B</etc/xen/xl.conf> and set it to 0.
55 =item run xl as B<root>
57 Most B<xl> commands require root privileges to run due to the
69 =item B<-v>
73 =item B<-N>
77 =item B<-f>
83 =item B<-t>
98 =item B<button-press> I<domain-id> I<button>
105 =item B<create> [I<configfile>] [I<OPTIONS>]
109 If I<configfile> is missing B<xl> creates the domain assuming the default
114 Create will return B<as soon> as the domain is started. This B<does
121 B<OPTIONS>
125 =item B<-q>, B<--quiet>
129 =item B<-f=FILE>, B<--defconfig=FILE>
133 =item B<-p>
137 =item B<-F>
141 =item B<-V>, B<--vncviewer>
145 =item B<-A>, B<--vncviewer-autopass>
149 =item B<-c>
156 =item B<key=value>
170 B<EXAMPLES>
190 =item B<config-update> I<domain-id> [I<configfile>] [I<OPTIONS>]
204 B<OPTIONS>
208 =item B<-f=FILE>, B<--defconfig=FILE>
212 =item B<key=value>
222 =item B<console> [I<OPTIONS>] I<domain-id>
230 B<OPTIONS>
247 =item B<destroy> [I<OPTIONS>] I<domain-id>
252 B<shutdown> command instead.
254 B<OPTIONS>
266 =item B<domid> I<domain-name>
270 =item B<domname> I<domain-id>
274 =item B<rename> I<domain-id> I<new-name>
278 =item B<dump-core> I<domain-id> [I<filename>]
285 =item B<help> [I<--long>]
289 If the I<--long> option is specified, it displays the complete set of B<xl>
292 =item B<list> [I<OPTIONS>] [I<domain-id> ...]
298 B<OPTIONS>
302 =item B<-l>, B<--long>
304 The output for B<xl list> is not the table view shown below, but
307 =item B<-Z>, B<--context>
311 =item B<-v>, B<--verbose>
315 =item B<-c>, B<--cpupool>
319 =item B<-n>, B<--numa>
325 B<EXAMPLE>
341 B<STATES>
348 =item B<r - running>
352 =item B<b - blocked>
358 =item B<p - paused>
361 running B<xl pause>. When in a paused state the domain will still
365 =item B<s - shutdown>
370 =item B<c - crashed>
376 =item B<d - dying>
383 B<NOTES>
396 =item B<mem-max> I<domain-id> I<mem>
408 domain (B<maxmem> parameter in the domain's configuration). Using B<xl mem-max>
409 to set the maximum memory above the initial B<maxmem> value will not allow the
410 additional memory to be used via B<xl mem-set>. The initial B<maxmem> value is
411 still used as an upper limit for B<xl mem-set>.
415 =item B<mem-set> I<domain-id> I<mem>
426 B<Warning:> There is no good way to know in advance how small of a
430 =item B<migrate> [I<OPTIONS>] I<domain-id> I<host>
432 Migrate a domain to another host machine. By default B<xl> relies on ssh as a
435 B<OPTIONS>
439 =item B<-s> I<sshcommand>
444 =item B<-e>
449 =item B<-C> I<config>
454 =item B<--debug>
458 =item B<-p>
464 =item B<remus> [I<OPTIONS>] I<domain-id> I<host>
466 Enable Remus HA or COLO HA for domain. By default B<xl> relies on ssh as a
469 B<NOTES>
489 =item B<colo-host> : Secondary host's ip address.
491 =item B<colo-port> : Secondary host's port, we will run a nbd server on the
494 =item B<colo-export> : Nbd server's disk export name of the secondary host.
496 =item B<active-disk> : Secondary's guest write will be buffered to this disk,
499 =item B<hidden-disk> : Primary's modified contents will be buffered in this
512 =item B<forwarddev> : Forward devices for the primary and the secondary, they
518 B<OPTIONS>
522 =item B<-i> I<MS>
526 =item B<-u>
530 =item B<-s> I<sshcommand>
535 =item B<-e>
540 =item B<-N> I<netbufscript>
545 =item B<-F>
550 =item B<-b>
555 =item B<-n>
559 =item B<-d>
563 =item B<-c>
565 Enable COLO HA. This conflicts with B<-i> and B<-b>, and memory
568 =item B<-p>
571 with B<-c>.
575 =item B<pause> I<domain-id>
581 =item B<reboot> [I<OPTIONS>] I<domain-id>
583 Reboot a domain. This acts just as if the domain had the B<reboot>
594 B<on_reboot> parameter of the domain configuration file when the
597 B<OPTIONS>
601 =item B<-F>
612 =item B<restore> [I<OPTIONS>] [I<configfile>] I<checkpointfile>
614 Build a domain from an B<xl save> state file. See B<save> for more info.
616 B<OPTIONS>
620 =item B<-p>
624 =item B<-e>
629 =item B<-d>
633 =item B<-V>, B<--vncviewer>
637 =item B<-A>, B<--vncviewer-autopass>
645 =item B<save> [I<OPTIONS>] I<domain-id> I<checkpointfile> [I<configfile>]
650 B<xl restore> restores from this checkpoint file.
656 =item B<-c>
660 =item B<-p>
666 =item B<sharing> [I<domain-id>]
671 =item B<shutdown> [I<OPTIONS>] I<-a|domain-id>
684 B<-w> flag is used.
687 B<on_shutdown> parameter of the domain configuration file when the
690 B<OPTIONS>
694 =item B<-a>, B<--all>
699 =item B<-w>, B<--wait>
703 =item B<-F>
714 =item B<sysrq> I<domain-id> I<letter>
722 =item B<trigger> I<domain-id> I<nmi|reset|init|power|sleep|s3resume> [I<VCPU>]
728 =item B<unpause> I<domain-id>
733 =item B<vcpu-set> I<domain-id> I<vcpu-count>
748 after B<vcpu-set>, go to B<SEE ALSO> section for information.
750 =item B<vcpu-list> [I<domain-id>]
755 =item B<vcpu-pin> [I<-f|--force>] I<domain-id> I<vcpu> I<cpus hard> I<cpus soft>
766 The keyword B<all> can be used to apply the hard and soft affinity masks to
787 =item B<vm-list>
792 B<EXAMPLE>
800 =item B<vncviewer> [I<OPTIONS>] I<domain-id>
804 B<OPTIONS>
820 =item B<debug-keys> I<keys>
825 =item B<set-parameters> I<params>
830 =item B<dmesg> [I<OPTIONS>]
837 B<OPTIONS>
841 =item B<-c>, B<--clear>
847 =item B<info> [I<OPTIONS>]
887 B<FIELDS>
894 =item B<hw_caps>
901 =item B<free_memory>
906 =item B<outstanding_claims>
912 be zero, but if you are launching multiple guests, and B<claim_mode> is
914 affects the B<free_memory> - as it will reflect the free memory
916 See xl I<info> B<claims> parameter for detailed listing.
918 =item B<xen_caps>
923 =item B<xen_changeset>
930 B<OPTIONS>
934 =item B<-n>, B<--numa>
940 =item B<top>
942 Executes the B<xentop(1)> command, which provides real time monitoring of
945 =item B<uptime>
949 =item B<claims>
954 is provided via the I<info> argument, B<outstanding_claims> value.
955 The B<Mem> column has the cumulative value of outstanding claims and
958 B<EXAMPLE>
977 time with the B<sched=> parameter on the Xen command line. By
978 default B<credit> is used for scheduling.
982 =item B<sched-credit> [I<OPTIONS>]
990 B<OPTIONS>
994 =item B<-d DOMAIN>, B<--domain=DOMAIN>
999 =item B<-w WEIGHT>, B<--weight=WEIGHT>
1005 =item B<-c CAP>, B<--cap=CAP>
1026 =item B<-p CPUPOOL>, B<--cpupool=CPUPOOL>
1030 =item B<-s>, B<--schedparam>
1034 =item B<-t TSLICE>, B<--tslice_ms=TSLICE>
1041 =item B<-r RLIMIT>, B<--ratelimit_us=RLIMIT>
1051 B<COMBINATION>
1057 =item B<E<lt>nothingE<gt>> : List all domain params and sched params from all pools
1059 =item B<-d [domid]> : List domain params for domain [domid]
1061 =item B<-d [domid] [params]> : Set domain params for domain [domid]
1063 =item B<-p [pool]> : list all domains and sched params for [pool]
1065 =item B<-s> : List sched params for poolid 0
1067 =item B<-s [params]> : Set sched params for poolid 0
1069 =item B<-p [pool] -s> : List sched params for [pool]
1071 =item B<-p [pool] -s [params]> : Set sched params for [pool]
1073 =item B<-p [pool] -d>... : Illegal
1077 =item B<sched-credit2> [I<OPTIONS>]
1085 B<OPTIONS>
1089 =item B<-d DOMAIN>, B<--domain=DOMAIN>
1094 =item B<-w WEIGHT>, B<--weight=WEIGHT>
1100 =item B<-p CPUPOOL>, B<--cpupool=CPUPOOL>
1104 =item B<-s>, B<--schedparam>
1108 =item B<-r RLIMIT>, B<--ratelimit_us=RLIMIT>
1111 as B<--ratelimit_us> in B<sched-credit>
1115 =item B<sched-rtds> [I<OPTIONS>]
1126 B<OPTIONS>
1130 =item B<-d DOMAIN>, B<--domain=DOMAIN>
1135 =item B<-v VCPUID/all>, B<--vcpuid=VCPUID/all>
1139 =item B<-p PERIOD>, B<--period=PERIOD>
1143 =item B<-b BUDGET>, B<--budget=BUDGET>
1148 =item B<-e Extratime>, B<--extratime=Extratime>
1153 =item B<-c CPUPOOL>, B<--cpupool=CPUPOOL>
1159 B<EXAMPLE>
1163 1) Use B<-v all> to see the budget and period of all the VCPUs of
1188 2) Use, for instance, B<-d vm1, -v all> to see the budget and
1189 period of all VCPUs of a specific domain (B<vm1>):
1205 If no B<-v> is specified, the default scheduling parameters for the
1217 To change the parameters of all the VCPUs of a domain, use B<-v all>,
1236 =item B<cpupool-create> [I<OPTIONS>] [I<configfile>] [I<variable=value> ...]
1244 B<OPTIONS>
1248 =item B<-f=FILE>, B<--defconfig=FILE>
1254 =item B<cpupool-list> [I<OPTIONS>] [I<cpu-pool>]
1258 B<OPTIONS>
1262 =item B<-c>, B<--cpus>
1264 If this option is specified, B<xl> prints a list of CPUs used by I<cpu-pool>.
1268 =item B<cpupool-destroy> I<cpu-pool>
1273 =item B<cpupool-rename> I<cpu-pool> <newname>
1277 =item B<cpupool-cpu-add> I<cpu-pool> I<cpus|node:nodes>
1296 =item B<cpupool-cpu-remove> I<cpus|node:nodes>
1300 exact same syntax as in B<cpupool-cpu-add> above.
1302 =item B<cpupool-migrate> I<domain-id> I<cpu-pool>
1307 =item B<cpupool-numa-split>
1323 =item B<block-attach> I<domain-id> I<disc-spec-component(s)> ...
1326 A disc specification is in the same format used for the B<disk> variable in
1334 =item B<block-detach> I<domain-id> I<devid> [I<OPTIONS>]
1338 will need to run B<xl block-list> to determine that number.
1344 B<OPTIONS>
1348 =item B<--force>
1357 =item B<block-list> I<domain-id>
1361 =item B<cd-insert> I<domain-id> I<virtualdevice> I<target>
1368 See B<target> in L<xl-disk-configuration(5)>.
1373 =item B<cd-eject> I<domain-id> I<virtualdevice>
1384 =item B<network-attach> I<domain-id> I<network-device>
1388 B<vif> string in the domain config file. See L<xl.cfg(5)> and
1394 =item B<network-detach> I<domain-id> I<devid|mac>
1401 =item B<network-list> I<domain-id>
1411 =item B<channel-list> I<domain-id>
1421 =item B<vtpm-attach> I<domain-id> I<vtpm-device>
1425 using the same format as the B<vtpm> string in the domain config file.
1428 =item B<vtpm-detach> I<domain-id> I<devid|uuid>
1432 Platform Module device. You will need to run B<xl vtpm-list> to determine that
1436 =item B<vtpm-list> I<domain-id>
1446 =item B<vdispl-attach> I<domain-id> I<vdispl-device>
1450 B<vdispl> string in the domain config file. See L<xl.cfg> for
1453 B<NOTES>
1460 B<EXAMPLE>
1474 =item B<vdispl-detach> I<domain-id> I<dev-id>
1478 =item B<vdispl-list> I<domain-id>
1488 =item B<pci-assignable-list>
1495 =item B<pci-assignable-add> I<BDF>
1509 =item B<pci-assignable-remove> [I<-r>] I<BDF>
1517 =item B<pci-attach> I<domain-id> I<BDF>
1520 B<BDF> is the PCI Bus/Device/Function of the physical device to pass-through.
1522 =item B<pci-detach> [I<OPTIONS>] I<domain-id> I<BDF>
1524 Hot-unplug a previously assigned pci device from a domain. B<BDF> is the PCI
1527 B<OPTIONS>
1531 =item B<-f>
1533 If this parameter is specified, B<xl> is going to forcefully remove the device
1538 =item B<pci-list> I<domain-id>
1548 =item B<usbctrl-attach> I<domain-id> I<usbctrl-device>
1552 C<KEY=VALUE KEY=VALUE ...> where B<KEY=VALUE> has the same
1553 meaning as the B<usbctrl> description in the domain config file.
1556 =item B<usbctrl-detach> I<domain-id> I<devid>
1559 B<devid> is devid of the USB controller.
1561 =item B<usbdev-attach> I<domain-id> I<usbdev-device>
1565 form C<KEY=VALUE KEY=VALUE ...> where B<KEY=VALUE> has the same
1566 meaning as the B<usbdev> description in the domain config file.
1569 =item B<usbdev-detach> I<domain-id> I<controller=devid> I<port=number>
1572 B<controller=devid> and B<port=number> is USB controller:port in the guest
1575 =item B<usb-list> I<domain-id>
1585 =item B<qemu-monitor-command> I<domain-id> I<command>
1592 B<Warning:> This qemu monitor access is provided for convenience when
1607 B<EXAMPLE>
1621 =item B<tmem-list> I<[OPTIONS]> I<domain-id>
1625 B<OPTIONS>
1629 =item B<-l>
1635 =item B<tmem-freeze> I<domain-id>
1639 =item B<tmem-thaw> I<domain-id>
1643 =item B<tmem-set> I<domain-id> [I<OPTIONS>]
1647 B<OPTIONS>
1651 =item B<-w> I<WEIGHT>
1655 =item B<-p> I<COMPRESS>
1661 =item B<tmem-shared-auth> I<domain-id> [I<OPTIONS>]
1665 B<OPTIONS>
1669 =item B<-u> I<UUID>
1673 =item B<-a> I<AUTH>
1679 =item B<tmem-freeable>
1687 B<FLASK> is a security framework that defines a mandatory access control policy
1702 =item B<getenforce>
1706 =item B<setenforce> I<1|0|Enforcing|Permissive>
1712 =item B<loadpolicy> I<policy-file>
1724 hardware capabilities can be shown with B<psr-hwinfo>.
1731 =item B<psr-hwinfo> [I<OPTIONS>]
1735 B<OPTIONS>
1739 =item B<-m>, B<--cmt>
1743 =item B<-a>, B<--cat>
1772 =item B<psr-cmt-attach> I<domain-id>
1776 =item B<psr-cmt-detach> I<domain-id>
1780 =item B<psr-cmt-show> I<psr-monitor-type> [I<domain-id>]
1808 =item B<psr-cat-set> [I<OPTIONS>] I<domain-id> I<cbm>
1813 B<OPTIONS>
1817 =item B<-s SOCKET>, B<--socket=SOCKET>
1821 =item B<-l LEVEL>, B<--level=LEVEL>
1826 =item B<-c>, B<--code>
1830 =item B<-d>, B<--data>
1836 =item B<psr-cat-show> [I<OPTIONS>] [I<domain-id>]
1840 B<OPTIONS>
1844 =item B<-l LEVEL>, B<--level=LEVEL>
1861 =item B<xl migrate --live>
1871 =item B<tmem>