Skip to content

L
libvirt

openeuler / libvirt

通知 3
Star 0
Fork 0
L
libvirt

体验新版 GitCode，发现更多精彩内容 >>

切换分支/标签
查找文件 普通视图历史永久链接Permalink
formatdomain.html.in 47.1 KB
Newer Older
D
Split website out into one file per page. APply new layout and styling  
Daniel P. Berrange 已提交
1 2 3 4 
<html>
  <body>
    <h1>Domain XML format</h1>
D
Update domain XML docs  
Daniel P. Berrange 已提交
5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 
    <ul id="toc"></ul>

    <p>
      This section describes the XML format used to represent domains, there are
      variations on the format based on the kind of domains run and the options
      used to launch them. For hypervisor specific details consult the
      <a href="drivers.html">driver docs</a>
    </p>


    <h2><a name="elements">Element and attribute overview</a></h2>

    <p>
      The root element required for all virtual machines is
      named <code>domain</code>. It has two attributes, the
      <code>type</code> specifies the hypervisor used for running
      the domain. The allowed values are driver specific, but
      include "xen", "kvm", "qemu", "lxc" and "kqemu". The
      second attribute is <code>id</code> which is a unique
      integer identifier for the running guest machine. Inactive
      machines have no id value.
    </p>


    <h3><a name="elementsMetadata">General metadata</a></h3>

    <pre>
      &lt;domain type='xen' id='3'&gt;
        &lt;name&gt;fv0&lt;/name&gt;
        &lt;uuid&gt;4dea22b31d52d8f32516782e98ab3fa0&lt;/uuid&gt;
        ...</pre>

    <dl>
      <dt><code>name</code></dt>
      <dd>The content of the <code>name</code> element provides
M
Cleanup whitespace in docs  
Matthew Booth 已提交
40 41 42 43 44 
        a short name for the virtual machine. This name should
        consist only of alpha-numeric characters and is required
        to be unique within the scope of a single host. It is
        often used to form the filename for storing the persistent
        configuration file. <span class="since">Since 0.0.1</span></dd>
D
Update domain XML docs  
Daniel P. Berrange 已提交
45 46 
      <dt><code>uuid</code></dt>
      <dd>The content of the <code>uuid</code> element provides
M
Cleanup whitespace in docs  
Matthew Booth 已提交
47 48 49 50 
        a globally unique identifier for the virtual machine.
        The format must be RFC 4122 compliant, eg <code>3e3fce45-4f53-4fa7-bb32-11f34168b82b</code>.
        If omitted when defining/creating a new machine, a random
        UUID is generated. <span class="since">Since 0.0.1</span></dd>
D
Update domain XML docs  
Daniel P. Berrange 已提交
51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 
    </dl>

    <h3><a name="elementsOS">Operating system booting</a></h3>

    <p>
      There are a number of different ways to boot virtual machines
      each with their own pros and cons.
    </p>

    <h4><a name="elementsOSBIOS">BIOS bootloader</a></h4>

    <p>
      Booting via the BIOS is available for hypervisors supporting
      full virtualization. In this case the BIOS has a boot order
      priority (floppy, harddisk, cdrom, network) determining where
      to obtain/find the boot image.
    </p>

    <pre>
        ...
        &lt;os&gt;
          &lt;type&gt;hvm&lt;/type&gt;
          &lt;loader&gt;/usr/lib/xen/boot/hvmloader&lt;/loader&gt;
          &lt;boot dev='hd'/&gt;
        &lt;/os&gt;
        ...</pre>

    <dl>
      <dt><code>type</code></dt>
      <dd>The content of the <code>type</code> element specifies the
M
Cleanup whitespace in docs  
Matthew Booth 已提交
81 82 83 84 85 86 87 88 
        type of operating system to be booted in the virtual machine.
        <code>hvm</code> indicates that the OS is one designed to run
        on bare metal, so requires full virtualization. <code>linux</code>
        (badly named!) refers to an OS that supports the Xen 3 hypervisor
        guest ABI. There are also two optional attributes, <code>arch</code>
        specifying the CPU architecture to virtualization, and <code>machine</code>
        referring to the machine type. The <a href="formatcaps.html">Capabilities XML</a>
        provides details on allowed values for these. <span class="since">Since 0.0.1</span></dd>
D
Update domain XML docs  
Daniel P. Berrange 已提交
89 90 
      <dt><code>loader</code></dt>
      <dd>The optional <code>loader</code> tag refers to a firmware blob
M
Cleanup whitespace in docs  
Matthew Booth 已提交
91 92 
        used to assist the domain creation process. At this time, it is
        only needed by Xen fully virtualized domains. <span class="since">Since 0.1.0</span></dd>
D
Update domain XML docs  
Daniel P. Berrange 已提交
93 94 
      <dt><code>boot</code></dt>
      <dd>The <code>dev</code> attribute takes one of the values "fd", "hd",
M
Cleanup whitespace in docs  
Matthew Booth 已提交
95 96 97 98 
        "cdrom" or "network" and is used to specify the next boot device
        to consider. The <code>boot</code> element can be repeated multiple
        times to setup a priority list of boot devices to try in turn.
        <span class="since">Since 0.1.3</span>
D
Update domain XML docs  
Daniel P. Berrange 已提交
99 100 101 102 103 104 105 106 
      </dd>
    </dl>

    <h4><a name="elementsOSBootloader">Host bootloader</a></h4>

    <p>
      Hypervisors employing paravirtualization do not usually emulate
      a BIOS, and instead the host is responsible to kicking off the
A
fix typos in docs  
Atsushi SAKAI 已提交
107 
      operating system boot. This may use a pseudo-bootloader in the
D
Update domain XML docs  
Daniel P. Berrange 已提交
108 109 110 111 112 113 
      host to provide an interface to choose a kernel for the guest.
      An example is <code>pygrub</code> with Xen.
    </p>

    <pre>
        ...
M
Cleanup whitespace in docs  
Matthew Booth 已提交
114 115 
        &lt;bootloader&gt;/usr/bin/pygrub&lt;/bootloader&gt;
        &lt;bootloader_args&gt;--append single&lt;/bootloader_args&gt;
D
Update domain XML docs  
Daniel P. Berrange 已提交
116 117 118 119 120 
        ...</pre>

    <dl>
      <dt><code>bootloader</code></dt>
      <dd>The content of the <code>bootloader</code> element provides
M
Cleanup whitespace in docs  
Matthew Booth 已提交
121 122 123 124 
        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. <span class="since">Since 0.1.0</span></dd>
D
Update domain XML docs  
Daniel P. Berrange 已提交
125 126 
      <dt><code>bootloader_args</code></dt>
      <dd>The optional <code>bootloader_args</code> element allows
M
Cleanup whitespace in docs  
Matthew Booth 已提交
127 128 129 
        command line arguments to be passed to the bootloader.
        <span class="since">Since 0.2.3</span>
        </dd>
D
Update domain XML docs  
Daniel P. Berrange 已提交
130 131 132 133 134 135 136 137 138 139 140 141 142 143 

    </dl>

    <h4><a name="elementsOSKernel">Direct kernel boot</a></h4>

    <p>
      When installing a new guest OS it is often useful to boot directly
      from a kernel and initrd stored in the host OS, allowing command
      line arguments to be passed directly to the installer. This capability
      is usually available for both para and full virtualized guests.
    </p>

    <pre>
        ...
M
Cleanup whitespace in docs  
Matthew Booth 已提交
144 
        &lt;os&gt;
D
Update domain XML docs  
Daniel P. Berrange 已提交
145 146 147 148 149 
          &lt;type&gt;hvm&lt;/type&gt;
          &lt;loader&gt;/usr/lib/xen/boot/hvmloader&lt;/loader&gt;
          &lt;kernel&gt;/root/f8-i386-vmlinuz&lt;/kernel&gt;
          &lt;initrd&gt;/root/f8-i386-initrd&lt;/initrd&gt;
          &lt;cmdline&gt;console=ttyS0 ks=http://example.com/f8-i386/os/&lt;/cmdline&gt;
M
Cleanup whitespace in docs  
Matthew Booth 已提交
150 151 
        &lt;/os&gt;
        ...</pre>
D
Update domain XML docs  
Daniel P. Berrange 已提交
152 153 154 155 

    <dl>
      <dt><code>type</code></dt>
      <dd>This element has the same semantics as described earlier in the
M
Cleanup whitespace in docs  
Matthew Booth 已提交
156 
        <a href="#elementsOSBIOS">BIOS boot section</a></dd>
D
"copy-paste" errors  
Daniel Veillard 已提交
157 
      <dt><code>loader</code></dt>
