Skip to content

L
libvirt

openeuler / libvirt

通知 3
Star 0
Fork 0
L
libvirt

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

切换分支/标签
查找文件 普通视图历史永久链接Permalink
formatdomain.html.in 27.4 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 40 41 42 43 44 45 46 47 48 49 50 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 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 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 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 357 358 359 360 361 362 363 364 365 366 367 368 369 370 371 372 373 374 375 376 377 378 379 380 381 382 383 384 385 386 387 388 389 390 391 392 393 394 395 396 397 398 399 400 401 402 403 404 405 406 407 408 409 410 411 412 413 414 415 416 417 418 419 420 421 422 423 424 425 426 427 428 429 430 431 432 433 434 435 436 437 438 439 440 441 442 443 444 445 446 447 448 449 450 451 452 453 454 455 456 457 458 459 460 461 462 463 464 465 466 467 468 469 470 471 472 473 474 475 476 477 478 479 480 481 482 483 484 485 486 487 488 489 490 491 492 493 494 495 496 497 498 499 500 501 502 503 504 505 506 507 508 509 510 511 512 513 514 515 516 517 518 519 520 521 522 523 524 525 526 527 528 529 530 531 532 533 534 535 536 537 538 539 540 541 542 543 544 545 546 547 548 549 550 551 552 553 554 555 556 557 558 559 560 561 562 563 564 565 566 567 568 569 570 571 572 573 574 575 576 577 578 579 580 581 582 583 584 585 586 587 588 589 590 591 592 593 594 595 596 597 598 599 600 601 602 603 604 605 606 607 608 609 610 611 612 613 614 615 616 617 618 619 620 621 622 623 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 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 757 758 759 760 761 762 763 764 765 766 767 768 769 770 771 772 773 774 775 776 777 778 779 780 781 782 783 784 785 786 787 
    <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
	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>
      <dt><code>uuid</code></dt>
      <dd>The content of the <code>uuid</code> element provides
	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>
    </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
	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>
	refering 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>
      <dt><code>loader</code></dt>
      <dd>The optional <code>loader</code> tag refers to a firmware blob
	used to assist the domain creation process. At this time, it is
	only needed by Xen fullyvirtualized domains. <span class="since">Since 0.1.0</span></dd>
      <dt><code>boot</code></dt>
      <dd>The <code>dev</code> attribute takes one of the values "fd", "hd",
	"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>
      </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
      operating system boot. This may use a pseduo-bootloader in the
      host to provide an interface to choose a kernel for the guest.
      An example is <code>pygrub</code> with Xen.
    </p>

    <pre>
        ...
	&lt;bootloader&gt;/usr/bin/pygrub&lt;/bootloader&gt;
	&lt;bootloader_args&gt;--append single&lt;/bootloader_args&gt;
        ...</pre>

    <dl>
      <dt><code>bootloader</code></dt>
      <dd>The content of the <code>bootloader</code> element provides
	a fullyqualified 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 dependant
	on the hypervisor in use. <span class="since">Since 0.1.0</span></dd>
      <dt><code>bootloader_args</code></dt>
      <dd>The optional <code>bootloader_args</code> element allows
	command line arguments to be passed to the bootloader.
	<span class="since">Since 0.2.3</span>
	</dd>

    </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>
        ...
	&lt;os&gt;
          &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;
	&lt;/os&gt;
	...</pre>

    <dl>
      <dt><code>type</code></dt>
      <dd>This element has the same semantics as described earlier in the
	<a href="#elementsOSBIOS">BIOS boot section</a></dd>
      <dt><code>type</code></dt>
      <dd>This element has the same semantics as described earlier in the
	<a href="#elementsOSBIOS">BIOS boot section</a></dd>
      <dt><code>kernel</code></dt>
      <dd>The contents of this element specify the fully-qualified path
	to the kernel image in the host OS.</dd>
      <dt><code>initrd</code></dt>
      <dd>The contents of this element specify the fully-qualified path
	to the (optional) ramdisk image in the host OS.</dd>
      <dt><code>cmdline</code></dt>
      <dd>The contents of this element specify arguments to be passed to
	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>
    </dl>

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

    <pre>
        ...
	&lt;memory&gt;524288&lt;/memory&gt;
	&lt;currentMemory&gt;524288&lt;/currentMemory&gt;
	&lt;vcpu&gt;1&lt;/vcpu&gt;
	...</pre>

    <dl>
      <dt><code>memory</code></dt>
      <dd>The maximum allocation of memory for the guest at boot time.
	The units for this value are bytes</dd>
      <dt><code>currentMemory</code></dt>
      <dd>The actual allocation of memory for the guest. This value
	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>
      <dt><code>vcpu</code></dt>
      <dd>The content of this element defines the number of virtual
	CPUs allocated for the guest OS.</dd>
    </dl>

    <h3><a name="elementsLifecycle">Lifecycle control</a></h3>

    <p>
      It is sometimes neccessary to override the default actions taken
      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>
        ...
	&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>

    <dl>
      <dt><code>on_poweroff</code></dt>
      <dd>The content of this element specifies the action to take when
	the guest requests a poweroff.</dd>
      <dt><code>on_poweroff</code></dt>
      <dd>The content of this element specifies the action to take when
	the guest requests a reboot.</dd>
      <dt><code>on_poweroff</code></dt>
      <dd>The content of this element specifies the action to take when
	the guest crashes.</dd>
    </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
	released</dd>
      <dt><code>restart</code></dt>
      <dd>The domain will be terminated, and then restarted with
	the same configuration</dd>
      <dt><code>preserve</code></dt>
      <dd>The domain will be terminated, and its resource preserved
	to allow analysis.</dd>
      <dt><code>rename-restart</code></dt>
      <dd>The domain will be terminated, and then restarted with
	a new name</dd>
    </dl>

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

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

    <pre>
        ...
	&lt;features&gt;
	  &lt;pae/&gt;
	  &lt;acpi/&gt;
	  &lt;apic/&gt;
	&lt;/features&gt;
	...</pre>

    <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
	to address more than 4 GB of memory.</dd>
      <dt><code>acpi</code></dt>
      <dd>ACPI is useful for power management, for example, with
	KVM guests it is required for graceful shutdown to work.
      </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>
        ...
        &lt;clock sync="localtime"/&gt;
	...</pre>

    <dl>
      <dt><code>clock</code></dt>
      <dd>The <code>sync</code> attribute takes either "utc" or
	"localtime" to specify how the guest clock is initialized
	in relation to the host OS.
      </dd>
    </dl>

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

    <p>
      The final set of XML elements are all used to descibe devices
      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;
	  &lt;emulator&gt;/usr/lib/xen/bin/qemu-dm&lt;/emulator&gt;
          ...</pre>

    <dl>
      <dt><code>emulator</code></dt>
      <dd>
	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.
      </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>
          ...
	  &lt;disk type='file'&gt;
	    &lt;driver name="tap" type="aio"&gt;
	    &lt;source file='/var/lib/xen/images/fv0'/&gt;
	    &lt;target dev='hda' bus='ide'/&gt;
	  &lt;/disk&gt;
	  ...</pre>

    <dl>
      <dt><code>disk</code></dt>
      <dd>The <code>disk</code> element is the main container for describing
	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>
      <dt><code>source</code></dt>
      <dd>If the disk <code>type</code> is "file", then the <code>file</code> attribute
	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>
      <dt><code>target</code></dt>
      <dd>The <code>target</code> element controls the bus / device under which the
	disk is exposed to the guest OS. The <code>dev</code> attribute indicates
	the "logical" device name. The actual device name specified is not guarenteed 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". 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</span></dd>
      <dt><code>driver</code></dt>
      <dd>If the hypervisor supports multiple backend drivers, then the optional
	<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>
	attribute provides the sub-type. <span class="since">Since 0.1.8</span>
      </dd>
    </dl>

    <h4><a name="elementsNICS">Network interfaces</a></h4>

    <pre>
          ...
	  &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>

    <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
      overridden with the &lt;target&gt; element.
    </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>

    <h5><a name="elementsNICSBridge">Bridge to to LAN</a></h5>

    <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
      &lt;target&gt; element. 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.
    </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>


    <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>
          ...
	  &lt;input type='mouse' bus='usb'/&gt;
	  ...</pre>

    <dl>
      <dt><code>input</code></dt>
      <dd>The <code>input</code> element has one madatory attribute, the <code>type</code>
	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>
    </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>
          ...
	  &lt;graphics type='vnc' port='5904'/&gt;
	  ...</pre>

    <dl>
      <dt><code>graphics</code></dt>
      <dd>The <code>graphics</code> element has a mandatory <code>type</code>
	attribute which takes the value "sdl" or "vnc". The former displays
	a window on the host desktop, while the latter activates a VNC server.
	If the latter is used the <code>port</code> attributes specifies the
	TCP port number (with -1 indicating that it should be auto-allocated).
	The <code>listen</code> attribute is an IP address for the server to
	listen on. The <code>password</code> attribute provides a VNC password
	in clear text.</dd>
    </dl>

    <h4><a name="elementsConsole">Consoles, serial &amp; parallel devices</a></h4>

    <p>
      A character device provides a way to interact with the virtual machine.
      Paravirtualized consoles, serial ports and parallel ports are all
      classed as character devices and so represented using the same syntax.
    </p>

    <pre>
        ...
        &lt;parallel type='pty'&gt;
	  &lt;source path='/dev/pts/2'/&gt;
	  &lt;target port='0'/&gt;
        &lt;/parallel&gt;
        &lt;serial type='pty'&gt;
	  &lt;source path='/dev/pts/3'/&gt;
	  &lt;target port='0'/&gt;
        &lt;/serial&gt;
        &lt;console type='pty'&gt;
	  &lt;source path='/dev/pts/4'/&gt;
	  &lt;target port='0'/&gt;
        &lt;/console&gt;
        &lt;/devices&gt;
      &lt;/domain&gt;</pre>


    <dl>
      <dt><code>parallel</code></dt>
      <dd>Represents a parallel port</dd>
      <dt><code>serial</code></dt>
      <dd>Represents a serial port</dd>
      <dt><code>console</code></dt>
      <dd>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.</dd>
      <dt><code>source</code></dt>
      <dd>The attributes available for the <code>source</code> element
	vary according to the <code>type</code> attribute on the parent
	tag. Allowed variations will be described below</dd>
      <dt><code>target</code></dt>
      <dd>The port number of the character device is specified via the
	<code>port</code> attribute, numbered starting from 1. There is
	usually only one console device, and 0, 1 or 2 serial devices
	or parallel devices.
    </dl>

    <h5><a name="elementsCharSTDIO">Domain logfile</a></h5>

    <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>


    <h5><a name="elementsCharFle">Device logfile</a></h5>

    <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>

    <h5><a name="elementsCharVC">Virtual console</a></h5>

    <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>

    <h5><a name="elementsCharNull">Null device</a></h5>

    <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>

    <h5><a name="elementsCharPTY">Pseudo TTY</a></h5>

    <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
      path is also duplicated as an attribute tty='/dv/pts/3'
      on the top level &lt;console&gt; tag. This provides compat
      with existing syntax for &lt;console&gt; tags.
    </p>

    <h5><a name="elementsCharHost">Host device proxy</a></h5>

    <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 host serial port - dont connect a serial port to a parallel
      port.
    </p>

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

    <h5><a name="elementsCharTCP">TCP client/server</a></h5>

    <p>
      The character device acts as a TCP client connecting to a
      remote server, or as a server waiting for a client connection.
    </p>

    <pre>
      ...
      &lt;serial type="tcp"&gt;
        &lt;source mode="connect" host="0.0.0.0" service="2445"/&gt;
        &lt;wiremode type="telnet"/&gt;
        &lt;target port="1"/&gt;
      &lt;/serial&gt;
      ...</pre>

    <h5><a name="elementsCharUDP">UDP network console</a></h5>

    <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>

    <h5><a name="elementsCharUNIX">UNIX domain socket client/server</a></h5>

    <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>

    <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 已提交
788 789 790 791 792 793 794 795 796 797 798 799 

    <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>