From nobody Tue Nov 26 23:39:44 2024
Delivered-To: importer@patchew.org
Received-SPF: pass (zoho.com: domain of redhat.com designates 209.132.183.28
as permitted sender) client-ip=209.132.183.28;
envelope-from=libvir-list-bounces@redhat.com; helo=mx1.redhat.com;
Authentication-Results: mx.zohomail.com;
spf=pass (zoho.com: domain of redhat.com designates 209.132.183.28 as
permitted sender) smtp.mailfrom=libvir-list-bounces@redhat.com;
dmarc=pass(p=none dis=none) header.from=redhat.com
ARC-Seal: i=1; a=rsa-sha256; t=1563370978; cv=none;
d=zoho.com; s=zohoarc;
b=SZ5kJeNlLpZIxSTF4PdFdDSXNoiDKOyZDgNjOz+VxqAEKOzsqxK/nUZ0cXn4Rqr5GM7mW8k8aoUWHecEx4XqfSgLa8uzoc/88mXvnBI8boQeuYy+nbQbVhDfLN85wgKc0dQBXL3G1iwwFrSECsElh5PYH8nKIAPC3Gqj0x5cp+s=
ARC-Message-Signature: i=1; a=rsa-sha256; c=relaxed/relaxed; d=zoho.com;
s=zohoarc;
t=1563370978;
h=Content-Type:Content-Transfer-Encoding:Date:From:In-Reply-To:List-Subscribe:List-Post:List-Id:List-Archive:List-Help:List-Unsubscribe:MIME-Version:Message-ID:References:Sender:Subject:To:ARC-Authentication-Results;
bh=V5bJ2wjCqd0q0/X8Z+G0fFyHnfWP6QaOk7O56bi2D2k=;
b=E3kEGuUVjk6j4LcIlccPXpNANUUCJtfkwDw6tCtbkCSZPJe9OIvj28Q3rKodk5AGAZRIcgXGgfqQ7azOxsTfe4rW3cOyaXY+lUiQb0iNJ606R7dZIck5ZVYnt7xZtyZDBF9AtWKU9Jy3JGDWmbN8dpL80SI+sT5F42+J5eDqYK8=
ARC-Authentication-Results: i=1; mx.zoho.com;
spf=pass (zoho.com: domain of redhat.com designates 209.132.183.28 as
permitted sender) smtp.mailfrom=libvir-list-bounces@redhat.com;
dmarc=pass header.from= Up till here the BIOS/UEFI configuration knobs are generic enough=
to
@@ -257,8 +253,7 @@
uuid
uuid
element provides
a globally unique identifier for the virtual machine.
@@ -60,8 +60,7 @@
If omitted when defining/creating a new machine, a random
UUID is generated. It is also possible to provide the UUID
via a sysinfo
- specification. Since 0.0.1, sysinfo
- since 0.8.7genid
genid
@@ -92,13 +91,13 @@
title
title
provides space for a
short description of the domain. The title should not contain
- any newlines. Since 0.9.10.description
description
element provides a
human readable description of the virtual machine. This data is not
used by libvirt in any way, it can contain any information the user
- wants. Since 0.7.2metadata
metadata
node can be used by applications
@@ -107,7 +106,7 @@
XML nodes/trees, with only one top-level element per namespace
(if the application needs structure, they should have
sub-elements to their namespace
- element). Since 0.9.10Operating system booting
@@ -175,14 +174,13 @@
and machine
refe=
rring
to the machine type. The Capabilities =
XML
provides details on allowed values for
- these. Since 0.0.1
+ these.
loader
loader
tag refers to a firmware blob,
which is specified by absolute path,
used to assist the domain creation process. It is used by Xen
fully virtualized domains as well as setting the QEMU BIOS file
- path for QEMU/KVM domains. Xen since 0.1.0,
- QEMU/KVM since 0.9.12 Then, since
+ path for QEMU/KVM domains. Since
1.2.8 it's possible for the element to have two
optional attributes: readonly
(accepted values are
yes
and no
) to reflect the fact that the
@@ -226,8 +224,7 @@
USB and PCI devices sections belo=
w) were
introduced and they are the preferred way providing full control o=
ver
booting order. The boot
element and per-device boot
- elements are mutually exclusive. Since 0.1.3,
- per-device boot since 0.8.8
+ elements are mutually exclusive.
smbios
virConnectGetSysinfo
call can be
used to see what values are copied), or "sysinfo" (use the values =
in
the sysinfo element). If not
- specified, the hypervisor default is used.
- Since 0.8.7
+ specified, the hypervisor default is used.
bootmenu
enable
attribute can be either "yes" or "n=
o".
- If not specified, the hypervisor default is used.
- Since 0.8.3
+ If not specified, the hypervisor default is used.
Additional attribute timeout
takes the number of millis=
econds
the boot menu should wait until it times out. Allowed values are nu=
mbers
in range [0, 65535] inclusive and it is ignored unless enable<=
/code>
@@ -270,9 +265,7 @@
Serial Graphics Adapter which allows users to see BIOS messages
on a serial port. Therefore, one needs to have
serial port defined.
- Since 0.9.4.
- Since 0.10.2 (QEMU only) there is
- another attribute,
rebootTimeout
that controls
+ The attribute, rebootTimeout
controls
whether and after how long the guest should start booting
again in case the boot fails (according to BIOS). The value is
in milliseconds with maximum of 65535
and special
@@ -304,11 +297,10 @@
a fully qualified path to the bootloader executable in the
host OS. This bootloader will be run to choose which kernel
to boot. The required output of the bootloader is dependent
- on the hypervisor in use. Since 0.1.0=
bootloader_args
bootloader_args
element allows
command line arguments to be passed to the bootloader.
- Since 0.2.3
dmidecode
command in the guest). The
optional sysinfo
element covers all such categories
- of information. Since 0.8.7
+ of information.
@@ -627,14 +619,12 @@
Each element in that list is either a single CPU number,
a range of CPU numbers, or a caret followed by a CPU number to
be excluded from a previous range.
- Since 0.4.4
current
current
can
be used to specify whether fewer than the maximum number of
virtual CPUs should be enabled.
- Since 0.8.5
placement
placement
is "static", but no
cpuset
is specified, the domain process will be
pinned to all the available physical CPUs.
- Since 0.9.11 (QEMU and KVM only)
cputune
element provides details
regarding the CPU tunable parameters for the domain.
- Since 0.9.0
vcpupin
cpuset
is same as
attribute cpuset
of element vcpu
.
(NB: Only qemu driver support)
- Since 0.9.0
emulatorpin
period
quota
worth of runtime. The value should be in range [1000, 1000000]. A =
period
with value 0 means no value.
- Only QEMU driver support since 0.9.4, LXC si=
nce
- 0.9.10
quota
global_period
emulator_quota
worth of runtime. The value =
should be
in range [1000, 1000000]. A period with value 0 means no value.
- Only QEMU driver support since 0.10.0
emulator_quota
iothread_period
unit
since 0.9.11,
- dumpCore
since 0.10.2
- (QEMU only)
+
maxMemory
<memory>
element=
or
@@ -1256,9 +1234,7 @@
is possible to designate which unit the number is in on
input, using the same values as
for <memory>
. For backwards
- compatibility, output is always in
- KiB. unit
- since 0.9.11
+ compatibility, output is always in KiB.
Possible values for all *_limit parameters are in range from 0 to
VIR_DOMAIN_MEMORY_PARAM_UNLIMITED.hard_limit
numatune
element provides details of
how to tune the performance of a NUMA host via controlling NUMA po=
licy
for domain process. NB, only supported by QEMU driver.
- Since 0.9.3
memory
nodeset
specifies the NUMA nodes, using the same synt=
ax as
attribute cpuset
of element vcpu
. Attrib=
ute
- placement
(since 0.9.12)=
can be
+ placement
can be
used to indicate the memory placement mode for domain process, its=
value
can be either "static" or "auto", defaults to placement of
vcpu
, or "static" if nodeset
is specifie=
d.
@@ -1335,8 +1310,6 @@
numatune
is not specified, a default numatune=
code>
with placement
'auto' and mode
'strict' =
will
be added implicitly.
-
- Since 0.9.3
memnode
blkiotune
element provides the ability
to tune Blkio cgroup tunable parameters for the domain. If this is
omitted, it defaults to the OS provided
- defaults. Since 0.8.8weight
weight
element is the overall I/O
weight of the guest. The value should be in the range [100,
@@ -1405,7 +1378,7 @@
absolute path of the device, and weight
giving
the relative weight of that device, in the range [100,
1000]. After kernel 2.6.39, the value could be in the
- range [10, 1000]. Since 0.9.8read_bytes_sec
Requirements for CPU model, its features and topology can be specifi= ed using the following collection of elements. - Since 0.7.5
=20@@ -1487,7 +1459,6 @@In case no restrictions need to be put on CPU model and its features= , a simpler
=20cpu
element can be used. - Since 0.7.6@@ -1502,7 +1473,7 @@
cpu
element is the main container for describing
guest CPU requirements. Its match
attribute specifies=
how
strictly the virtual CPU provided to the guest matches these
- requirements. Since 0.7.6 the
+ requirements. The
match
attribute can be omitted if topology
is the only element within cpu
. Possible values for t=
he
match
attribute are:
@@ -1527,7 +1498,7 @@
and should only be used if there is a real reason.
match
+ The match
attribute can be omitted and will default to exact
.
=20
Sometimes the hypervisor is not able to create a virtual CPU exact=
ly
@@ -1560,7 +1531,7 @@
unless the two CPUs match.mode<=
/code>
+ An optional mode
attribute may be used to make it easier to configure a guest CPU t=
o be
as close to host CPU as possible. Possible values for the
mode
attribute are:
@@ -1648,19 +1619,19 @@
in libvirt's data directory. If a hypervisor is not able to use the
exact CPU model, libvirt automatically falls back to a closest mod=
el
supported by the hypervisor while maintaining the list of CPU
- features. Since 0.9.10, an optional
+ features. An optional
fallback
attribute can be used to forbid this behavio=
r,
in which case an attempt to start a domain requesting an unsupport=
ed
CPU model will fail. Supported values for fallback
attribute are: allow
(this is the default), and
forbid
. The optional vendor_id
attribute
- (Since 0.10.0) can be used to set the
+ can be used to set the
vendor id seen by the guest. It must be exactly 12 characters long.
If not set the vendor id of the host is used. Typical possible
values are "AuthenticAMD" and "GenuineIntel".
=20
vendor
- Since 0.8.3 the content of the
+ The content of the
vendor
element specifies CPU vendor requested by the
guest. If this element is missing, the guest can be run on a CPU
matching given features regardless on its vendor. The list of
@@ -1701,7 +1672,7 @@
CPU.
=20
- Since 0.8.5 the policy
+ The policy
attribute can be omitted and will default to require
.
=20
Individual CPU feature names are specified as part of the
@@ -1756,7 +1727,6 @@
=20
Guest NUMA topology can be specified using the numa
ele=
ment.
- Since 0.9.8
=20
@@ -1942,7 +1912,7 @@
=20
The on_crash
event supports these additional
- actions since 0.8.4.
+ actions:
=20
@@ -1986,7 +1956,7 @@
Power Management
=20
- Since 0.10.2 it is possible to
+ It is possible to
forcibly enable or disable BIOS advertisements to the guest
OS. (NB: Only qemu driver support)
@@ -2078,9 +2048,9 @@
apic
APIC allows the use of programmable IRQ
- management. Since 0.10.2 (QEMU only) th=
ere is
- an optional attribute eoi
with values on
- and off
which toggles the availability of EOI (End of
+ management.
+ An optional attribute eoi
with values on
+ and off
toggles the availability of EOI (End of
Interrupt) for the guest.
hap
@@ -2379,8 +2349,7 @@
utc
The guest clock will always be synchronized to UTC when
- booted.
- Since 0.9.11 'utc' mode can be co=
nverted
+ booted. The 'utc' mode can be converted
to 'variable' mode, which can be controlled by using the
adjustment
attribute. If the value is 'reset', the
conversion is never done (not all hypervisors can
@@ -2394,14 +2363,13 @@
The guest clock will be synchronized to the host's configured
timezone when booted, if any.
- Since 0.9.11, the adjustmen=
t
+ The adjustment
attribute behaves the same as in 'utc' mode.
timezone
The guest clock will be synchronized to the requested timezone
using the timezone
attribute.
- Since 0.7.7
variable
@@ -2413,15 +2381,14 @@
that it will be honored at next reboot. This is in
contrast to 'utc' and 'localtime' mode (with the optional
attribute adjustment=3D'reset'), where the RTC adjustments are
- lost at each reboot. Since 0.7.7
- Since 0.9.11 the basis
+ lost at each reboot.
+ The basis
attribute can be either 'utc' (default) or 'localtime'.
A clock
may have zero or more
- timer
sub-elements. Since
- 0.8.0
+ timer
sub-elements.
timer
@@ -2706,7 +2673,6 @@
The final set of XML elements are all used to describe devices
provided to the guest domain. All devices occur as children
of the main devices
element.
- Since 0.1.3
=20
@@ -2939,7 +2905,6 @@
"network" (since 0.8.7), or
"volume" (since 1.0.5)
and refer to the underlying source for the disk.
- Since 0.0.3
device
@@ -2947,7 +2912,7 @@
values for this attribute are "floppy", "disk", "cdrom", and "=
lun",
defaulting to "disk".
- Using "lun" (since 0.9.10) is only
+ Using "lun" is only
valid when the type
is "block" or "network" for
protocol=3D'iscsi'
or when the type
is "volume" when using an iSCSI source pool
@@ -2961,7 +2926,6 @@
but never for individual partitions or LVM partitions (in those
cases, the kernel will reject the generic SCSI commands, making
it identical to device=3D'disk').
- Since 0.1.4
model
@@ -2989,7 +2953,6 @@
To confine the capability as much as possible for QEMU driver
as this stage, sgio
is recommended, it's more
secure than rawio
.
- Since 0.9.10
sgio
@@ -3012,7 +2975,6 @@
domain snapshot creation.
Not all snapshot modes are supported; for example, enabling
snapshots with a transient disk generally does not make sense.
- Since 0.9.5
@@ -3024,19 +2986,16 @@
The file
attribute specifies the fully-qualified
path to the file holding the disk.
- Since 0.0.3
block
The dev
attribute specifies the fully-qualified=
path
to the host device to serve as the disk.
- Since 0.0.3
dir
The dir
attribute specifies the fully-qualified=
path
to the directory to use as the disk.
- Since 0.7.5
network
@@ -3081,7 +3040,6 @@
tls
attribute is set to "yes", then regardless =
of
the qemu.conf setting, TLS authentication will be attempted.
- Since 0.8.7
volume
@@ -3123,7 +3081,7 @@
With "file", "block", and "volume", one or more optional
sub-elements seclabel
, described
- below (and since 0.9.9), can be
+ below can be
used to override the domain security labeling policy for just
that source file. (NB, for "volume" type disk, seclabel
is only valid when the specified storage volume is of 'file' or
@@ -3290,8 +3248,7 @@
policy what to do with the disk if the source file is not accessib=
le.
(NB, startupPolicy
is not valid for "volume" disk unl=
ess
the specified storage volume is of "file" type). This is done by =
the
- startupPolicy
attribute
- (since 0.9.7),
+ startupPolicy
attribute,
accepting these values:
@@ -3400,7 +3357,7 @@
ignored on input. The source
sub-element exists
for all two-phase jobs since 1.2.6.
Older libvirt supported only block copy to a
- file, since 0.9.12; for
+ file, for
compatibility with older clients, such jobs include redundant
information in the attributes file
and format
in the mirror
element.
@@ -3424,10 +3381,8 @@
tray
could be updated while the domain is running.
The optional attribute removable
sets the
removable flag for USB disks, and its value can be either "on"
- or "off", defaulting to "off". Since
- 0.0.3; bus
attribute since 0.4.3;
- tray
attribute since 0.9.11; "usb" attribute value si=
nce
- after 0.4.4; "sata" attribute value since 0.9.7; "removable" attri=
bute
+ or "off", defaulting to "off".
+ "removable" attribute
value since 1.1.3
iotune
@@ -3439,7 +3394,7 @@
the only tuning available is Block I/O throttling for qemu.
This element has optional sub-elements; any sub-element not
specified or given with a value of 0 implies no
- limit. Since 0.9.8
+ limit.
total_bytes_sec
- The optional
total_bytes_sec
element is the
@@ -3543,7 +3498,6 @@
-
The optional driver element allows specifying further details
related to the hypervisor driver used to provide the disk.
- Since 0.1.8
-
If the hypervisor supports multiple backend drivers, then
@@ -3562,22 +3516,17 @@
"writethrough", but it bypasses the host page cache) and
"unsafe" (host may cache all disk io, and sync requests from
guest are ignored).
-
- Since 0.6.0,
- "directsync" since 0.9.5,
- "unsafe" since 0.9.7
-
-
The optional
error_policy
attribute controls
how the hypervisor will behave on a disk read or write
error, possible values are "stop", "report", "ignore", and
- "enospace".Since 0.8.0, "report" since
- 0.9.7 The default is left to the discretion of the
+ "enospace".
+ The default is left to the discretion of the
hypervisor. There is also an
optional rerror_policy
that controls behavior
- for read errors only. Since
- 0.9.7. If no rerror_policy is given, error_policy
+ for read errors only.
+ If no rerror_policy is given, error_policy
is used for both read and write errors. If rerror_policy
is given, it overrides the error_policy
for
read errors. Also note that "enospace" is not a valid
@@ -3588,7 +3537,7 @@
-
The optional
io
attribute controls specific
policies on I/O; qemu guests support "threads" and
- "native". Since 0.8.8
+ "native".
-
The optional
ioeventfd
attribute allows users to
@@ -3600,7 +3549,6 @@
Typically guests experiencing high system CPU utilization
during I/O will benefit from this. On the other hand,
on overloaded host it could increase guest I/O latency.
- Since 0.9.3 (QEMU and KVM only)
In general you should leave this option alone, unless you
are very certain you know what you are doing.
@@ -3613,7 +3561,6 @@
supported, default is on. In case there is a situation
where this behavior is suboptimal, this attribute provides
a way to force the feature off.
- Since 0.9.5 (QEMU and KVM only)
In general you should leave this option alone, unless you
are very certain you know what you are doing.
@@ -3624,7 +3571,6 @@
Copy-on-read avoids accessing the same backing file sectors
repeatedly and is useful when the backing file is over a slow
network. By default copy-on-read is off.
- Since 0.9.10 (QEMU and KVM only)
-
The optional
discard
attribute controls whether
@@ -3632,7 +3578,6 @@
ignored or passed to the filesystem. The value can be either
"unmap" (allow the discard request to be passed) or "ignore"
(ignore the discard request).
- Since 1.0.6 (QEMU and KVM only)
-
The optional
detect_zeroes
attribute controls whe=
ther
@@ -3684,7 +3629,6 @@
The per-device boot
elements cannot be used together
with general boot elements in
BIOS bootloader section.
- Since 0.8.8
encryption
- Starting with libvirt 3.9.0 the
@@ -3709,7 +3653,7 @@
contents should be reverted automatically when the guest
exits. With some hypervisors, marking a disk transient
prevents the domain from participating in migration or
- snapshots. Since 0.9.5
+ snapshots.
serial
- If present, this specify serial number of virtual hard drive.
@@ -3718,25 +3662,21 @@
Not supported for scsi-block devices, that is those using
disk
type
'block' using device
'lun'
on bus
'scsi'.
- Since 0.7.1
wwn
- If present, this element specifies the WWN (World Wide Name)
of a virtual hard disk or CD-ROM drive. It must be composed
of 16 hexadecimal digits.
- Since 0.10.1
vendor
- If present, this element specifies the vendor of a virtual hard
disk or CD-ROM device. It must not be longer than 8 printable
characters.
- Since 1.0.1
product
- If present, this element specifies the product of a virtual hard
disk or CD-ROM device. It must not be longer than 16 printable
characters.
- Since 1.0.1
address
- If present, the
address
element ties the disk
@@ -3749,11 +3689,11 @@
attributes for bus
, slot
,
and function
must be present, as well as
optional domain
and multifunction
.
- Multifunction defaults to 'off'; any other value requires
- QEMU 0.1.3 and libvirt 0.9.7. For a
+ Multifunction defaults to 'off'.
+ For a
"drive" controller, additional attributes
controller
, bus
, target
- (libvirt 0.9.11), and unit
+ and unit
are available, each defaulting to 0.
auth
@@ -3762,14 +3702,12 @@
the source
element. The element is still read and
managed as a disk
sub-element. It is invalid to use
auth
as both a sub-element of disk
- and source
. The auth
element was
- introduced as a disk
sub-element in
- libvirt 0.9.7.
+ and source
.
geometry
- The optional
geometry
element provides the
ability to override geometry settings. This mostly useful for
- S390 DASD-disks or older DOS-disks. 0.10.0<=
/span>
+ S390 DASD-disks or older DOS-disks.
cyls
- The
cyls
attribute is the
@@ -3788,7 +3726,6 @@
blockio
- If present, the
blockio
element allows
to override any of the block device properties listed below.
- Since 0.10.2 (QEMU and KVM)
logical_block_size
- The logical block size the disk will report to the guest
@@ -3810,7 +3747,6 @@
=20
A directory on the host that can be accessed directly from the guest.
- since 0.3.3, since 0.8.5 for QEMU/KVM
=20
@@ -3848,19 +3784,18 @@
mount
-
A host directory to mount in the guest. Used by LXC,
- OpenVZ (since 0.6.2)
- and QEMU/KVM (since 0.8.5).
+ OpenVZ and QEMU/KVM.
This is the default
type
if one is not specified.
This mode also has an optional
sub-element driver
, with an
attribute type=3D'path'
- or type=3D'handle'
(since
- 0.9.7). The driver block has an optional attribute
+ or type=3D'handle'
+ The driver block has an optional attribute
wrpolicy
that further controls interaction with
the host page cache; omitting the attribute gives default behavior,
while the value immediate
means that a host writeback
is immediately triggered for all pages touched during a guest file
- write operation (since 0.9.10).
+ write operation.
template
-
@@ -3876,7 +3811,6 @@
-
A host block device to mount in the guest. The filesystem
format will be autodetected. Only used by LXC driver
- (since 0.9.5).
ram
-
@@ -3885,17 +3819,17 @@
which gives the memory usage limit in KiB, unless units
are specified by the
units
attribute. Only used
by LXC driver.
- (since 0.9.13)
+
bind
-
A directory inside the guest will be bound to another
directory inside the guest. Only used by LXC driver
- (since 0.9.13)
+
=20
The filesystem block has an optional attribute accessmode
which specifies the security mode for accessing the source
- (since 0.8.5). Currently this only works
+ Currently this only works
with type=3D'mount'
for the QEMU/KVM driver. The possib=
le
values are:
=20
@@ -3934,7 +3868,6 @@
The optional driver element allows specifying further details
related to the hypervisor driver used to provide the filesystem.
- Since 1.0.6
-
If the hypervisor supports multiple backend drivers, then
@@ -3982,7 +3915,6 @@
space_hard_limit
-
Maximum space available to this guest's filesystem.
- Since 0.9.13
=20
space_soft_limit
@@ -3990,7 +3922,6 @@
Maximum space available to this guest's filesystem. The container =
is
permitted to exceed its soft limits for a grace period of time. Af=
terwards the
hard limit is enforced.
- Since 0.9.13
=20
@@ -4032,8 +3963,7 @@
the multifunction
attribute, which controls
turning on the multifunction bit for a particular
slot/function in the PCI control register
- (since 0.9.7, requires QEMU
- 0.13). multifunction
defaults to 'off',
+ multifunction
defaults to 'off',
but should be set to 'on' for function 0 of a slot that will
have multiple functions used.
(Since 4.10.0), PCI address extensions
@@ -4068,7 +3998,7 @@
A CCID address, for smart-cards, has the following
additional attributes: bus
(a 2-digit bus
number), and slot
attribute (a 2-digit slot
- within the bus). Since 0.8.8.
+ within the bus).
usb
USB addresses have the following additional
@@ -4083,8 +4013,7 @@
multiple of 0x00001000, but other addresses are valid and
permitted by libvirt. Each address has the following
additional attribute: reg
(the hex value address
- of the starting register). Since
- 0.9.9.
+ of the starting register).
ccw
S390 guests with a machine
value of
@@ -4097,7 +4026,6 @@
If omitted, libvirt will assign a free bus address with
cssid=3D0xfe and ssid=3D0. Virtio-ccw devices must have their cssid
set to 0xfe.
- Since 1.0.4
virtio-mmio
This places the device on the virtio-mmio transport, which is
@@ -4258,9 +4186,9 @@
"vt82c686b-uhci", "pci-ohci", "nec-xhci", "qusb1" (xen pvusb
with qemu backend, version 1.1), "qusb2" (xen pvusb with qemu
backend, version 2.0) or "qemu-xhci". Additionally,
- since 0.10.0, if the USB bus needs to
+ if the USB bus needs to
be explicitly disabled for the guest, model=3D'none'
- may be used. Since 1.0.5, no default
+ may be used. No default
USB controller will be built on s390.
Since 1.3.5, USB controllers accept a
ports
attribute to configure how many devices can be
@@ -4661,8 +4589,6 @@
USB, PCI and SCSI devices attached to the host can be passed through
to the guest using the hostdev
element.
- since after 0.4.4 for USB, 0.6.0 for PCI (KVM =
only)
- and 1.0.6 for SCSI (KVM only):
=20
@@ -4853,7 +4779,7 @@
or by the device's address on the host using the
address
element.
- Since 1.0.0, the source
+ The source
element of USB devices may contain startupPolicy
attribute which can be used to define policy what to do if the
specified host USB device is not found. The attribute accepts
@@ -4924,8 +4850,6 @@
boot sequence. The per-device boot
elements cannot be
used together with general boot elements in
BIOS bootloader section.
- Since 0.8.8 for PCI devices,
- Since 1.0.1 for USB devices.
rom
The rom
element is used to change how a PCI
@@ -4936,14 +4860,12 @@
presence of the Base Address Register for the ROM). If no rom
bar is specified, the qemu default will be used (older
versions of qemu used a default of "off", while newer qemus
- have a default of "on"). Since
- 0.9.7 (QEMU and KVM only). The optional
+ have a default of "on"). The optional
file
attribute contains an absolute path to a binary =
file
to be presented to the guest as the device's ROM BIOS. This
can be useful, for example, to provide a PXE boot ROM for a
virtual function of an sr-iov capable ethernet device (which
has no boot ROMs for the VFs).
- Since 0.9.10 (QEMU and KVM only).
The optional enabled
attribute can be set to
no
to disable PCI ROM loading completely for the devi=
ce;
if PCI ROM loading is disabled through this attribute, attempts to
@@ -5065,8 +4987,7 @@
=20
USB device redirection through a character device is
- supported since after 0.9.5 (KVM
- only):
+ supported:
=20
@@ -5140,7 +5061,7 @@
that can present a smartcard interface to the guest, with
several modes for describing how credentials are obtained from
the host or even a from a channel created to a third-party
- smartcard provider. Since 0.8.8
+ smartcard provider.
=20
@@ -5269,7 +5190,7 @@
hosts with dynamic / wireless networking configs (or multi-host
environments where the host hardware details are described
separately in a <network>
- definition Since 0.9.4).
+ definition).
=20
@@ -5284,8 +5205,7 @@
(<forward mode=3D'route'/>
), or connected
directly to one of the host's network interfaces (via macvtap)
or bridge devices ((<forward
- mode=3D'bridge|private|vepa|passthrough'/>
Since
- 0.9.4)
+ mode=3D'bridge|private|vepa|passthrough'/>
For networks with a forward mode of bridge, private, vepa, and
@@ -5309,7 +5229,7 @@
the network; one network may have multiple portgroups defined,
with each portgroup containing slightly different configuration
information for different classes of network
- connections. Since 0.9.4.
+ connections.
When a guest is running an interface of type network
@@ -5324,9 +5244,8 @@
(described below), a connection of type network
may
specify a virtualport
element, with configuration
data to be forwarded to a vepa (802.1Qbg) or 802.1Qbh compliant
- switch (Since 0.8.2), or to an
- Open vSwitch virtual switch (Since
- 0.9.11).
+ switch, or to an
+ Open vSwitch virtual switch.
Since the actual type of switch may vary depending on the
@@ -5341,7 +5260,7 @@
of them. The attributes from lower virtualport can't make change
on the ones defined in higher virtualport.
Interface takes the highest priority, portgroup is lowest priority.
- (Since 0.10.0). For example, in order
+ For example, in order
to work properly with both an 802.1Qbh switch and an Open vSwitch
switch, you may choose to specify no type, but both
a profileid
(in case the switch is 802.1Qbh) and
@@ -5399,8 +5318,8 @@
host bridge. On hosts that support Open vSwitch, it is also
possible to connect to an Open vSwitch bridge device by adding
a <virtualport type=3D'openvswitch'/>
to the
- interface definition. (Since
- 0.9.11). The Open vSwitch type virtualport accepts two
+ interface definition.
+ The Open vSwitch type virtualport accepts two
parameters in its <parameters>
element -
an interfaceid
which is a standard uuid used to
uniquely identify this particular interface to Open vSwitch (if
@@ -5527,9 +5446,8 @@
Provides direct attachment of the virtual machine's NIC to the given
physical interface of the host.
- Since 0.7.7 (QEMU and KVM only)
This setup requires the Linux macvtap
- driver to be available. (Since Linux 2.6.34.)<=
/span>
+ driver to be available.
One of the modes 'vepa'
(
'Virtual Ethernet Port Aggregator'), 'bridge' or 'private'
@@ -5573,8 +5491,7 @@
NIC directly to a VM without losing the migration capability.
All packets are sent to the VF/IF of the configured network device.
Depending on the capabilities of the device additional prerequisites=
or
- limitations may apply; for example, on Linux this requires
- kernel 2.6.38 or newer. Since 0.9.2
+ limitations may apply.
=20
@@ -5599,7 +5516,7 @@
in the IEEE 802.1Qbg standard. The values are network specific and
should be provided by the network administrator. In 802.1Qbg terms,
the Virtual Station Interface (VSI) represents the virtual interface
- of a virtual machine. Since 0.8.2
+ of a virtual machine.
Please note that IEEE 802.1Qbg requires a non-zero value for the
@@ -5642,7 +5559,7 @@
The interface can have additional parameters as shown below
if the switch is conforming to the IEEE 802.1Qbh standard.
The values are network specific and should be provided by the
- network administrator. Since 0.8.2
+ network administrator.
profileid
@@ -5681,8 +5598,7 @@
design - only SR-IOV (Single Root I/O Virtualization) virtual
function (VF) devices can be assigned in this manner; to assign
a standard single-port PCI or PCIe ethernet card to a guest, use
- the traditional <hostdev> device definition and
- Since 0.9.11
+ the traditional <hostdev> device definition.
=20
@@ -5705,10 +5621,7 @@
device. If these capabilities are not required, if you have a
standard single-port PCI, PCIe, or USB network card that doesn't
support SR-IOV (and hence would anyway lose the configured MAC
- address during reset after being assigned to the guest domain),
- or if you are using a version of libvirt older than 0.9.11, you
- should use standard <hostdev> to assign the device to the
- guest instead of <interface type=3D'hostdev'/>.
+ address during reset after being assigned to the guest domain).
=20
@@ -5888,7 +5801,6 @@ qemu-kvm -net nic,model=3D? /dev/null
will be rejected. If this attribute is not present, then the
domain defaults to 'vhost' if present, but silently falls back
to 'qemu' without error.
- Since 0.8.8 (QEMU and KVM only)
-
For interfaces of type=3D'hostdev' (PCI passthrough devices)
@@ -5913,7 +5825,7 @@ qemu-kvm -net nic,model=3D? /dev/null
The
txmode
attribute specifies how to handle
transmission of packets when the transmit buffer is full. The
value can be either 'iothread' or 'timer'.
- Since 0.8.8 (QEMU and KVM only)
<=
br/>
+
=20
If set to 'iothread', packet tx is all done in an iothread in
the bottom half of the driver (this option translates into
@@ -5945,7 +5857,7 @@ qemu-kvm -net nic,model=3D? /dev/null
Typically guests experiencing high system CPU utilization
during I/O will benefit from this. On the other hand,
on overloaded host it could increase guest I/O latency.
- Since 0.9.3 (QEMU and KVM only)
<=
br/>
+
=20
In general you should leave this option alone, unless you
are very certain you know what you are doing.
@@ -6132,7 +6044,6 @@ qemu-kvm -net nic,model=3D? /dev/null
per-device boot
elements cannot be used together with
general boot elements in
BIOS bootloader section.
- Since 0.8.8
=20
Interface ROM BIOS configuration
@@ -6162,7 +6073,6 @@ qemu-kvm -net nic,model=3D? /dev/null
binary file to be presented to the guest as the device's ROM
BIOS. This can be useful to provide an alternative boot ROM for a
network device.
- Since 0.9.10 (QEMU and KVM only).
Setting up a network backend in a driver d=
omain
@@ -6241,12 +6151,12 @@ qemu-kvm -net nic,model=3D? /dev/null
supports VLAN tagging transparent to the guest, an
optional <vlan>
element can specify one or
more VLAN tags to apply to the guest's network
- traffic Since 0.10.0. Network
+ traffic. Network
connections that support guest-transparent VLAN tagging include
1) type=3D'bridge' interfaces connected to an Open vSwitch bridge
- Since 0.10.0, 2) SRIOV Virtual
+ , 2) SRIOV Virtual
Functions (VF) used via type=3D'hostdev' (direct device
- assignment) Since 0.10.0, and 3)
+ assignment), and 3)
SRIOV VFs used via type=3D'direct' with mode=3D'passthrough'
(macvtap "passthru" mode) Since
1.3.5. All other connection types, including standard
@@ -6298,7 +6208,6 @@ qemu-kvm -net nic,model=3D? /dev/null
down
. If down
is specified as the value, t=
he interface
behaves as if it had the network cable disconnected. Default behavio=
r if this
element is unspecified is to have the link state up
.
- Since 0.9.5
=20
MTU configuration
@@ -6475,7 +6384,7 @@ qemu-kvm -net nic,model=3D? /dev/null
Traffic filtering with NWFilter
=20
- Since 0.8.0 an nwfilter
prof=
ile
+ An nwfilter
profile
can be assigned to a domain interface, which allows configuring
traffic filter rules for the virtual machine.
=20
@@ -6669,7 +6578,7 @@ qemu-kvm -net nic,model=3D? /dev/null
a timestamp passwdValidTo=3D'2010-04-09T15:51:00'
assumed to be in UTC. The connected
attribute a=
llows
control of connected client during password changes. VNC acc=
epts
- keep
value only since 0.9=
.3.
+ the keep
value.
NB, this may not be supported by all hypervisors.
@@ -6686,7 +6595,6 @@ qemu-kvm -net nic,model=3D? /dev/null
Rather than using listen/port, QEMU supports a socket<=
/code>
attribute for listening on a unix domain socket path
- Since 0.8.8.
For VNC WebSocket functionality, websocket
attr=
ibute
@@ -6700,7 +6608,7 @@ qemu-kvm -net nic,model=3D? /dev/null
will instruct QEMU to open and use drm nodes for OpenGL rend=
ering.
- spice
Since 0.8.6<=
/dt>
+ spice
-
Starts a SPICE server. The port
attribute speci=
fies
@@ -6723,7 +6631,6 @@ qemu-kvm -net nic,model=3D? /dev/null
keep client connected, disconnect
to disconnect=
client
and fail
to fail changing password . NB, this m=
ay not
be supported by all hypervisors.
- Since 0.9.3
The defaultMode
attribute sets the default chan=
nel
@@ -6731,7 +6638,6 @@ qemu-kvm -net nic,model=3D? /dev/null
insecure
and the default any
(whic=
h is
secure if possible, but falls back to insecure rather than e=
rroring
out if no secure path is available).
- Since 0.9.12
When SPICE has both a normal and TLS secured TCP port config=
ured,
@@ -6745,10 +6651,8 @@ qemu-kvm -net nic,model=3D? /dev/null
any
as mode discards the entry as the channel w=
ould
inherit the default mode anyways.) Valid channel names inclu=
de
main
, display
, inputs
,
- cursor
, playback
, record
- (all since 0.8.6);
- smartcard
(since 0.8.8);
- and usbredir
(since 0.9.1=
2).
+ cursor
, playback
, record,
+ smartcard
and usbredir
.
<graphics type=3D'spice' port=3D'-1' tlsPort=3D'-1' autoport=3D'yes'>
@@ -6773,25 +6677,24 @@ qemu-kvm -net nic,model=3D? /dev/null
configuring wan image compression (accepts auto
,
never
, always
) and playback=
for enabling audio stream compression (accepts on or
- off
). Since 0.9.1
+ off
).
Streaming mode is set by the streaming
element,
settings its mode
attribute to one of
filter
, all
or off
.
- Since 0.9.2
Copy & Paste functionality (via Spice agent) is set by t=
he
clipboard
element. It is enabled by default, an=
d can
be disabled by setting the copypaste
property to
- no
. Since 0.9.3
+ no
.
Mouse mode is set by the mouse
element, setting=
its
mode
attribute to one of server
or
client
. If no mode is specified, the qemu defau=
lt will
- be used (client mode). Since 0.9.11
+ be used (client mode).
File transfer functionality (via Spice agent) is set using t=
he
@@ -6878,7 +6781,7 @@ qemu-kvm -net nic,model=3D? /dev/null
the device should listen for clients. It has a mandatory attribute
type
which specifies the listen type. Only vnc,
spice
and rdp
supports <listen>
-
element. Since 0.9.4.
+
element.
Available types are:
@@ -6990,7 +6893,7 @@ qemu-kvm -net nic,model=3D? /dev/null
The model
element has a mandatory type
attribute which takes the value "vga", "cirrus", "vmvga", "xen",
- "vbox", "qxl" (since 0.8.6),
+ "vbox", "qxl",
"virtio" (since 1.3.0),
"gop" (since 3.2.0),
"none" (since 4.6.0, or "bochs"
@@ -7036,12 +6939,10 @@ qemu-kvm -net nic,model=3D? /dev/null
Configure if video acceleration should be enabled.
accel2d
- - Enable 2D acceleration (for vbox driver only,
- since 0.7.1)
+ - Enable 2D acceleration (for vbox driver only)
=20
accel3d
- - Enable 3D acceleration (for vbox driver
- since 0.7.1, qemu driver
+
- Enable 3D acceleration (for vbox driver, qemu driver
since 1.3.0)
@@ -7227,7 +7128,7 @@ qemu-kvm -net nic,model=3D? /dev/null
The target
element can have an optional port
attribute, which specifies the port number (starting from 0), and an
optional type
attribute: valid values are,
- since 1.0.2, isa-serial
(u=
sable
+ isa-serial
(usable
with x86 guests), usb-serial
(usable whenever USB suppo=
rt
is available) and pci-serial
(usable whenever PCI suppo=
rt
is available); since 3.10.0,
@@ -7473,7 +7374,7 @@ qemu-kvm -net nic,model=3D? /dev/null
- TCP traffic sent by the guest to a given IP address and port is
forwarded to the channel device on the host. The
target
element must have address
and port
attri=
butes.
- Since 0.7.3
+
=20
virtio
- Paravirtualized virtio channel. Channel is exposed in the guest =
under
@@ -7486,9 +7387,7 @@ qemu-kvm -net nic,model=3D? /dev/null
With qemu, if
name
is "org.qemu.guest_agent.0",
then libvirt can interact with a guest agent installed in the
guest, for actions such as guest shutdown or file system quiescing.
- Since 0.7.7, guest agent interaction
- since 0.9.10 Moreover, since 1.0.6
- it is possible to have source path auto generated for virtio unix =
channels.
+ It is possible to have source path auto generated for virtio unix =
channels.
This is very useful in case of a qemu guest agent, where users don=
't
usually care about the source path since it's libvirt who talks to
the guest agent. In case users want to utilize this feature, they =
should
@@ -7521,7 +7420,7 @@ qemu-kvm -net nic,model=3D? /dev/null
to name=3D'com.redhat.spice.0'
. The
optional address
element can tie the channel to a
particular type=3D'virtio-serial'
controller.
- Since 0.8.8
+
=20
Host interface
@@ -7699,7 +7598,7 @@ qemu-kvm -net nic,model=3D? /dev/null
for the connection.
- Since 0.8.5, some hypervisors support
+ Some hypervisors support the
use of either telnets
(secure telnet) or tls
(via secure sockets layer) as the transport protocol for connections.
@@ -7842,7 +7741,7 @@ qemu-kvm -net nic,model=3D? /dev/null
=20
A virtual sound card can be attached to the host via the
- sound
element. Since 0.4.3
+ sound
element.
=20
@@ -7859,14 +7758,12 @@ qemu-kvm -net nic,model=3D? /dev/null
model
, which specifies what real sound device is emul=
ated.
Valid values are specific to the underlying hypervisor, though typ=
ical
choices are 'es1370', 'sb16', 'ac97', 'ich6' and 'usb'.
- (
- 'ac97' only since 0.6.0, 'ich6' only since 0.8.8,
- 'usb' only since 1.2.7)
+ ('usb' only since 1.2.7)
=20
- Since 0.9.13, a sound element
+ A sound element
with ich6
model can have optional
sub-elements <codec>
to attach various audio
codecs to the audio device. If not specified, a default codec
@@ -7905,7 +7802,6 @@ qemu-kvm -net nic,model=3D? /dev/null
A virtual hardware watchdog device can be added to the guest via
the watchdog
element.
- Since 0.7.3, QEMU and KVM only
=20
@@ -7998,8 +7894,7 @@ qemu-kvm -net nic,model=3D? /dev/null
It will be automatically added when appropriate, so there is no
need to explicitly add this element in the guest XML unless a
specific PCI slot needs to be assigned.
- Since 0.8.3, Xen, QEMU and KVM only
- Additionally, since 0.8.4, if the
+ If the
memballoon device needs to be explicitly disabled,
model=3D'none'
may be used.
@@ -8069,7 +7964,6 @@ qemu-kvm -net nic,model=3D? /dev/null
for a running domain will only be made to the active guest. If =
the
QEMU driver is not at the right revision, the attempt to set the
period will fail. Large values (e.g. many years) might be ignor=
ed.
- Since 1.1.1, requires QEMU 1.5
driver
@@ -8084,7 +7978,6 @@ qemu-kvm -net nic,model=3D? /dev/null
The virtual random number generator device allows the host to pass
through entropy to guest operating systems.
- Since 1.0.3
=20
@@ -8130,7 +8023,6 @@ qemu-kvm -net nic,model=3D? /dev/null
to be consumed per period. An optional period
attr=
ibute
specifies the duration of a period in milliseconds; if omitted, =
the
period is taken as 1000 milliseconds (1 second).
- Since 1.0.4
backend
@@ -8192,7 +8084,6 @@ qemu-kvm -net nic,model=3D? /dev/null
The TPM passthrough device type provides access to the host's TPM
for one QEMU guest. No other software may be using the TPM device,
typically /dev/tpm0, at the time the QEMU guest is started.
- 'passthrough' since 1.0.5
=20
@@ -8292,7 +8183,7 @@ qemu-kvm -net nic,model=3D? /dev/null
nvram device is always added to pSeries guest on PPC64, and its addr=
ess
is allowed to be changed. Element nvram
(only valid for
- pSeries guest, since 1.0.5) is provided=
to
+ pSeries guest) is provided to
enable the address setting.
@@ -8784,8 +8675,7 @@ qemu-kvm -net nic,model=3D? /dev/null
With static label assignment, by default, the administrator
or application must ensure labels are set correctly on any
resources, however, automatic relabeling can be enabled
- if desired. 'dynamic' since 0.6.1, 'static'
- since 0.6.2, and 'none' since 0.9.10.
+ if desired.
=20
@@ -8888,7 +8778,7 @@ qemu-kvm -net nic,model=3D? /dev/null
file system that lacks security labeling) or requesting an
alternate label (useful when a management application creates a
special label to allow sharing of some, but not all, resources
- between domains), since 0.9.9. When
+ between domains). When
a seclabel
element is attached to a specific path
rather than the top-level domain assignment, only the
attribute relabel
or the
--=20
2.20.1
--
libvir-list mailing list
libvir-list@redhat.com
https://www.redhat.com/mailman/listinfo/libvir-list