D
Update domain XML docs  
Daniel P. Berrange 已提交
158 
      <dd>This element has the same semantics as described earlier in the
M
Cleanup whitespace in docs  
Matthew Booth 已提交
159 
        <a href="#elementsOSBIOS">BIOS boot section</a></dd>
D
Update domain XML docs  
Daniel P. Berrange 已提交
160 161 
      <dt><code>kernel</code></dt>
      <dd>The contents of this element specify the fully-qualified path
M
Cleanup whitespace in docs  
Matthew Booth 已提交
162 
        to the kernel image in the host OS.</dd>
D
Update domain XML docs  
Daniel P. Berrange 已提交
163 164 
      <dt><code>initrd</code></dt>
      <dd>The contents of this element specify the fully-qualified path
M
Cleanup whitespace in docs  
Matthew Booth 已提交
165 
        to the (optional) ramdisk image in the host OS.</dd>
D
Update domain XML docs  
Daniel P. Berrange 已提交
166 167 
      <dt><code>cmdline</code></dt>
      <dd>The contents of this element specify arguments to be passed to
M
Cleanup whitespace in docs  
Matthew Booth 已提交
168 169 170 
        the kernel (or installer) at boottime. This is often used to
        specify an alternate primary console (eg serial port), or the
        installation media source / kickstart file</dd>
D
Update domain XML docs  
Daniel P. Berrange 已提交
171 172 173 174 175 176 
    </dl>

    <h3><a name="elementsResources">Basic resources</a></h3>

    <pre>
        ...
M
Cleanup whitespace in docs  
Matthew Booth 已提交
177 178 179 180 
        &lt;memory&gt;524288&lt;/memory&gt;
        &lt;currentMemory&gt;524288&lt;/currentMemory&gt;
        &lt;memoryBacking&gt;
          &lt;hugepages/&gt;
D
Support configuration of huge pages in guests  
Daniel P. Berrange 已提交
181 
        &lt;/memoryBacking&gt;
M
Cleanup whitespace in docs  
Matthew Booth 已提交
182 183 
        &lt;vcpu&gt;1&lt;/vcpu&gt;
        ...</pre>
D
Update domain XML docs  
Daniel P. Berrange 已提交
184 185 186 187 

    <dl>
      <dt><code>memory</code></dt>
      <dd>The maximum allocation of memory for the guest at boot time.
M
Cleanup whitespace in docs  
Matthew Booth 已提交
188 
        The units for this value are kilobytes (i.e. blocks of 1024 bytes)</dd>
D
Update domain XML docs  
Daniel P. Berrange 已提交
189 190 
      <dt><code>currentMemory</code></dt>
      <dd>The actual allocation of memory for the guest. This value
M
Cleanup whitespace in docs  
Matthew Booth 已提交
191 192 193 
        be less than the maximum allocation, to allow for ballooning
        up the guests memory on the fly. If this is omitted, it defaults
        to the same value as the <code>memory<code> element</dd>
D
Support configuration of huge pages in guests  
Daniel P. Berrange 已提交
194 195 
      <dt><code>memoryBacking</code></dt>
      <dd>The optional <code>memoryBacking</code> element, may have an
M
Cleanup whitespace in docs  
Matthew Booth 已提交
196 197 198 
        <code>hugepages</code> element set within it. This tells the
        hypervisor that the guest should have its memory allocated using
        hugepages instead of the normal native page size.</dd>
D
Update domain XML docs  
Daniel P. Berrange 已提交
199 200 
      <dt><code>vcpu</code></dt>
      <dd>The content of this element defines the number of virtual
M
Cleanup whitespace in docs  
Matthew Booth 已提交
201 
        CPUs allocated for the guest OS.</dd>
D
Update domain XML docs  
Daniel P. Berrange 已提交
202 203 
    </dl>
J
Document <cpu> elements in capabilities and domain XML  
Jiri Denemark 已提交
204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 
    <h3><a name="elementsCPU">CPU model and topology</a></h3>

    <p>
      Requirements for CPU model, its features and topology can be specified
      using the following collection of elements.
      <span class="since">Since 0.7.5</span>
    </p>

    <pre>
        ...
        &lt;cpu match='exact'&gt;
          &lt;model&gt;core2duo&lt;/model&gt;
          &lt;topology sockets='1' cores='2' threads='1'/&gt;
          &lt;feature policy='disable' name='lahf_lm'/&gt;
        &lt;/cpu&gt;
        ...</pre>

    <p>
      In case no restrictions need to be put on CPU model and its features, a
      simpler <code>cpu</code> element can be used.
      <span class="since">Since 0.7.6</span>
    </p>

    <pre>
        ...
        &lt;cpu&gt;
          &lt;topology sockets='1' cores='2' threads='1'/&gt;
        &lt;/cpu&gt;
        ...</pre>

    <dl>
      <dt><code>cpu</code></dt>
      <dd>The <code>cpu</code> element is the main container for describing
        guest CPU requirements. Its <code>match</code> attribute specified how
        strictly has the virtual CPU provided to the guest match these
        requirements. <span class="since">Since 0.7.6</span> the
        <code>match</code> attribute can be omitted if <code>topology</code>
        is the only element within <code>cpu</code>. Possible values for the
        <code>match</code> attribute are:

        <dl>
          <dt><code>minimum</code></dt>
          <dd>The specified CPU model and features describes the minimum
            requested CPU.</dd>
          <dt><code>exact</code></dt>
          <dd>The virtual CPU provided to the guest will exactly match the
            specification</dd>
          <dt><code>strict</code></dt>
          <dd>The guest will not be created unless the host CPU does exactly
            match the specification.</dd>
        </dl>
      </dd>

      <dt><code>model</code></dt>
      <dd>The content of the <code>model</code> element specifies CPU model
        requested by the guest. The list of available CPU models and their
        definition can be found in <code>cpu_map.xml</code> file installed
        in libvirt's data directory.</dd>

      <dt><code>topology</code></dt>
      <dd>The <code>topology</code> element specifies requested topology of
        virtual CPU provided to the guest. Three non-zero values have to be
        given for <code>sockets</code>, <code>cores</code>, and
        <code>threads</code>: total number of CPU sockets, number of cores per
        socket, and number of threads per core, respectively.</dd>

      <dt><code>feature</code></dt>
      <dd>The <code>cpu</code> element can contain zero or more
        <code>elements</code> used to fine-tune features provided by the
        selected CPU model. The list of known feature names can be found in
        the same file as CPU models. The meaning of each <code>feature</code>
        element depends on its <code>policy</code> attribute, which has to be
        set to one of the following values:

        <dl>
          <dt><code>force</code></dt>
          <dd>The virtual CPU will claim the feature is supported regardless
            of it being supported by host CPU.</dd>
          <dt><code>require</code></dt>
          <dd>Guest creation will fail unless the feature is supported by host
            CPU.</dd>
          <dt><code>optional</code></dt>
          <dd>The feature will be supported by virtual CPU if and only if it
            is supported by host CPU.</dd>
          <dt><code>disable</code></dt>
          <dd>The feature will not be supported by virtual CPU.</dd>
          <dt><code>forbid</code></dt>
          <dd>Guest creation will fail if the feature is supported by host
            CPU.</dd>
        </dl>
      </dd>
    </dl>
D
Update domain XML docs  
Daniel P. Berrange 已提交
297 298 299 
    <h3><a name="elementsLifecycle">Lifecycle control</a></h3>

    <p>
A
fix typos in docs  
Atsushi SAKAI 已提交
300 
      It is sometimes necessary to override the default actions taken
D
Update domain XML docs  
Daniel P. Berrange 已提交
301 302 303 304 305 306 307 308 309 
      when a guest OS triggers a lifecycle operation. The following
      collections of elements allow the actions to be specified. A
      common use case is to force a reboot to be treated as a poweroff
      when doing the initial OS installation. This allows the VM to be
      re-configured for the first post-install bootup.
    </p>

    <pre>
        ...
M
Cleanup whitespace in docs  
Matthew Booth 已提交
310 311 312 313 
        &lt;on_poweroff&gt;destroy&lt;/on_poweroff&gt;
        &lt;on_reboot&gt;restart&lt;/on_reboot&gt;
        &lt;on_crash&gt;restart&lt;/on_crash&gt;
        ...</pre>
D
Update domain XML docs  
Daniel P. Berrange 已提交
314 315 316 317 

    <dl>
      <dt><code>on_poweroff</code></dt>
      <dd>The content of this element specifies the action to take when
M
Cleanup whitespace in docs  
Matthew Booth 已提交
318 
        the guest requests a poweroff.</dd>
D
"copy-paste" errors  
Daniel Veillard 已提交
319 
      <dt><code>on_reboot</code></dt>
D
Update domain XML docs  
Daniel P. Berrange 已提交
320 
      <dd>The content of this element specifies the action to take when
M
Cleanup whitespace in docs  
Matthew Booth 已提交
321 
        the guest requests a reboot.</dd>
D
"copy-paste" errors  
Daniel Veillard 已提交
322 
      <dt><code>on_crash</code></dt>
D
Update domain XML docs  
Daniel P. Berrange 已提交
323 
      <dd>The content of this element specifies the action to take when
M
Cleanup whitespace in docs  
Matthew Booth 已提交
324 
        the guest crashes.</dd>
D
Update domain XML docs  
Daniel P. Berrange 已提交
325 326 327 328 329 330 331 332 333 
    </dl>

    <p>
      Each of these states allow for the same four possible actions.
    </p>

    <dl>
      <dt><code>destroy</code></dt>
      <dd>The domain will be terminated completely and all resources
M
Cleanup whitespace in docs  
Matthew Booth 已提交
334 
        released</dd>
D
Update domain XML docs  
Daniel P. Berrange 已提交
335 336 
      <dt><code>restart</code></dt>
      <dd>The domain will be terminated, and then restarted with
M
Cleanup whitespace in docs  
Matthew Booth 已提交
337 
        the same configuration</dd>
D
Update domain XML docs  
Daniel P. Berrange 已提交
338 339 
      <dt><code>preserve</code></dt>
      <dd>The domain will be terminated, and its resource preserved
M
Cleanup whitespace in docs  
Matthew Booth 已提交
340 
        to allow analysis.</dd>
D
Update domain XML docs  
Daniel P. Berrange 已提交
341 342 
      <dt><code>rename-restart</code></dt>
      <dd>The domain will be terminated, and then restarted with
M
Cleanup whitespace in docs  
Matthew Booth 已提交
343 
        a new name</dd>
D
Update domain XML docs  
Daniel P. Berrange 已提交
344 345 346 347 348 349 350 351 352 353 354 
    </dl>

    <h3><a name="elementsFeatures">Hypervisor features</a></h3>

    <p>
      Hypervisors may allow certain CPU / machine features to be
      toggled on/off.
    </p>

    <pre>
        ...
M
Cleanup whitespace in docs  
Matthew Booth 已提交
355 356 357 358 359 360 
        &lt;features&gt;
          &lt;pae/&gt;
          &lt;acpi/&gt;
          &lt;apic/&gt;
        &lt;/features&gt;
        ...</pre>
D
Update domain XML docs  
Daniel P. Berrange 已提交
361 362 363 364 365 366 367 368 369 370 371 372 

    <p>
      All features are listed within the <code>features</code>
      element, omitting a togglable feature tag turns it off.
      The available features can be found by asking
      for the <a href="formatcaps.html">capabilities XML</a>,
      but a common set for fully virtualized domains are:
    </p>

    <dl>
      <dt><code>pae</code></dt>
      <dd>Physical address extension mode allows 32-bit guests
M
Cleanup whitespace in docs  
Matthew Booth 已提交
373 
        to address more than 4 GB of memory.</dd>
D
Update domain XML docs  
Daniel P. Berrange 已提交
374 375 
      <dt><code>acpi</code></dt>
      <dd>ACPI is useful for power management, for example, with
M
Cleanup whitespace in docs  
Matthew Booth 已提交
376 
        KVM guests it is required for graceful shutdown to work.
D
Update domain XML docs  
Daniel P. Berrange 已提交
377 378 379 380 381 382 383 384 385 386 387 388 389 390 
      </dd>
    </dl>

    <h3><a name="elementsTime">Time keeping</a></h3>

    <p>
      The guest clock is typically initialized from the host clock.
      Most operating systems expect the hardware clock to be kept
      in UTC, and this is the default. Windows, however, expects
      it to be in so called 'localtime'.
    </p>

    <pre>
        ...
J
doc: fix typo in formatdomain's clock offset specification  
Jim Meyering 已提交
391 
        &lt;clock offset="localtime"/&gt;
M
Cleanup whitespace in docs  
Matthew Booth 已提交
392 
        ...</pre>
D
Update domain XML docs  
Daniel P. Berrange 已提交
393 394 395 

    <dl>
      <dt><code>clock</code></dt>
C
docs: <clock> property is 'offset', not 'sync'  
Cole Robinson 已提交
396 
      <dd>The <code>offset</code> attribute takes either "utc" or
M
Cleanup whitespace in docs  
Matthew Booth 已提交
397 398 
        "localtime" to specify how the guest clock is initialized
        in relation to the host OS.
D
Update domain XML docs  
Daniel P. Berrange 已提交
399 400 401 402 403 404 
      </dd>
    </dl>

    <h3><a name="elementsDevices">Devices</a></h3>

    <p>
A
fix typos in docs  
Atsushi SAKAI 已提交
405 
      The final set of XML elements are all used to describe devices
D
Update domain XML docs  
Daniel P. Berrange 已提交
406 407 408 409 410 411 412 413 
      provided to the guest domain. All devices occur as children
      of the main <code>devices</code> element.
      <span class="since">Since 0.1.3</span>
    </p>

    <pre>
        ...
        &lt;devices&gt;
M
Cleanup whitespace in docs  
Matthew Booth 已提交
414 
          &lt;emulator&gt;/usr/lib/xen/bin/qemu-dm&lt;/emulator&gt;
D
Update domain XML docs  
Daniel P. Berrange 已提交
415 416 417 418 419 
          ...</pre>

    <dl>
      <dt><code>emulator</code></dt>
      <dd>
M
Cleanup whitespace in docs  
Matthew Booth 已提交
420 421 422 423 424 
        The contents of the <code>emulator</code> element specify
        the fully qualified path to the device model emulator binary.
        The <a href="formatcaps.html">capabilities XML</a> specifies
        the recommended default emulator to use for each particular
        domain type / architecture combination.
D
Update domain XML docs  
Daniel P. Berrange 已提交
425 426 427 428 429 430 431 432 433 434 435 436 437 
      </dd>
    </dl>

    <h4><a name="elementsDisks">Hard drives, floppy disks, CDROMs</a></h4>

    <p>
      Any device that looks like a disk, be it a floppy, harddisk,
      cdrom, or paravirtualized driver is specified via the <code>disk</code>
      element.
    </p>

    <pre>
          ...
M
Cleanup whitespace in docs  
Matthew Booth 已提交
438 
          &lt;disk type='file'&gt;
M
Document the domain XML cache attribute for disk devices  
Matthias Bolte 已提交
439 
            &lt;driver name="tap" type="aio" cache="default"&gt;
M
Cleanup whitespace in docs  
Matthew Booth 已提交
440 441 
            &lt;source file='/var/lib/xen/images/fv0'/&gt;
            &lt;target dev='hda' bus='ide'/&gt;
M
Attach encryption information to virDomainDiskDef.  
Miloslav Trmač 已提交
442 443 444 
            &lt;encryption type='...'&gt;
              ...
            &lt;/encryption&gt;
D
add missing doc for device <shareable/> option  
Daniel Veillard 已提交
445 
            &lt;shareable/&gt;
M
Cleanup whitespace in docs  
Matthew Booth 已提交
446 447 
          &lt;/disk&gt;
          ...</pre>
D
Update domain XML docs  
Daniel P. Berrange 已提交
448 449 450 451 

    <dl>
      <dt><code>disk</code></dt>
      <dd>The <code>disk</code> element is the main container for describing
M
Cleanup whitespace in docs  
Matthew Booth 已提交
452 453 454 455 456 457 
        disks. The <code>type</code> attribute is either "file" or "block"
        and refers to the underlying source for the disk. The optional
        <code>device</code> attribute indicates how the disk is to be exposed
        to the guest OS. Possible values for this attribute are "floppy", "disk"
        and "cdrom", defaulting to "disk".
        <span class="since">Since 0.0.3; "device" attribute since 0.1.4</span></dd>
D
Update domain XML docs  
Daniel P. Berrange 已提交
458 459 
      <dt><code>source</code></dt>
      <dd>If the disk <code>type</code> is "file", then the <code>file</code> attribute
M
Cleanup whitespace in docs  
Matthew Booth 已提交
460 461 462 
        specifies the fully-qualified path to the file holding the disk. If the disk
        <code>type</code> is "block", then the <code>dev</code> attribute specifies
        the path to the host device to serve as the disk. <span class="since">Since 0.0.3</span></dd>
D
Update domain XML docs  
Daniel P. Berrange 已提交
463 464 
      <dt><code>target</code></dt>
      <dd>The <code>target</code> element controls the bus / device under which the
M
Cleanup whitespace in docs  
Matthew Booth 已提交
465 466 467 468 469 470 471 472 473 
        disk is exposed to the guest OS. The <code>dev</code> attribute indicates
        the "logical" device name. The actual device name specified is not guaranteed to map to
        the device name in the guest OS. Treat it as a device ordering hint.
        The optional <code>bus</code> attribute specifies the type of disk device
        to emulate; possible values are driver specific, with typical values being
        "ide", "scsi", "virtio", "xen" or "usb". If omitted, the bus type is
        inferred from the style of the device name. eg, a device named 'sda'
        will typically be exported using a SCSI bus.
        <span class="since">Since 0.0.3; <code>bus</code> attribute since 0.4.3;
D
documentation for USB passthrough  
Daniel Veillard 已提交
474 
        "usb" attribute value since after 0.4.4</span></dd>
D
Update domain XML docs  
Daniel P. Berrange 已提交
475 476 
      <dt><code>driver</code></dt>
      <dd>If the hypervisor supports multiple backend drivers, then the optional
M
Cleanup whitespace in docs  
Matthew Booth 已提交
477 478 
        <code>driver</code> element allows them to be selected. The <code>name</code>
        attribute is the primary backend driver name, while the optional <code>type</code>
M
Document the domain XML cache attribute for disk devices  
Matthias Bolte 已提交
479 480 481 
        attribute provides the sub-type. The optional <code>cache</code> attribute
        controls the cache mechanism, possible values are "default", "none",
        "writethrough" and "writeback". <span class="since">Since 0.1.8</span>
D
Update domain XML docs  
Daniel P. Berrange 已提交
482 
      </dd>
M
Attach encryption information to virDomainDiskDef.  
Miloslav Trmač 已提交
483 484 485 486 487 
      <dt><code>encryption</code></dt>
      <dd>If present, specifies how the volume is encrypted.  See
        the <a href="formatstorageencryption.html">Storage Encryption</a> page
        for more information.
      </dd>
D
add missing doc for device <shareable/> option  
Daniel Veillard 已提交
488 489 490 491 492 
      <dt><code>shareable</code></dt>
      <dd>If present, this indicates the device is expected to be shared
          between domains (assuming the hypervisor and OS support this),
          which means that caching should be deactivated for that device.
      </dd>
D
Update domain XML docs  
Daniel P. Berrange 已提交
493 494 
    </dl>
D
Add tests and docs for the new PCI passthrough format  
Daniel Veillard 已提交
495 
    <h4><a name="elementsUSB">USB and PCI devices</a></h4>
D
documentation for USB passthrough  
Daniel Veillard 已提交
496 497 

    <p>
D
Add tests and docs for the new PCI passthrough format  
Daniel Veillard 已提交
498 499 500 
      USB and PCI devices attached to the host can be passed through to the guest using
      the <code>hostdev</code> element. <span class="since">since after
      0.4.4 for USB and 0.6.0 for PCI (KVM only)</span>:
D
documentation for USB passthrough  
Daniel Veillard 已提交
501 502 503 504 
    </p>

    <pre>
          ...
M
Cleanup whitespace in docs  
Matthew Booth 已提交
505 506 507 508 509 510 511 
          &lt;hostdev mode='subsystem' type='usb'&gt;
            &lt;source&gt;
              &lt;vendor id='0x1234'/&gt;
              &lt;product id='0xbeef'/&gt;
            &lt;/source&gt;
          &lt;/hostdev&gt;
          ...</pre>
D
Add tests and docs for the new PCI passthrough format  
Daniel Veillard 已提交
512 513 514 
    <p>or:</p>
    <pre>
          ...
M
Cleanup whitespace in docs  
Matthew Booth 已提交
515 516 517 518 519 520 
          &lt;hostdev mode='subsystem' type='pci'&gt;
            &lt;source&gt;
              &lt;address bus='0x06' slot='0x02' function='0x0'/&gt;
            &lt;/source&gt;
          &lt;/hostdev&gt;
          ...</pre>
D
documentation for USB passthrough  
Daniel Veillard 已提交
521 522 523 524 525 

    <dl>
      <dt><code>hostdev</code></dt>
      <dd>The <code>hostdev</code> element is the main container for describing
      host devices. For usb device passthrough <code>mode</code> is always
D
Add tests and docs for the new PCI passthrough format  
Daniel Veillard 已提交
526 527 
      "subsystem" and <code>type</code> is "usb" for an USB device and "pci"
      for a PCI device..
D
documentation for USB passthrough  
Daniel Veillard 已提交
528 529 530 531 
      <dt><code>source</code></dt>
      <dd>The source element describes the device as seen from the host.
      The USB device can either be addressed by vendor / product id using the
      <code>vendor</code> and <code>product</code> elements or by the device's
D
Add tests and docs for the new PCI passthrough format  
Daniel Veillard 已提交
532 533 534 
      address on the hosts using the <code>address</code> element.
      PCI devices on the other hand can only be described by their
      <code>address</code></dd>
D
documentation for USB passthrough  
Daniel Veillard 已提交
535 536 537 538 539 540 
      <dt><code>vendor</code>, <code>product</code></dt>
      <dd>The <code>vendor</code> and <code>product</code> elements each have an
      <code>id</code> attribute that specifies the USB vendor and product id.
      The ids can be given in decimal, hexadecimal (starting with 0x) or
      octal (starting with 0) form.</dd>
      <dt><code>address</code></dt>
D
Add tests and docs for the new PCI passthrough format  
Daniel Veillard 已提交
541 542 543 544 545 546 547 548 549 550 551 552 553 554 
      <dd>The <code>address</code> element for USB devices has a
      <code>bus</code> and <code>device</code> attribute to specify the
      USB bus and device number the device appears at on the host.
      The values of these attributes can be given in decimal, hexadecimal
      (starting with 0x) or octal (starting with 0) form.
      For PCI devices the element carries 3 attributes allowing to designate
      the device as can be found with the <code>lspci</code> or
      with <code>virsh nodedev-list</code>. The
      <code>bus</code> attribute allows the hexadecimal values 0 to ff, the
      <code>slot</code> attribute allows the hexadecimal values 0 to 1f, and
      the <code>function</code> attribute allows the hexadecimal values 0 to
      7. There is also an optional <code>domain</code> attribute for the
      PCI domain, with hexadecimal values 0 to ffff, but it is currently
      not used by qemu.</dd>
D
documentation for USB passthrough  
Daniel Veillard 已提交
555 556 
    </dl>
D
Update domain XML docs  
Daniel P. Berrange 已提交
557 558 559 560 
    <h4><a name="elementsNICS">Network interfaces</a></h4>

    <pre>
          ...
M
Cleanup whitespace in docs  
Matthew Booth 已提交
561 562 563 564 565 566 
          &lt;interface type='bridge'&gt;
            &lt;source bridge='xenbr0'/&gt;
            &lt;mac address='00:16:3e:5d:c7:9e'/&gt;
            &lt;script path='vif-bridge'/&gt;
          &lt;/interface&gt;
          ...</pre>
D
Update domain XML docs  
Daniel P. Berrange 已提交
567 568 569 570 571 572 573 574 575 576 577 578 579 580 581 582 583 584 585 586 587 

    <h5><a name="elementsNICSVirtual">Virtual network</a></h5>

    <p>
      <strong><em>
      This is the recommended config for general guest connectivity on
      hosts with dynamic / wireless networking configs
      </em></strong>
    </p>

    <p>
      Provides a virtual network using a bridge device in the host.
      Depending on the virtual network configuration, the network may be
      totally isolated, NAT'ing to an explicit network device, or NAT'ing to
      the default route. DHCP and DNS are provided on the virtual network in
      all cases and the IP range can be determined by examining the virtual
      network config with '<code>virsh net-dumpxml [networkname]</code>'.
      There is one virtual network called 'default' setup out
      of the box which does NAT'ing to the default route and has an IP range of
      <code>192.168.22.0/255.255.255.0</code>. Each guest will have an
      associated tun device created with a name of vnetN, which can also be
C
Document overriding domain interface target  
Cole Robinson 已提交
588 589 
      overridden with the &lt;target&gt; element (see
      <a href="#elementsNICSTargetOverride">overriding the target element</a>).
D
Update domain XML docs  
Daniel P. Berrange 已提交
590 591 592 593 594 595 596 597 598 599 600 601 602 603 604 
    </p>

    <pre>
      ...
      &lt;interface type='network'&gt;
        &lt;source network='default'/&gt;
      &lt;/interface&gt;
      ...
      &lt;interface type='network'&gt;
        &lt;source network='default'/&gt;
        &lt;target dev='vnet7'/&gt;
        &lt;mac address="11:22:33:44:55:66"/&gt;
      &lt;/interface&gt;
      ...</pre>
D
Fix a number of small typos  
Dan Kenigsberg 已提交
605 
    <h5><a name="elementsNICSBridge">Bridge to LAN</a></h5>
D
Update domain XML docs  
Daniel P. Berrange 已提交
606 607 608 609 610 611 612 613 614 615 616 617 618 

    <p>
      <strong><em>
      This is the recommended config for general guest connectivity on
      hosts with static wired networking configs
      </em></strong>
    </p>

    <p>
      Provides a bridge from the VM directly onto the LAN. This assumes
      there is a bridge device on the host which has one or more of the hosts
      physical NICs enslaved. The guest VM will have an associated tun device
      created with a name of vnetN, which can also be overridden with the
C
Document overriding domain interface target  
Cole Robinson 已提交
619 620 621 622 623 
      &lt;target&gt; element (see
      <a href="#elementsNICSTargetOverride">overriding the target element</a>).
      The tun device will be enslaved to the bridge. The IP range / network
      configuration is whatever is used on the LAN. This provides the guest VM
      full incoming &amp; outgoing net access just like a physical machine.
D
Update domain XML docs  
Daniel P. Berrange 已提交
624 625 626 627 628 629 630 631 632 633 634 635 636 637 638 639 640 641 642 643 644 645 646 647 648 649 650 651 652 653 654 655 656 657 658 659 660 661 662 663 664 665 666 667 668 669 670 671 672 673 674 675 676 677 678 679 680 681 682 683 684 685 686 687 688 689 690 691 692 693 694 695 696 697 698 699 700 701 702 703 704 705 706 707 708 709 710 711 712 713 714 715 716 717 718 719 720 721 722 723 724 
    </p>

    <pre>
      ...
      &lt;interface type='bridge'&gt;
        &lt;source bridge='br0'/&gt;
      &lt;/interface&gt;

      &lt;interface type='bridge'&gt;
        &lt;source bridge='br0'/&gt;
        &lt;target dev='vnet7'/&gt;
        &lt;mac address="11:22:33:44:55:66"/&gt;
      &lt;/interface&gt;
      ...</pre>

    <h5><a name="elementsNICSSlirp">Userspace SLIRP stack</a></h5>

    <p>
      Provides a virtual LAN with NAT to the outside world. The virtual
      network has DHCP &amp; DNS services and will give the guest VM addresses
      starting from <code>10.0.2.15</code>. The default router will be
      <code>10.0.2.2</code> and the DNS server will be <code>10.0.2.3</code>.
      This networking is the only option for unprivileged users who need their
      VMs to have outgoing access.
    </p>

    <pre>
      ...
      &lt;interface type='user'/&gt;
      ...
      &lt;interface type='user'&gt;
        &lt;mac address="11:22:33:44:55:66"/&gt;
      &lt;/interface&gt;
      ...</pre>


    <h5><a name="elementsNICSEthernet">Generic ethernet connection</a></h5>

    <p>
      Provides a means for the administrator to execute an arbitrary script
      to connect the guest's network to the LAN. The guest will have a tun
      device created with a name of vnetN, which can also be overridden with the
      &lt;target&gt; element. After creating the tun device a shell script will
      be run which is expected to do whatever host network integration is
      required. By default this script is called /etc/qemu-ifup but can be
      overridden.
    </p>

    <pre>
      ...
      &lt;interface type='ethernet'/&gt;
      ...
      &lt;interface type='ethernet'&gt;
        &lt;target dev='vnet7'/&gt;
        &lt;script path='/etc/qemu-ifup-mynet'/&gt;
      &lt;/interface&gt;
      ...</pre>

    <h5><a name="elementsNICSMulticast">Multicast tunnel</a></h5>

    <p>
      A multicast group is setup to represent a virtual network. Any VMs
      whose network devices are in the same multicast group can talk to each
      other even across hosts. This mode is also available to unprivileged
      users. There is no default DNS or DHCP support and no outgoing network
      access. To provide outgoing network access, one of the VMs should have a
      2nd NIC which is connected to one of the first 4 network types and do the
      appropriate routing. The multicast protocol is compatible with that used
      by user mode linux guests too. The source address used must be from the
      multicast address block.
    </p>

    <pre>
      ...
      &lt;interface type='mcast'&gt;
        &lt;source address='230.0.0.1' port='5558'/&gt;
      &lt;/interface&gt;
      ...</pre>

    <h5><a name="elementsNICSTCP">TCP tunnel</a></h5>

    <p>
      A TCP client/server architecture provides a virtual network. One VM
      provides the server end of the network, all other VMS are configured as
      clients. All network traffic is routed between the VMs via the server.
      This mode is also available to unprivileged users. There is no default
      DNS or DHCP support and no outgoing network access. To provide outgoing
      network access, one of the VMs should have a 2nd NIC which is connected
      to one of the first 4 network types and do the appropriate routing.</p>

    <pre>
      ...
      &lt;interface type='server'&gt;
        &lt;source address='192.168.0.1' port='5558'/&gt;
      &lt;/interface&gt;
      ...
      &lt;interface type='client'&gt;
      &lt;source address='192.168.0.1' port='5558'/&gt;
      &lt;/interface&gt;
      ...</pre>
R
Documentation for NIC model selection.  
Richard W.M. Jones 已提交
725 726 727 728 729 730 731 732 733 734 735 736 737 738 739 740 741 742 743 744 745 746 747 748 749 750 751 752 753 754 755 756 
    <h5><a name="elementsNICSModel">Setting the NIC model</a></h5>

    <pre>
      ...
      &lt;interface type='network'&gt;
        &lt;source network='default'/&gt;
        &lt;target dev='vnet1'/&gt;
        <b>&lt;model type='ne2k_pci'/&gt;</b>
      &lt;/interface&gt;
      ...</pre>

    <p>
      For hypervisors which support this, you can set the model of
      emulated network interface card.
    </p>

    <p>
      The values for <code>type</code> aren't defined specifically by
      libvirt, but by what the underlying hypervisor supports (if
      any).  For QEMU and KVM you can get a list of supported models
      with these commands:
    </p>

<pre>
qemu -net nic,model=? /dev/null
qemu-kvm -net nic,model=? /dev/null
</pre>

    <p>
      Typical values for QEMU and KVM include:
      ne2k_isa i82551 i82557b i82559er ne2k_pci pcnet rtl8139 e1000 virtio
    </p>
D
Update domain XML docs  
Daniel P. Berrange 已提交
757
C
Document overriding domain interface target  
Cole Robinson 已提交
758 759 760 761 762 763 764 765 766 767 768 769 770 771 772 773 774 775 776 
    <h5><a name="elementsNICSTargetOverride">Overriding the target element</a></h5>

    <pre>
      ...
      &lt;interface type='network'&gt;
        &lt;source network='default'/&gt;
        <b>&lt;target dev='vnet1'/&gt;</b>
      &lt;/interface&gt;
      ...</pre>

    <p>
        If no target is specified, certain hypervisors will automatically
        generate a name for the created tun device. This name can be manually
        specifed, however the name <i>must not start with either 'vnet' or
        'vif'</i>, which are prefixes reserved by libvirt and certain
        hypervisors. Manually specified targets using these prefixes will be
        ignored.
    </p>
D
Update domain XML docs  
Daniel P. Berrange 已提交
777 778 779 780 781 782 783 784 785 786 787 
    <h4><a name="elementsInput">Input devices</a></h4>

    <p>
      Input devices allow interaction with the graphical framebuffer in the guest
      virtual machine. When enabling the framebuffer, an input device is automatically
      provided. It may be possible to add additional devices explicitly, for example,
      to provide a graphics tablet for absolute cursor movement.
    </p>

    <pre>
          ...
M
Cleanup whitespace in docs  
Matthew Booth 已提交
788 789 
          &lt;input type='mouse' bus='usb'/&gt;
          ...</pre>
D
Update domain XML docs  
Daniel P. Berrange 已提交
790 791 792 

    <dl>
      <dt><code>input</code></dt>
A
fix typos in docs  
Atsushi SAKAI 已提交
793 
      <dd>The <code>input</code> element has one mandatory attribute, the <code>type</code>
M
Cleanup whitespace in docs  
Matthew Booth 已提交
794 795 796 797 
        whose value can be either 'mouse' or 'tablet'. The latter provides absolute
        cursor movement, while the former uses relative movement. The optional
        <code>bus</code> attribute can be used to refine the exact device type.
        It takes values "xen" (paravirtualized), "ps2" and "usb".</dd>
D
Update domain XML docs  
Daniel P. Berrange 已提交
798 799 800 801 802 803 804 805 806 807 808 809 810 811 
    </dl>


    <h4><a name="elementsGraphics">Graphical framebuffers</a></h4>

    <p>
      A graphics device allows for graphical interaction with the
      guest OS. A guest will typically have either a framebuffer
      or a text console configured to allow interaction with the
      admin.
    </p>

    <pre>
          ...
M
Cleanup whitespace in docs  
Matthew Booth 已提交
812 813 814 815 816 
          &lt;graphics type='sdl' display=':0.0'/&gt;
          &lt;graphics type='vnc' port='5904'/&gt;
          &lt;graphics type='rdp' autoport='yes' multiUser='yes' /&gt;
          &lt;graphics type='desktop' fullscreen='yes'/&gt;
          ...</pre>
D
Update domain XML docs  
Daniel P. Berrange 已提交
817 818 819 820 

    <dl>
      <dt><code>graphics</code></dt>
      <dd>The <code>graphics</code> element has a mandatory <code>type</code>
F
add doc for graphic and video elements  
Florian Vichot 已提交
821 822 823 824 825 826 827 828 829 830 831 832 833 834 835 836 837 838 839 840 841 842 843 844 845 846 847 848 849 850 851 852 853 854 855 856 857 858 859 860 861 862 863 864 865 866 867 868 869 870 871 
  attribute which takes the value "sdl", "vnc", "rdp" or "desktop":
        <dl>
          <dt><code>"sdl"</code></dt>
          <dd>
  This displays a window on the host desktop, it can take 3 optional arguments:
  a <code>display</code> attribute for the display to use, an <code>xauth</code>
  attribute for the authentication identifier, and an optional <code>fullscreen</code>
  attribute accepting values 'yes' or 'no'.
          </dd>
          <dt><code>"vnc"</code></dt>
          <dd>
  Starts a VNC server. The <code>port</code> attribute specifies the TCP
  port number (with -1 as legacy syntax indicating that it should be
  auto-allocated). The <code>autoport</code> attribute is the new
  preferred syntax for indicating autoallocation of the TCP port to use.
  The <code>listen</code> attribute is an IP address for the server to
  listen on. The <code>passwd</code> attribute provides a VNC password
  in clear text. The <code>keymap</code> attribute specifies the keymap
  to use.
          </dd>
          <dt><code>"rdp"</code></dt>
          <dd>
  Starts a RDP server. The <code>port</code> attribute
  specifies the TCP port number (with -1 as legacy syntax indicating
  that it should be auto-allocated). The <code>autoport</code> attribute
  is the new preferred syntax for indicating autoallocation of the TCP
  port to use. The <code>replaceUser</code> attribute is a boolean deciding
  whether multiple simultaneous connections to the VM are permitted.
  The <code>multiUser</code> whether the existing connection must be dropped
  and a new connection must be established by the VRDP server, when a new
  client connects in single connection mode.

          </dd>
          <dt><code>"desktop"</code></dt>
          <dd>
  This value is reserved for VirtualBox domains for the moment. It displays
  a window on the host desktop, similarly to "sdl", but using the VirtualBox
  viewer. Just like "sdl", it accepts the optional attributes <code>display</code>
  and <code>fullscreen</code>.
          </dd>
        </dl>
      </dd>
    </dl>

    <h4><a name="elementsVideo">Video devices</a></h4>
    <p>
      A video device.
    </p>

    <pre>
      ...
M
Fix and improve domain xml video element description  
Matthias Bolte 已提交
872 873 874 875 
      &lt;video&gt;
        &lt;model type='vga' vram='8192' heads='1'&gt;
          &lt;acceleration accel3d='yes' accel3d='yes'/&gt;
        &lt;/model&gt;
F
add doc for graphic and video elements  
Florian Vichot 已提交
876 
      &lt;/video&gt;
M
Whitespace cleanup for pre-tags on the website  
Matthias Bolte 已提交
877 
      ...</pre>
F
add doc for graphic and video elements  
Florian Vichot 已提交
878 879 880 

    <dl>
      <dt><code>video</code></dt>
M
Fix and improve domain xml video element description  
Matthias Bolte 已提交
881 882 883 884 
      <dd>
        The <code>video</code> element is the a container for describing
        video devices.
      </dd>
F
add doc for graphic and video elements  
Florian Vichot 已提交
885
M
Fix and improve domain xml video element description  
Matthias Bolte 已提交
886 887 888 889 890 891 892 893 894 895 896 897 898 899 
      <dt><code>model</code></dt>
      <dd>
        The <code>model</code> element has a mandatory <code>type</code>
        attribute which takes the value "vga", "cirrus", "vmvga", "xen" or "vbox".
        You can also provide the amount of video memory in kilobytes using
        <code>vram</code> and the number of screen with <code>heads</code>.
      </dd>

      <dt><code>acceleration</code></dt>
      <dd>
        If acceleration should be enabled (if supported) using the
        <code>accel3d</code> and <code>accel2d</code> attributes in the
        <code>acceleration</code> element.
      </dd>
D
Update domain XML docs  
Daniel P. Berrange 已提交
900 901 
    </dl>
M
Add documentation for <channel> domain element  
Matthew Booth 已提交
902 
    <h4><a name="elementsConsole">Consoles, serial, parallel &amp; channel devices</a></h4>
D
Update domain XML docs  
Daniel P. Berrange 已提交
903 904 905 

    <p>
      A character device provides a way to interact with the virtual machine.
M
Add documentation for <channel> domain element  
Matthew Booth 已提交
906 907 
      Paravirtualized consoles, serial ports, parallel ports and channels are
      all classed as character devices and so represented using the same syntax.
D
Update domain XML docs  
Daniel P. Berrange 已提交
908 909 910 911 912 
    </p>

    <pre>
        ...
        &lt;parallel type='pty'&gt;
M
Cleanup whitespace in docs  
Matthew Booth 已提交
913 914 
          &lt;source path='/dev/pts/2'/&gt;
          &lt;target port='0'/&gt;
D
Update domain XML docs  
Daniel P. Berrange 已提交
915 916 
        &lt;/parallel&gt;
        &lt;serial type='pty'&gt;
M
Cleanup whitespace in docs  
Matthew Booth 已提交
917 918 
          &lt;source path='/dev/pts/3'/&gt;
          &lt;target port='0'/&gt;
D
Update domain XML docs  
Daniel P. Berrange 已提交
919 920 
        &lt;/serial&gt;
        &lt;console type='pty'&gt;
M
Cleanup whitespace in docs  
Matthew Booth 已提交
921 922 
          &lt;source path='/dev/pts/4'/&gt;
          &lt;target port='0'/&gt;
D
Update domain XML docs  
Daniel P. Berrange 已提交
923 
        &lt;/console&gt;
M
Add documentation for <channel> domain element  
Matthew Booth 已提交
924 925 926 927 
        &lt;channel type='unix'&gt;
          &lt;source mode='bind' path='/tmp/guestfwd'/&gt;
          &lt;target type='guestfwd' address='10.0.2.1' port='4600'/&gt;
        &lt;/channel&gt;
D
Update domain XML docs  
Daniel P. Berrange 已提交
928 929 930 
        &lt;/devices&gt;
      &lt;/domain&gt;</pre>
M
Separate character device doc guest and host parts  
Matthew Booth 已提交
931 932 933 934 935 
    <p>
      In each of these directives, the top-level element name (parallel, serial,
      console, channel) describes how the device is presented to the guest. The
      guest interface is configured by the <code>target</code> element.
    </p>
D
Update domain XML docs  
Daniel P. Berrange 已提交
936
M
Separate character device doc guest and host parts  
Matthew Booth 已提交
937 938 939 940 941 942 943 944 945 946 947 948 949 950 951 952 953 954 955 956 957 958 959 960 961 962 963 964 965 966 967 968 969 970 971 972 973 974 975 976 977 978 979 980 981 982 983 984 985 986 987 988 989 990 991 992 993 994 995 996 997 998 999 1000 1001 1002 1003 
    <p>
      The interface presented to the host is given in the <code>type</code>
      attribute of the top-level element. The host interface is
      configured by the <code>source</code> element.
    </p>

    <h5><a name="elementsCharGuestInterface">Guest interface</a></h5>

    <p>
      A character device presents itself to the guest as one of the following
      types.
    </p>

    <h6><a name="elementCharParallel">Parallel port</a></h6>

    <pre>
      ...
      &lt;parallel type='pty'&gt;
        &lt;source path='/dev/pts/2'/&gt;
        &lt;target port='0'/&gt;
      &lt;/parallel&gt;
      ...</pre>

    <p>
      <code>target</code> can have a <code>port</code> attribute, which
      specifies the port number. Ports are numbered starting from 1. There are
      usually 0, 1 or 2 parallel ports.
    </p>

    <h6><a name="elementCharSerial">Serial port</a></h6>

    <pre>
      ...
      &lt;serial type='pty'&gt;
        &lt;source path='/dev/pts/3'/&gt;
        &lt;target port='0'/&gt;
      &lt;/serial&gt;
      ...</pre>

    <p>
      <code>target</code> can have a <code>port</code> attribute, which
      specifies the port number. Ports are numbered starting from 1. There are
      usually 0, 1 or 2 serial ports.
    </p>

    <h6><a name="elementCharConsole">Console</a></h6>

    <p>
      This represents the primary console. This can be the paravirtualized
      console with Xen guests, or duplicates the primary serial port for fully
      virtualized guests without a paravirtualized console.
    </p>

    <pre>
      ...
      &lt;console type='pty'&gt;
        &lt;source path='/dev/pts/4'/&gt;
        &lt;target port='0'/&gt;
      &lt;/console&gt;
      ...</pre>

    <p>
      If the console is presented as a serial port, the <code>target</code>
      element has the same attributes as for a serial port. There is usually
      only 1 console.
    </p>
M
Add documentation for <channel> domain element  
Matthew Booth 已提交
1004 1005 1006 1007 1008 1009 1010 1011 1012 1013 1014 1015 1016 1017 1018 1019 1020 1021 1022 1023 1024 1025 1026 1027 1028 1029 1030 1031 1032 1033 
    <h6><a name="elementCharChannel">Channel</a></h6>

    <p>
      This represents a private communication channel between the host and the
      guest.
    </p>

    <pre>
      ...
      &lt;channel type='unix'&gt;
        &lt;source mode='bind' path='/tmp/guestfwd'/&gt;
        &lt;target type='guestfwd' address='10.0.2.1' port='4600'/&gt;
      &lt;/channel&gt;
      ...</pre>

    <p>
      This can be implemented in a variety of ways. The specific type of
      channel is given in the <code>type</code> attribute of the
      <code>target</code> element. Different channel types have different
      <code>target</code> attributes.
    </p>

    <dl>
      <dt><code>guestfwd</code></dt>
      <dd>TCP traffic sent by the guest to a given IP address and port is
        forwarded to the channel device on the host. The <code>target</code>
        element must have <code>address</code> and <code>port</code> attributes.
        <span class="since">Since 0.7.3</span></dd>
    </dl>
M
Separate character device doc guest and host parts  
Matthew Booth 已提交
1034 1035 1036 1037 1038 1039 
    <h5><a name="elementsCharHostInterface">Host interface</a></h5>

    <p>
      A character device presents itself to the host as one of the following
      types.
    </p>
D
Update domain XML docs  
Daniel P. Berrange 已提交
1040
M
Separate character device doc guest and host parts  
Matthew Booth 已提交
1041 
    <h6><a name="elementsCharSTDIO">Domain logfile</a></h6>
D
Update domain XML docs  
Daniel P. Berrange 已提交
1042 1043 1044 1045 1046 1047 1048 1049 1050 1051 1052 1053 1054 1055 

    <p>
      This disables all input on the character device, and sends output
      into the virtual machine's logfile
    </p>

    <pre>
      ...
      &lt;console type='stdio'&gt;
        &lt;target port='1'&gt;
      &lt;/console&gt;
      ...</pre>
M
Separate character device doc guest and host parts  
Matthew Booth 已提交
1056 
    <h6><a name="elementsCharFle">Device logfile</a></h6>
D
Update domain XML docs  
Daniel P. Berrange 已提交
1057 1058 1059 1060 1061 1062 1063 1064 1065 1066 1067 1068 1069 1070 

    <p>
      A file is opened and all data sent to the character
      device is written to the file.
    </p>

    <pre>
      ...
      &lt;serial type="file"&gt;
        &lt;source path="/var/log/vm/vm-serial.log"/&gt;
        &lt;target port="1"/&gt;
      &lt;/serial&gt;
      ...</pre>
M
Separate character device doc guest and host parts  
Matthew Booth 已提交
1071 
    <h6><a name="elementsCharVC">Virtual console</a></h6>
D
Update domain XML docs  
Daniel P. Berrange 已提交
1072 1073 1074 1075 1076 1077 1078 1079 1080 1081 1082 1083 1084 1085 

    <p>
      Connects the character device to the graphical framebuffer in
      a virtual console. This is typically accessed via a special
      hotkey sequence such as "ctrl+alt+3"
    </p>

    <pre>
      ...
      &lt;serial type='vc'&gt;
        &lt;target port="1"/&gt;
      &lt;/serial&gt;
      ...</pre>
M
Separate character device doc guest and host parts  
Matthew Booth 已提交
1086 
    <h6><a name="elementsCharNull">Null device</a></h6>
D
Update domain XML docs  
Daniel P. Berrange 已提交
1087 1088 1089 1090 1091 1092 1093 1094 1095 1096 1097 1098 1099 

    <p>
      Connects the character device to the void. No data is ever
      provided to the input. All data written is discarded.
    </p>

    <pre>
      ...
      &lt;serial type='null'&gt;
        &lt;target port="1"/&gt;
      &lt;/serial&gt;
      ...</pre>
M
Separate character device doc guest and host parts  
Matthew Booth 已提交
1100 
    <h6><a name="elementsCharPTY">Pseudo TTY</a></h6>
D
Update domain XML docs  
Daniel P. Berrange 已提交
1101 1102 1103 1104 1105 1106 1107 1108 1109 1110 1111 1112 1113 1114 1115 1116 1117 

    <p>
      A Pseudo TTY is allocated using /dev/ptmx. A suitable client
      such as 'virsh console' can connect to interact with the
      serial port locally.
    </p>

    <pre>
      ...
      &lt;serial type="pty"&gt;
        &lt;source path="/dev/pts/3"/&gt;
        &lt;target port="1"/&gt;
      &lt;/serial&gt;
      ...</pre>

    <p>
      NB special case if &lt;console type='pty'&gt;, then the TTY
A
fix typos in docs  
Atsushi SAKAI 已提交
1118 
      path is also duplicated as an attribute tty='/dev/pts/3'
D
Update domain XML docs  
Daniel P. Berrange 已提交
1119 1120 1121 1122 
      on the top level &lt;console&gt; tag. This provides compat
      with existing syntax for &lt;console&gt; tags.
    </p>
M
Separate character device doc guest and host parts  
Matthew Booth 已提交
1123 
    <h6><a name="elementsCharHost">Host device proxy</a></h6>
D
Update domain XML docs  
Daniel P. Berrange 已提交
1124 1125 1126 1127 1128 

    <p>
      The character device is passed through to the underlying
      physical character device. The device types must match,
      eg the emulated serial port should only be connected to
A
fix typos in docs  
Atsushi SAKAI 已提交
1129 
      a host serial port - don't connect a serial port to a parallel
D
Update domain XML docs  
Daniel P. Berrange 已提交
1130 1131 1132 1133 1134 1135 1136 1137 1138 1139 1140 
      port.
    </p>

    <pre>
      ...
      &lt;serial type="dev"&gt;
        &lt;source path="/dev/ttyS0"/&gt;
        &lt;target port="1"/&gt;
      &lt;/serial&gt;
      ...</pre>
M
Separate character device doc guest and host parts  
Matthew Booth 已提交
1141 
    <h6><a name="elementsCharPipe">Named pipe</a></h6>
C
Fix docs and code disagreements for character devices.  
Cole Robinson 已提交
1142 1143 1144 1145 1146 1147 1148 1149 1150 1151 1152 1153 1154 1155 

    <p>
      The character device writes output to a named pipe. See pipe(7) for
      more info.
    </p>

    <pre>
      ...
      &lt;serial type="pipe"&gt;
        &lt;source path="/tmp/mypipe"/&gt;
        &lt;target port="1"/&gt;
      &lt;/serial&gt;
      ...</pre>
M
Separate character device doc guest and host parts  
Matthew Booth 已提交
1156 
    <h6><a name="elementsCharTCP">TCP client/server</a></h6>
D
Update domain XML docs  
Daniel P. Berrange 已提交
1157 1158 1159 

    <p>
      The character device acts as a TCP client connecting to a
G
document tcp listen and raw wire option  
Guido Günther 已提交
1160 
      remote server.
D
Update domain XML docs  
Daniel P. Berrange 已提交
1161 1162 1163 1164 1165 1166 
    </p>

    <pre>
      ...
      &lt;serial type="tcp"&gt;
        &lt;source mode="connect" host="0.0.0.0" service="2445"/&gt;
G
document tcp listen and raw wire option  
Guido Günther 已提交
1167 1168 1169 1170 1171 1172 1173 1174 1175 1176 1177 1178 1179 1180 1181 1182 1183 1184 1185 1186 1187 1188 1189 1190 1191 1192 1193 1194 1195 1196 1197 1198 
        &lt;protocol type="raw"/&gt;
        &lt;target port="1"/&gt;
      &lt;/serial&gt;
      ...</pre>

    <p>
      Or as a TCP server waiting for a client connection.
    </p>

    <pre>
      ...
      &lt;serial type="tcp"&gt;
        &lt;source mode="bind" host="127.0.0.1" service="2445"/&gt;
        &lt;protocol type="raw"/&gt;
        &lt;target port="1"/&gt;
      &lt;/serial&gt;
      ...</pre>

    <p>
      Alternatively you can use telnet instead of raw TCP.
    <p>

    <pre>
      ...
      &lt;serial type="tcp"&gt;
        &lt;source mode="connect" host="0.0.0.0" service="2445"/&gt;
        &lt;protocol type="telnet"/&gt;
        &lt;target port="1"/&gt;
      &lt;/serial&gt;
      ...
      &lt;serial type="tcp"&gt;
        &lt;source mode="bind" host="127.0.0.1" service="2445"/&gt;
C
Fix docs and code disagreements for character devices.  
Cole Robinson 已提交
1199 
        &lt;protocol type="telnet"/&gt;
D
Update domain XML docs  
Daniel P. Berrange 已提交
1200 1201 1202 1203 
        &lt;target port="1"/&gt;
      &lt;/serial&gt;
      ...</pre>
M
Separate character device doc guest and host parts  
Matthew Booth 已提交
1204 
    <h6><a name="elementsCharUDP">UDP network console</a></h6>
D
Update domain XML docs  
Daniel P. Berrange 已提交
1205 1206 1207 1208 1209 1210 1211 1212 1213 1214 1215 1216 1217 1218 1219 

    <p>
      The character device acts as a UDP netconsole service,
      sending and receiving packets. This is a lossy service.
    </p>

    <pre>
      ...
      &lt;serial type="udp"&gt;
        &lt;source mode="bind" host="0.0.0.0" service="2445"/&gt;
        &lt;source mode="connect" host="0.0.0.0" service="2445"/&gt;
        &lt;target port="1"/&gt;
      &lt;/serial&gt;
      ...</pre>
M
Separate character device doc guest and host parts  
Matthew Booth 已提交
1220 
    <h6><a name="elementsCharUNIX">UNIX domain socket client/server</a></h6>
D
Update domain XML docs  
Daniel P. Berrange 已提交
1221 1222 1223 1224 1225 1226 1227 1228 1229 1230 1231 1232 1233 1234 

    <p>
      The character device acts as a UNIX domain socket server,
      accepting connections from local clients.
    </p>

    <pre>
      ...
      &lt;serial type="unix"&gt;
        &lt;source mode="bind" path="/tmp/foo"/&gt;
        &lt;target port="1"/&gt;
      &lt;/serial&gt;
      ...</pre>
C
Add documentation for <sound> device XML format.  
Cole Robinson 已提交
1235 1236 1237 1238 1239 1240 1241 1242 1243 1244 1245 1246 1247 1248 1249 1250 1251 1252 1253 1254 1255 1256 1257 1258 

    <h4><a name="elementsSound">Sound devices</a></h4>

    <p>
      A virtual sound card can be attached to the host via the
      <code>sound</code> element. <span class="since">Since 0.4.3</span>
    </p>

    <pre>
      ...
      &lt;sound model='es1370'/&gt;
      ...</pre>

    <dl>
      <dt><code>sound</code></dt>
      <dd>
        The <code>sound</code> element has one mandatory attribute,
        <code>model</code>, which specifies what real sound device is emulated.
        Valid values are specific to the underlying hypervisor, though typical
        choices are 'es1370', 'sb16', and 'ac97'
        (<span class="since">'ac97' only since 0.6.0</span>)
      </dd>
    </dl>
R
Support QEMU watchdog device.  
Richard Jones 已提交
1259 1260 1261 1262 1263 1264 1265 1266 1267 1268 1269 1270 1271 1272 1273 1274 1275 1276 1277 1278 1279 1280 1281 1282 1283 1284 1285 1286 1287 1288 1289 1290 1291 
    <h4><a name="elementsWatchdog">Watchdog device</a></h4>

    <p>
      A virtual hardware watchdog device can be added to the guest via
      the <code>watchdog</code> element.
      <span class="since">Since 0.7.3, QEMU and KVM only</span>
    </p>

    <p>
      The watchdog device requires an additional driver and management
      daemon in the guest.  Just enabling the watchdog in the libvirt
      configuration does not do anything useful on its own.
    </p>

    <p>
      Currently libvirt does not support notification when the
      watchdog fires.  This feature is planned for a future version of
      libvirt.
    </p>

    <pre>
      ...
      &lt;watchdog model='i6300esb'/&gt;
      ...</pre>

    <pre>
      ...
      &lt;watchdog model='i6300esb' action='poweroff'/&gt;
      ...</pre>

    <dl>
      <dt><code>model</code></dt>
      <dd>
M
Cleanup whitespace in docs  
Matthew Booth 已提交
1292 
        <p>
R
Support QEMU watchdog device.  
Richard Jones 已提交
1293 
        The required <code>model</code> attribute specifies what real
M
Cleanup whitespace in docs  
Matthew Booth 已提交
1294 1295 1296 1297 1298 1299 1300 1301 1302 1303 1304 
        watchdog device is emulated.  Valid values are specific to the
        underlying hypervisor.
        </p>
        <p>
        QEMU and KVM support:
        </p>
        <ul>
          <li> 'i6300esb' &mdash; the recommended device,
            emulating a PCI Intel 6300ESB </li>
          <li> 'ib700' &mdash; emulating an ISA iBase IB700 </li>
        </ul>
R
Support QEMU watchdog device.  
Richard Jones 已提交
1305 1306 1307 
      </dd>
      <dt><code>action</code></dt>
      <dd>
M
Cleanup whitespace in docs  
Matthew Booth 已提交
1308 
        <p>
R
Support QEMU watchdog device.  
Richard Jones 已提交
1309 
        The optional <code>action</code> attribute describes what
M
Cleanup whitespace in docs  
Matthew Booth 已提交
1310 1311 1312 1313 1314 1315 1316 1317 1318 1319 1320 1321 1322 1323 1324 1325 1326 1327 1328 1329 1330 
        action to take when the watchdog expires.  Valid values are
        specific to the underlying hypervisor.
        </p>
        <p>
        QEMU and KVM support:
        </p>
        <ul>
          <li>'reset' &mdash; default, forcefully reset the guest</li>
          <li>'shutdown' &mdash; gracefully shutdown the guest
            (not recommended) </li>
          <li>'poweroff' &mdash; forcefully power off the guest</li>
          <li>'pause' &mdash; pause the guest</li>
          <li>'none' &mdash; do nothing</li>
        </ul>
        <p>
        Note that the 'shutdown' action requires that the guest
        is responsive to ACPI signals.  In the sort of situations
        where the watchdog has expired, guests are usually unable
        to respond to ACPI signals.  Therefore using 'shutdown'
        is not recommended.
        </p>
R
Support QEMU watchdog device.  
Richard Jones 已提交
1331 1332 1333 
      </dd>
    </dl>
D
Update domain XML docs  
Daniel P. Berrange 已提交
1334 
    <h2><a name="examples">Example configs</a></h2>
D
Split website out into one file per page. APply new layout and styling  
Daniel P. Berrange 已提交
1335 1336 1337 1338 1339 1340 1341 1342 1343 1344 1345 1346 

    <p>
      Example configurations for each driver are provide on the
      driver specific pages listed below
    </p>

    <ul>
      <li><a href="drvxen.html#xmlconfig">Xen examples</a></li>
      <li><a href="drvqemu.html#xmlconfig">QEMU/KVM examples</a></li>
    </ul>
  </body>
</html>