~ubuntu-branches/ubuntu/quantal/virtinst/quantal-proposed
» Revision
43
: .pc/9005_ubuntu_releases.patch/man/en/virt-install.pod
« back to all changes in this revision
Viewing changes to .pc/9005_ubuntu_releases.patch/man/en/virt-install.pod
- browse files at revision 43
- compare with another revision
- download diff
- download tarball
- view history from revision 43
- Committer: Package Import Robot
- Author(s): Marc Deslauriers
- Date: 2012-07-24 08:52:01 UTC
- mfrom: (1.6.8 sid)
- Revision ID: package-import@ubuntu.com-20120724085201-q3h0cbabg4t46gfm
Tags: 0.600.2-1ubuntu1
* Merge from debian unstable. Remaining changes:
- debian/patches/9003-fix-path-to-hvmloader-in-testsuite.patch: adjust
testsuite for 0001-fix-path-to-hvmloader.patch and
0002-Fix-path-to-pygrub.patch.
- debian/patches/9004_ubuntu_fix_tree_support.patch: Fix tree detection
for all ISO/HTTP source, to not longer fail with cobbler/koan.
- debian/patches/0004-Fix-path-to-qemu-dm.patch: fix the path to the
qemu-dm binary.
- debian/{control,rules,pyversions}: Build using dh_python2, use
debhelper v8 instead of cdbs; for some reason the package build an
empty binary package when using dh_python2.
- debian/control: added acl package to depends.
- debian/control: added libvirt-bin to recommends
* Dropped patches:
- debian/patches/9005_ubuntu_releases.patch: Upstream
- debian/patches/9003-fix-path-to-hvmloader-in-testsuite.patch: adjust
testsuite for 0001-fix-path-to-hvmloader.patch and
0002-Fix-path-to-pygrub.patch.
- debian/patches/9004_ubuntu_fix_tree_support.patch: Fix tree detection
for all ISO/HTTP source, to not longer fail with cobbler/koan.
- debian/patches/0004-Fix-path-to-qemu-dm.patch: fix the path to the
qemu-dm binary.
- debian/{control,rules,pyversions}: Build using dh_python2, use
debhelper v8 instead of cdbs; for some reason the package build an
empty binary package when using dh_python2.
- debian/control: added acl package to depends.
- debian/control: added libvirt-bin to recommends
* Dropped patches:
- debian/patches/9005_ubuntu_releases.patch: Upstream
- files added:
- .pc/.quilt_patches
- tests/cli-test-xml/fakefedoratree
- tests/cli-test-xml/fakefedoratree/images
- tests/cli-test-xml/fakefedoratree/images/pxeboot
- tests/cli-test-xml/fakefedoratree/images/xen
- tests/scriptimports
- tests/scriptimports/virtclone.py
- tests/scriptimports/virtconvert.py
- tests/scriptimports/virtimage.py
- tests/scriptimports/virtinstall.py
- files removed:
- .pc/0004-Fix-location-of-Debian-daily-builds.patch
- .pc/0004-Fix-location-of-Debian-daily-builds.patch/virtinst
- .pc/9005_ubuntu_releases.patch
- .pc/9005_ubuntu_releases.patch/man
- .pc/9005_ubuntu_releases.patch/man/en
- .pc/9005_ubuntu_releases.patch/virtinst
- files modified:
- .pc/0001-fix-path-to-hvmloader.patch/virtinst/Installer.py
added
removed
.pc/9005_ubuntu_releases.patch/man/en/virt-install.pod
1
=pod
2
3
=head1 NAME
4
5
virt-install - provision new virtual machines
6
7
=head1 SYNOPSIS
8
9
B<virt-install> [OPTION]...
10
11
=head1 DESCRIPTION
12
13
B<virt-install> is a command line tool for creating new KVM, Xen, or Linux
14
container guests using the C<libvirt> hypervisor management library.
15
See the EXAMPLES section at the end of this document to quickly get started.
16
17
B<virt-install> tool supports both text based & graphical installations,
18
using VNC or SDL graphics, or a text serial console. The guest can be
19
configured to use one or more virtual disks, network interfaces,
20
audio devices, physical USB or PCI devices, among others.
21
22
The installation media can be held locally or remotely on NFS, HTTP, FTP
23
servers. In the latter case C<virt-install> will fetch the minimal files
24
necessary to kick off the installation process, allowing the guest
25
to fetch the rest of the OS distribution as needed. PXE booting, and importing
26
an existing disk image (thus skipping the install phase) are also supported.
27
28
Given suitable command line arguments, C<virt-install> is capable of running
29
completely unattended, with the guest 'kickstarting' itself too. This allows
30
for easy automation of guest installs. An interactive mode is also available
31
with the --prompt option, but this will only ask for the minimum required
32
options.
33
34
=head1 OPTIONS
35
36
Most options are not required. Minimum requirements are --name, --ram,
37
guest storage (--disk, --filesystem or --nodisks), and an install option.
38
39
=over 2
40
41
=item -h, --help
42
43
Show the help message and exit
44
45
=item --connect=CONNECT
46
47
Connect to a non-default hypervisor. The default connection is chosen based
48
on the following rules:
49
50
=over 4
51
52
=item xen
53
54
If running on a host with the Xen kernel (checks against /proc/xen)
55
56
=item qemu:///system
57
58
If running on a bare metal kernel as root (needed for KVM installs)
59
60
=item qemu:///session
61
62
If running on a bare metal kernel as non-root
63
64
It is only necessary to provide the C<--connect> argument if this default
65
prioritization is incorrect, eg if wanting to use QEMU while on a Xen kernel.
66
67
=back
68
69
=back
70
71
=head2 General Options
72
73
General configuration parameters that apply to all types of guest installs.
74
75
=over 2
76
77
=item -n NAME, --name=NAME
78
79
Name of the new guest virtual machine instance. This must be unique amongst
80
all guests known to the hypervisor on the connection, including those not
81
currently active. To re-define an existing guest, use the C<virsh(1)> tool
82
to shut it down ('virsh shutdown') & delete ('virsh undefine') it prior to
83
running C<virt-install>.
84
85
=item -r MEMORY, --ram=MEMORY
86
87
Memory to allocate for guest instance in megabytes. If the hypervisor does
88
not have enough free memory, it is usual for it to automatically take memory
89
away from the host operating system to satisfy this allocation.
90
91
=item --arch=ARCH
92
93
Request a non-native CPU architecture for the guest virtual machine.
94
If omitted, the host CPU architecture will be used in the guest.
95
96
=item --machine=MACHINE
97
98
The machine type to emulate. This will typically not need to be specified
99
for Xen or KVM, but is useful for choosing machine types of more exotic
100
architectures.
101
102
=item -u UUID, --uuid=UUID
103
104
UUID for the guest; if none is given a random UUID will be generated. If you
105
specify UUID, you should use a 32-digit hexadecimal number. UUID are intended
106
to be unique across the entire data center, and indeed world. Bear this in
107
mind if manually specifying a UUID
108
109
=item --vcpus=VCPUS[,maxvcpus=MAX][,sockets=#][,cores=#][,threads=#]
110
111
Number of virtual cpus to configure for the guest. If 'maxvcpus' is specified,
112
the guest will be able to hotplug up to MAX vcpus while the guest is running,
113
but will startup with VCPUS.
114
115
CPU topology can additionally be specified with sockets, cores, and threads.
116
If values are omitted, the rest will be autofilled prefering sockets over
117
cores over threads.
118
119
=item --cpuset=CPUSET
120
121
Set which physical cpus the guest can use. C<CPUSET> is a comma separated list of numbers, which can also be specified in ranges or cpus to exclude. Example:
122
123
0,2,3,5 : Use processors 0,2,3 and 5
124
1-5,^3,8 : Use processors 1,2,4,5 and 8
125
126
If the value 'auto' is passed, virt-install attempts to automatically determine
127
an optimal cpu pinning using NUMA data, if available.
128
129
=item --numatune=NODESET,[mode=MODE]
130
131
Tune NUMA policy for the domain process. Example invocations
132
133
--numatune 1,2,3,4-7
134
--numatune \"1-3,5\",mode=preferred
135
136
Specifies the numa nodes to allocate memory from. This has the same syntax
137
as C<--cpuset> option. mode can be one of 'interleave', 'preferred', or
138
'strict' (the default). See 'man 8 numactl' for information about each
139
mode.
140
141
The nodeset string must use escaped-quotes if specifying any other option.
142
143
=item --cpu MODEL[,+feature][,-feature][,match=MATCH][,vendor=VENDOR]
144
145
Configure the CPU model and CPU features exposed to the guest. The only
146
required value is MODEL, which is a valid CPU model as listed in libvirt's
147
cpu_map.xml file.
148
149
Specific CPU features can be specified in a number of ways: using one of
150
libvirt's feature policy values force, require, optional, disable, or forbid,
151
or with the shorthand '+feature' and '-feature', which equal 'force=feature'
152
and 'disable=feature' respectively
153
154
Some examples:
155
156
=over 2
157
158
=item B<--cpu core2duo,+x2apic,disable=vmx>
159
160
Expose the core2duo CPU model, force enable x2apic, but do not expose vmx
161
162
=item B<--cpu host>
163
164
Expose the host CPUs configuration to the guest. This enables the guest to
165
take advantage of many of the host CPUs features (better performance), but
166
may cause issues if migrating the guest to a host without an identical CPU.
167
168
=back
169
170
=item --description
171
172
Human readable text description of the virtual machine. This will be stored
173
in the guests XML configuration for access by other applications.
174
175
=item --security type=TYPE[,label=LABEL][,relabel=yes|no]
176
177
Configure domain security driver settings. Type can be either 'static' or
178
'dynamic'. 'static' configuration requires a security LABEL. Specifying
179
LABEL without TYPE implies static configuration. To have libvirt automatically
180
apply your static label, you must specify relabel=yes.
181
182
=back
183
184
185
186
187
188
=head2 Installation Method options
189
190
=over 2
191
192
=item -c CDROM, --cdrom=CDROM
193
194
File or device use as a virtual CD-ROM device for fully virtualized guests.
195
It can be path to an ISO image, or to a CDROM device. It can also be a URL
196
from which to fetch/access a minimal boot ISO image. The URLs take the same
197
format as described for the C<--location> argument. If a cdrom has been
198
specified via the C<--disk> option, and neither C<--cdrom> nor any other
199
install option is specified, the C<--disk> cdrom is used as the install media.
200
201
=item -l LOCATION, --location=LOCATION
202
203
Distribution tree installtion source. virt-install can recognize
204
certain distribution trees and fetches a bootable kernel/initrd pair to
205
launch the install.
206
207
With libvirt 0.9.4 or later, network URL installs work for remote connections.
208
virt-install will download kernel/initrd to the local machine, and then
209
upload the media to the remote host. This option requires the URL to
210
be accessible by both the local and remote host.
211
212
The C<LOCATION> can take one of the following forms:
213
214
=over 4
215
216
=item DIRECTORY
217
218
Path to a local directory containing an installable distribution image
219
220
=item nfs:host:/path or nfs://host/path
221
222
An NFS server location containing an installable distribution image
223
224
=item http://host/path
225
226
An HTTP server location containing an installable distribution image
227
228
=item ftp://host/path
229
230
An FTP server location containing an installable distribution image
231
232
=back
233
234
Some distro specific url samples:
235
236
=over 4
237
238
=item Fedora/Red Hat Based
239
240
http://download.fedoraproject.org/pub/fedora/linux/releases/10/Fedora/i386/os/
241
242
=item Debian/Ubuntu
243
244
http://ftp.us.debian.org/debian/dists/etch/main/installer-amd64/
245
246
=item Suse
247
248
http://download.opensuse.org/distribution/11.0/repo/oss/
249
250
=item Mandriva
251
252
ftp://ftp.uwsg.indiana.edu/linux/mandrake/official/2009.0/i586/
253
254
=item Mageia
255
256
ftp://distrib-coffee.ipsl.jussieu.fr/pub/linux/Mageia/distrib/1
257
258
=back
259
260
=item --pxe
261
262
Use the PXE boot protocol to load the initial ramdisk and kernel for starting
263
the guest installation process.
264
265
=item --import
266
267
Skip the OS installation process, and build a guest around an existing
268
disk image. The device used for booting is the first device specified via
269
C<--disk> or C<--filesystem>.
270
271
=item --init=INITPATH
272
273
Path to a binary that the container guest will init. If a root C<--filesystem>
274
is has been specified, virt-install will default to /sbin/init, otherwise
275
will default to /bin/sh.
276
277
=item --livecd
278
279
Specify that the installation media is a live CD and thus the guest
280
needs to be configured to boot off the CDROM device permanently. It
281
may be desirable to also use the C<--nodisks> flag in combination.
282
283
=item -x EXTRA, --extra-args=EXTRA
284
285
Additional kernel command line arguments to pass to the installer when
286
performing a guest install from C<--location>. One common usage is specifying
287
an anaconda kickstart file for automated installs, such as
288
--extra-args "ks=http://myserver/my.ks"
289
290
=item --initrd-inject=PATH
291
292
Add PATH to the root of the initrd fetched with C<--location>. This can be
293
used to run an automated install without requiring a network hosted kickstart
294
file:
295
296
--initrd-inject=/path/to/my.ks --extra-args "ks=file:/my.ks"
297
298
=item --os-type=OS_TYPE
299
300
Optimize the guest configuration for a type of operating system (ex. 'linux',
301
'windows'). This will attempt to pick the most suitable ACPI & APIC settings,
302
optimally supported mouse drivers, virtio, and generally accommodate other
303
operating system quirks.
304
305
By default, virt-install will attempt to auto detect this value from
306
the install media (currently only supported for URL installs). Autodetection
307
can be disabled with the special value 'none'
308
309
See C<--os-variant> for valid options.
310
311
=item --os-variant=OS_VARIANT
312
313
Further optimize the guest configuration for a specific operating system
314
variant (ex. 'fedora8', 'winxp'). This parameter is optional, and does not
315
require an C<--os-type> to be specified.
316
317
By default, virt-install will attempt to auto detect this value from
318
the install media (currently only supported for URL installs). Autodetection
319
can be disabled with the special value 'none'.
320
321
If the special value 'list' is passed, virt-install will print the full
322
list of variant values and exit. The printed format is not a stable
323
interface, DO NOT PARSE IT.
324
325
If the special value 'none' is passed, no os variant is recorded and
326
OS autodetection is disabled.
327
328
Values for some recent OS options are:
329
330
=over 2
331
332
=item win7 : Microsoft Windows 7
333
334
=item vista : Microsoft Windows Vista
335
336
=item winxp64 : Microsoft Windows XP (x86_64)
337
338
=item winxp : Microsoft Windows XP
339
340
=item win2k8 : Microsoft Windows Server 2008
341
342
=item win2k3 : Microsoft Windows Server 2003
343
344
=item freebsd8 : FreeBSD 8.x
345
346
=item generic : Generic
347
348
=item debianwheezy : Debian Wheezy
349
350
=item debiansqueeze : Debian Squeeze
351
352
=item debianlenny : Debian Lenny
353
354
=item fedora16 : Fedora 16
355
356
=item fedora15 : Fedora 15
357
358
=item fedora14 : Fedora 14
359
360
=item mageia1 : Mageia 1 and later
361
362
=item mes5.1 : Mandriva Enterprise Server 5.1 and later
363
364
=item mandriva2010 : Mandriva Linux 2010 and later
365
366
=item rhel6 : Red Hat Enterprise Linux 6
367
368
=item rhel5.4 : Red Hat Enterprise Linux 5.4 or later
369
370
=item rhel4 : Red Hat Enterprise Linux 4
371
372
=item sles11 : Suse Linux Enterprise Server 11
373
374
=item sles10 : Suse Linux Enterprise Server
375
376
=item opensuse12 : openSuse 12
377
378
=item opensuse11 : openSuse 11
379
380
=item ubuntuoneiric : Ubuntu 11.10 (Oneiric Ocelot)
381
382
=item ubuntunatty : Ubuntu 11.04 (Natty Narwhal)
383
384
=item ubuntumaverick : Ubuntu 10.10 (Maverick Meerkat)
385
386
=item ubuntulucid : Ubuntu 10.04 (Lucid Lynx)
387
388
=item ubuntuhardy : Ubuntu 8.04 LTS (Hardy Heron)
389
390
=back
391
392
393
394
Use '--os-variant list' to see the full OS list
395
396
=item --boot=BOOTOPTS
397
398
Optionally specify the post-install VM boot configuration. This option allows
399
specifying a boot device order, permanently booting off kernel/initrd with
400
option kernel arguments, and enabling a BIOS boot menu (requires libvirt
401
0.8.3 or later)
402
403
--boot can be specified in addition to other install options
404
(such as --location, --cdrom, etc.) or can be specified on it's own. In
405
the latter case, behavior is similar to the --import install option: there
406
is no 'install' phase, the guest is just created and launched as specified.
407
408
Some examples:
409
410
=over 2
411
412
=item B<--boot cdrom,fd,hd,network,menu=on>
413
414
Set the boot device priority as first cdrom, first floppy, first harddisk,
415
network PXE boot. Additionally enable BIOS boot menu prompt.
416
417
=item B<--boot kernel=KERNEL,initrd=INITRD,kernel_args="console=/dev/ttyS0">
418
419
Have guest permanently boot off a local kernel/initrd pair, with the
420
specified kernel options.
421
422
=back
423
424
=back
425
426
427
428
429
430
=head2 Storage Configuration
431
432
=over 2
433
434
=item --disk=DISKOPTS
435
436
Specifies media to use as storage for the guest, with various options. The
437
general format of a disk string is
438
439
--disk opt1=val1,opt2=val2,...
440
441
To specify media, the command can either be:
442
443
--disk /some/storage/path,opt1=val1
444
445
or explicitly specify one of the following arguments:
446
447
=over 4
448
449
=item B<path>
450
451
A path to some storage media to use, existing or not. Existing media can be
452
a file or block device. If installing on a remote host, the existing media
453
must be shared as a libvirt storage volume.
454
455
Specifying a non-existent path implies attempting to create the new storage,
456
and will require specifyng a 'size' value. If the base directory of the path
457
is a libvirt storage pool on the host, the new storage will be created as a
458
libvirt storage volume. For remote hosts, the base directory is required to be
459
a storage pool if using this method.
460
461
=item B<pool>
462
463
An existing libvirt storage pool name to create new storage on. Requires
464
specifying a 'size' value.
465
466
=item B<vol>
467
468
An existing libvirt storage volume to use. This is specified as
469
'poolname/volname'.
470
471
=back
472
473
Other available options:
474
475
=over 4
476
477
=item B<device>
478
479
Disk device type. Value can be 'cdrom', 'disk', or 'floppy'. Default is
480
'disk'. If a 'cdrom' is specified, and no install method is chosen, the
481
cdrom is used as the install media.
482
483
=item B<bus>
484
485
Disk bus type. Value can be 'ide', 'sata', 'scsi', 'usb', 'virtio' or 'xen'.
486
The default is hypervisor dependent since not all hypervisors support all
487
bus types.
488
489
=item B<perms>
490
491
Disk permissions. Value can be 'rw' (Read/Write), 'ro' (Readonly),
492
or 'sh' (Shared Read/Write). Default is 'rw'
493
494
=item B<size>
495
496
size (in GB) to use if creating new storage
497
498
=item B<sparse>
499
500
whether to skip fully allocating newly created storage. Value is 'true' or
501
'false'. Default is 'true' (do not fully allocate).
502
503
The initial time taken to fully-allocate the guest virtual disk (sparse=false)
504
will be usually by balanced by faster install times inside the guest. Thus
505
use of this option is recommended to ensure consistently high performance
506
and to avoid I/O errors in the guest should the host filesystem fill up.
507
508
=item B<cache>
509
510
The cache mode to be used. The host pagecache provides cache memory.
511
The cache value can be 'none', 'writethrough', or 'writeback'.
512
'writethrough' provides read caching. 'writeback' provides
513
read and write caching.
514
515
=item B<format>
516
517
Image format to be used if creating managed storage. For file volumes, this
518
can be 'raw', 'qcow2', 'vmdk', etc. See format types in
519
L<http://libvirt.org/storage.html> for possible values. This is often
520
mapped to the B<driver_type> value as well.
521
522
With libvirt 0.8.3 and later, this option should be specified if reusing
523
and existing disk image, since libvirt does not autodetect storage format
524
as it is a potential security issue. For example, if reusing an existing
525
qcow2 image, you will want to specify format=qcow2, otherwise the hypervisor
526
may not be able to read your disk image.
527
528
=item B<driver_name>
529
530
Driver name the hypervisor should use when accessing the specified
531
storage. Typically does not need to be set by the user.
532
533
=item B<driver_type>
534
535
Driver format/type the hypervisor should use when accessing the specified
536
storage. Typically does not need to be set by the user.
537
538
=item B<io>
539
540
Disk IO backend. Can be either "threads" or "native".
541
542
=item B<error_policy>
543
544
How guest should react if a write error is encountered. Can be one of
545
"stop", "ignore", or "enospace"
546
547
=item B<serial>
548
549
Serial number of the emulated disk device. This is used in linux guests
550
to set /dev/disk/by-id symlinks. An example serial number might be:
551
WD-WMAP9A966149
552
553
=back
554
555
See the examples section for some uses. This option deprecates C<--file>,
556
C<--file-size>, and C<--nonsparse>.
557
558
=item --filesystem
559
560
Specifies a directory on the host to export to the guest. The most simple
561
invocation is:
562
563
--filesystem /source/on/host,/target/point/in/guest
564
565
Which will work for recent QEMU and linux guest OS or LXC containers. For
566
QEMU, the target point is just a mounting hint in sysfs, so will not be
567
automatically mounted.
568
569
The following explicit options can be specified:
570
571
=over 4
572
573
=item B<type>
574
575
The type or the source directory. Valid values are 'mount' (the default) or
576
'template' for OpenVZ templates.
577
578
=item B<mode>
579
580
The access mode for the source directory from the guest OS. Only used with
581
QEMU and type=mount. Valid modes are 'passthrough' (the default), 'mapped',
582
or 'squash'. See libvirt domain XML documentation for more info.
583
584
=item B<source>
585
586
The directory on the host to share.
587
588
=item B<target>
589
590
The mount location to use in the guest.
591
592
=back
593
594
=item --nodisks
595
596
Request a virtual machine without any local disk storage, typically used for
597
running 'Live CD' images or installing to network storage (iSCSI or NFS root).
598
599
=item -f DISKFILE, --file=DISKFILE
600
601
This option is deprecated in favor of C<--disk path=DISKFILE>.
602
603
=item -s DISKSIZE, --file-size=DISKSIZE
604
605
This option is deprecated in favor of C<--disk ...,size=DISKSIZE,...>
606
607
=item --nonsparse
608
609
This option is deprecated in favor of C<--disk ...,sparse=false,...>
610
611
=back
612
613
614
615
616
617
=head2 Networking Configuration
618
619
=over 2
620
621
=item -w NETWORK, --network=NETWORK,opt1=val1,opt2=val2
622
623
Connect the guest to the host network. The value for C<NETWORK> can take
624
one of 3 formats:
625
626
=over 4
627
628
=item bridge=BRIDGE
629
630
Connect to a bridge device in the host called C<BRIDGE>. Use this option if
631
the host has static networking config & the guest requires full outbound
632
and inbound connectivity to/from the LAN. Also use this if live migration
633
will be used with this guest.
634
635
=item network=NAME
636
637
Connect to a virtual network in the host called C<NAME>. Virtual networks
638
can be listed, created, deleted using the C<virsh> command line tool. In
639
an unmodified install of C<libvirt> there is usually a virtual network
640
with a name of C<default>. Use a virtual network if the host has dynamic
641
networking (eg NetworkManager), or using wireless. The guest will be
642
NATed to the LAN by whichever connection is active.
643
644
=item user
645
646
Connect to the LAN using SLIRP. Only use this if running a QEMU guest as
647
an unprivileged user. This provides a very limited form of NAT.
648
649
=back
650
651
If this option is omitted a single NIC will be created in the guest. If
652
there is a bridge device in the host with a physical interface enslaved,
653
that will be used for connectivity. Failing that, the virtual network
654
called C<default> will be used. This option can be specified multiple
655
times to setup more than one NIC.
656
657
Other available options are:
658
659
=over 4
660
661
=item B<model>
662
663
Network device model as seen by the guest. Value can be any nic model supported
664
by the hypervisor, e.g.: 'e1000', 'rtl8139', 'virtio', ...
665
666
=item B<mac>
667
668
Fixed MAC address for the guest; If this parameter is omitted, or the value
669
C<RANDOM> is specified a suitable address will be randomly generated. For
670
Xen virtual machines it is required that the first 3 pairs in the MAC address
671
be the sequence '00:16:3e', while for QEMU or KVM virtual machines it must
672
be '52:54:00'.
673
674
=back
675
676
=item --nonetworks
677
678
Request a virtual machine without any network interfaces.
679
680
=item -b BRIDGE, --bridge=BRIDGE
681
682
This parameter is deprecated in favour of
683
C<--network bridge=bridge_name>.
684
685
=item -m MAC, --mac=MAC
686
687
This parameter is deprecated in favour of C<--network NETWORK,mac=12:34...>
688
689
=back
690
691
692
693
694
695
=head2 Graphics Configuration
696
697
If no graphics option is specified, C<virt-install> will default to
698
'--graphics vnc' if the DISPLAY environment variable is set, otherwise
699
'--graphics none' is used.
700
701
=over 2
702
703
=item --graphics TYPE,opt1=arg1,opt2=arg2,...
704
705
Specifies the graphical display configuration. This does not configure any
706
virtual hardware, just how the guest's graphical display can be accessed.
707
Typically the user does not need to specify this option, virt-install will
708
try and choose a useful default, and launch a suitable connection.
709
710
General format of a graphical string is
711
712
--graphics TYPE,opt1=arg1,opt2=arg2,...
713
714
For example:
715
716
--graphics vnc,password=foobar
717
718
The supported options are:
719
720
=over 4
721
722
=item B<type>
723
724
The display type. This is one of:
725
726
vnc
727
728
Setup a virtual console in the guest and export it as a VNC server in
729
the host. Unless the C<port> parameter is also provided, the VNC
730
server will run on the first free port number at 5900 or above. The
731
actual VNC display allocated can be obtained using the C<vncdisplay>
732
command to C<virsh> (or L<virt-viewer(1)> can be used which handles this
733
detail for the use).
734
735
sdl
736
737
Setup a virtual console in the guest and display an SDL window in the
738
host to render the output. If the SDL window is closed the guest may
739
be unconditionally terminated.
740
741
spice
742
743
Export the guest's console using the Spice protocol. Spice allows advanced
744
features like audio and USB device streaming, as well as improved graphical
745
performance.
746
747
Using spice graphic type will work as if those arguments were given:
748
749
--video qxl --channel spicevmc
750
751
none
752
753
No graphical console will be allocated for the guest. Fully virtualized guests
754
(Xen FV or QEmu/KVM) will need to have a text console configured on the first
755
serial port in the guest (this can be done via the --extra-args option). Xen
756
PV will set this up automatically. The command 'virsh console NAME' can be
757
used to connect to the serial device.
758
759
=item B<port>
760
761
Request a permanent, statically assigned port number for the guest
762
console. This is used by 'vnc' and 'spice'
763
764
=item B<tlsport>
765
766
Specify the spice tlsport.
767
768
=item B<listen>
769
770
Address to listen on for VNC/Spice connections. Default is typically 127.0.0.1
771
(localhost only), but some hypervisors allow changing this globally (for
772
example, the qemu driver default can be changed in /etc/libvirt/qemu.conf).
773
Use 0.0.0.0 to allow access from other machines. This is use by 'vnc' and
774
'spice'
775
776
=item B<keymap>
777
778
Request that the virtual VNC console be configured to run with a specific
779
keyboard layout. If the special value 'local' is specified, virt-install
780
will attempt to configure to use the same keymap as the local system. A value
781
of 'none' specifically defers to the hypervisor. Default behavior is
782
hypervisor specific, but typically is the same as 'local'. This is used
783
by 'vnc'
784
785
=item B<password>
786
787
Request a VNC password, required at connection time. Beware, this info may
788
end up in virt-install log files, so don't use an important password. This
789
is used by 'vnc' and 'spice'
790
791
=item B<passwordvalidto>
792
793
Set an expiration date for password. After the date/time has passed,
794
all new graphical connections are denyed until a new password is set.
795
This is used by 'vnc' and 'spice'
796
797
The format for this value is YYYY-MM-DDTHH:MM:SS, for example
798
2011-04-01T14:30:15
799
800
=back
801
802
=item --vnc
803
804
This option is deprecated in favor of C<--graphics vnc,...>
805
806
=item --vncport=VNCPORT
807
808
This option is deprecated in favor of C<--graphics vnc,port=PORT,...>
809
810
=item --vnclisten=VNCLISTEN
811
812
This option is deprecated in favor of C<--graphics vnc,listen=LISTEN,...>
813
814
=item -k KEYMAP, --keymap=KEYMAP
815
816
This option is deprecated in favor of C<--graphics vnc,keymap=KEYMAP,...>
817
818
=item --sdl
819
820
This option is deprecated in favor of C<--graphics sdl,...>
821
822
=item --nographics
823
824
This option is deprecated in favor of C<--graphics none>
825
826
=item --noautoconsole
827
828
Don't automatically try to connect to the guest console. The default behaviour
829
is to launch a VNC client to display the graphical console, or to run the
830
C<virsh> C<console> command to display the text console. Use of this parameter
831
will disable this behaviour.
832
833
=back
834
835
836
837
838
=head2 Virtualization Type options
839
840
Options to override the default virtualization type choices.
841
842
=over 2
843
844
=item -v, --hvm
845
846
Request the use of full virtualization, if both para & full virtualization are
847
available on the host. This parameter may not be available if connecting to a
848
Xen hypervisor on a machine without hardware virtualization support. This
849
parameter is implied if connecting to a QEMU based hypervisor.
850
851
=item -p, --paravirt
852
853
This guest should be a paravirtualized guest. If the host supports both
854
para & full virtualization, and neither this parameter nor the C<--hvm>
855
are specified, this will be assumed.
856
857
=item --container
858
859
This guest should be a container type guest. This option is only required
860
if the hypervisor supports other guest types as well (so for example this
861
option is the default behavior for LXC and OpenVZ, but is provided for
862
completeness).
863
864
=item --virt-type
865
866
The hypervisor to install on. Example choices are kvm, qemu, xen, or kqemu.
867
Available options are listed via 'virsh capabilities' in the <domain> tags.
868
869
=item --accelerate
870
871
Prefer KVM or KQEMU (in that order) if installing a QEMU guest. This behavior
872
is now the default, and this option is deprecated. To install a plain QEMU
873
guest, use '--virt-type qemu'
874
875
=item --noapic
876
877
Force disable APIC for the guest.
878
879
=item --noacpi
880
881
Force disable ACPI for the guest.
882
883
=back
884
885
886
887
888
889
=head2 Device Options
890
891
=over 2
892
893
=item --controller=TYPE[,OPTS]
894
895
Attach a controller device to the guest. TYPE is one of:
896
B<ide>, B<fdc>, B<scsi>, B<sata>, B<virtio-serial>, or B<usb>.
897
898
=over 4
899
900
=item B<model>
901
902
Controller model.
903
904
=item B<address>
905
906
Controller address, current PCI of form 'bus:domain:slot:function'.
907
908
=item B<index>
909
910
A decimal integer describing in which order the bus controller is
911
encountered, and to reference the controller bus.
912
913
=item B<master>
914
915
Applicable to USB companion controllers, to define the master bus startport.
916
917
=back
918
919
Example:
920
921
=over 4
922
923
=item B<--controller usb,model=ich9-uhci2,address=0:0:4.7,index=0,master=2>
924
925
Adds a ICH9 USB companion controller on PCI address 0:0:4.7 with
926
master bus 0 and first port 2.
927
928
=back
929
930
=item --host-device=HOSTDEV
931
932
Attach a physical host device to the guest. Some example values for HOSTDEV:
933
934
=over 2
935
936
=item B<--host-device pci_0000_00_1b_0>
937
938
A node device name via libvirt, as shown by 'virsh nodedev-list'
939
940
=item B<--host-device 001.003>
941
942
USB by bus, device (via lsusb).
943
944
=item B<--host-device 0x1234:0x5678>
945
946
USB by vendor, product (via lsusb).
947
948
=item B<--host-device 1f.01.02>
949
950
PCI device (via lspci).
951
952
=back
953
954
=item --soundhw MODEL
955
956
Attach a virtual audio device to the guest. MODEL specifies the emulated
957
sound card model. Possible values are ich6, ac97, es1370, sb16, pcspk,
958
or default. 'default' will be AC97 if the hypervisor supports it,
959
otherwise it will be ES1370.
960
961
This deprecates the old boolean --sound model (which still works the same
962
as a single '--soundhw default')
963
964
=item --watchdog MODEL[,action=ACTION]
965
966
Attach a virtual hardware watchdog device to the guest. This requires a
967
daemon and device driver in the guest. The watchdog fires a signal when
968
the virtual machine appears to hung. ACTION specifies what libvirt will do
969
when the watchdog fires. Values are
970
971
=over 4
972
973
=item B<reset>
974
975
Forcefully reset the guest (the default)
976
977
=item B<poweroff>
978
979
Forcefully power off the guest
980
981
=item B<pause>
982
983
Pause the guest
984
985
=item B<none>
986
987
Do nothing
988
989
=item B<shutdown>
990
991
Gracefully shutdown the guest (not recommended, since a hung guest probably
992
won't respond to a graceful shutdown)
993
994
=back
995
996
MODEL is the emulated device model: either i6300esb (the default) or ib700.
997
Some examples:
998
999
Use the recommended settings:
1000
1001
--watchdog default
1002
1003
Use the i6300esb with the 'poweroff' action
1004
1005
--watchdog i6300esb,action=poweroff
1006
1007
=item --parallel=CHAROPTS
1008
1009
=item --serial=CHAROPTS
1010
1011
Specifies a serial device to attach to the guest, with various options. The
1012
general format of a serial string is
1013
1014
--serial type,opt1=val1,opt2=val2,...
1015
1016
--serial and --parallel devices share all the same options, unless otherwise
1017
noted. Some of the types of character device redirection are:
1018
1019
=over 4
1020
1021
=item B<--serial pty>
1022
1023
Pseudo TTY. The allocated pty will be listed in the running guests XML
1024
description.
1025
1026
=item B<--serial dev,path=HOSTPATH>
1027
1028
Host device. For serial devices, this could be /dev/ttyS0. For parallel
1029
devices, this could be /dev/parport0.
1030
1031
=item B<--serial file,path=FILENAME>
1032
1033
Write output to FILENAME.
1034
1035
=item B<--serial pipe,path=PIPEPATH>
1036
1037
Named pipe (see pipe(7))
1038
1039
=item B<--serial tcp,host=HOST:PORT,mode=MODE,protocol=PROTOCOL>
1040
1041
TCP net console. MODE is either 'bind' (wait for connections on HOST:PORT)
1042
or 'connect' (send output to HOST:PORT), default is 'bind'. HOST defaults
1043
to '127.0.0.1', but PORT is required. PROTOCOL can be either 'raw' or 'telnet'
1044
(default 'raw'). If 'telnet', the port acts like a telnet server or client.
1045
Some examples:
1046
1047
Wait for connections on any address, port 4567:
1048
1049
--serial tcp,host=0.0.0.0:4567
1050
1051
Connect to localhost, port 1234:
1052
1053
--serial tcp,host=:1234,mode=connect
1054
1055
Wait for telnet connection on localhost, port 2222. The user could then
1056
connect interactively to this console via 'telnet localhost 2222':
1057
1058
--serial tcp,host=:2222,mode=bind,protocol=telnet
1059
1060
=item B<--serial udp,host=CONNECT_HOST:PORT,bind_host=BIND_HOST:BIND_PORT>
1061
1062
UDP net console. HOST:PORT is the destination to send output to (default
1063
HOST is '127.0.0.1', PORT is required). BIND_HOST:BIND_PORT is the optional
1064
local address to bind to (default BIND_HOST is 127.0.0.1, but is only set if
1065
BIND_PORT is specified). Some examples:
1066
1067
Send output to default syslog port (may need to edit /etc/rsyslog.conf
1068
accordingly):
1069
1070
--serial udp,host=:514
1071
1072
Send output to remote host 192.168.10.20, port 4444 (this output can be
1073
read on the remote host using 'nc -u -l 4444'):
1074
1075
--serial udp,host=192.168.10.20:4444
1076
1077
=item B<--serial unix,path=UNIXPATH,mode=MODE>
1078
1079
Unix socket, see unix(7). MODE has similar behavior and defaults as
1080
--serial tcp,mode=MODE
1081
1082
=back
1083
1084
=item --channel
1085
1086
Specifies a communication channel device to connect the guest and host
1087
machine. This option uses the same options as --serial and --parallel
1088
for specifying the host/source end of the channel. Extra 'target' options
1089
are used to specify how the guest machine sees the channel.
1090
1091
Some of the types of character device redirection are:
1092
1093
=over 4
1094
1095
=item B<--channel SOURCE,target_type=guestfwd,target_address=HOST:PORT>
1096
1097
Communication channel using QEMU usermode networking stack. The guest can
1098
connect to the channel using the specified HOST:PORT combination.
1099
1100
=item B<--channel SOURCE,target_type=virtio[,name=NAME]>
1101
1102
Communication channel using virtio serial (requires 2.6.34 or later host and
1103
guest). Each instance of a virtio --channel line is exposed in the
1104
guest as /dev/vport0p1, /dev/vport0p2, etc. NAME is optional metadata, and
1105
can be any string, such as org.linux-kvm.virtioport1.
1106
If specified, this will be exposed in the guest at
1107
/sys/class/virtio-ports/vport0p1/NAME
1108
1109
=item B<--channel spicevmc,target_type=virtio[,name=NAME]>
1110
1111
Communication channel for QEMU spice agent, using virtio serial
1112
(requires 2.6.34 or later host and guest). NAME is optional metadata,
1113
and can be any string, such as the default com.redhat.spice.0 that
1114
specifies how the guest will see the channel.
1115
1116
=back
1117
1118
=item --console
1119
1120
Connect a text console between the guest and host. Certain guest and
1121
hypervisor combinations can automatically set up a getty in the guest, so
1122
an out of the box text login can be provided (target_type=xen for xen
1123
paravirt guests, and possibly target_type=virtio in the future).
1124
1125
Example:
1126
1127
=over 4
1128
1129
=item B<--console pty,target_type=virtio>
1130
1131
Connect a virtio console to the guest, redirected to a PTY on the host.
1132
For supported guests, this exposes /dev/hvc0 in the guest. See
1133
http://fedoraproject.org/wiki/Features/VirtioSerial for more info. virtio
1134
console requires libvirt 0.8.3 or later.
1135
1136
=back
1137
1138
=item --video=VIDEO
1139
1140
Specify what video device model will be attached to the guest. Valid values
1141
for VIDEO are hypervisor specific, but some options for recent kvm are
1142
cirrus, vga, qxl, or vmvga (vmware).
1143
1144
=item --smartcard=MODE[,OPTS]
1145
1146
Configure a virtual smartcard device.
1147
1148
Mode is one of B<host>, B<host-certificates>, or B<passthrough>. Additional
1149
options are:
1150
1151
=over 4
1152
1153
=item B<type>
1154
1155
Character device type to connect to on the host. This is only applicable
1156
for B<passthrough> mode.
1157
1158
=back
1159
1160
An example invocation:
1161
1162
=over 4
1163
1164
=item B<--smartcard passthrough,type=spicevmc>
1165
1166
Use the smartcard channel of a SPICE graphics device to pass smartcard info
1167
to the guest
1168
1169
=back
1170
1171
See C<http://libvirt.org/formatdomain.html#elementsSmartcard> for complete
1172
details.
1173
1174
=item --redirdev=BUS[,OPTS]
1175
1176
Add a redirected device.
1177
1178
=over 4
1179
1180
=item B<type>
1181
1182
The redirection type, currently supported is B<tcp> or B<spicevmc>.
1183
1184
=item B<server>
1185
1186
The TCP server connection details, of the form 'server:port'.
1187
1188
=back
1189
1190
Examples of invocation:
1191
1192
=over 4
1193
1194
=item B<--redirdev usb,type=tcp,server=localhost:4000>
1195
1196
Add a USB redirected device provided by the TCP server on 'localhost'
1197
port 4000.
1198
1199
=item B<--redirdev usb,type=spicevmc>
1200
1201
Add a USB device redirected via a dedicated Spice channel.
1202
1203
=back
1204
1205
=back
1206
1207
=head2 Miscellaneous Options
1208
1209
=over 2
1210
1211
=item --autostart
1212
1213
Set the autostart flag for a domain. This causes the domain to be started
1214
on host boot up.
1215
1216
=item --print-xml
1217
1218
If the requested guest has no install phase (--import, --boot), print the
1219
generated XML instead of defining the guest. By default this WILL do storage
1220
creation (can be disabled with --dry-run).
1221
1222
If the guest has an install phase, you will need to use --print-step to
1223
specify exactly what XML output you want. This option implies --quiet.
1224
1225
=item --print-step
1226
1227
Acts similarly to --print-xml, except requires specifying which install step
1228
to print XML for. Possible values are 1, 2, 3, or all. Stage 1 is typically
1229
booting from the install media, and stage 2 is typically the final guest
1230
config booting off hardisk. Stage 3 is only relevant for windows installs,
1231
which by default have a second install stage. This option implies --quiet.
1232
1233
=item --noreboot
1234
1235
Prevent the domain from automatically rebooting after the install has
1236
completed.
1237
1238
=item --wait=WAIT
1239
1240
Amount of time to wait (in minutes) for a VM to complete its install.
1241
Without this option, virt-install will wait for the console to close (not
1242
neccessarily indicating the guest has shutdown), or in the case of
1243
--noautoconsole, simply kick off the install and exit. Any negative
1244
value will make virt-install wait indefinitely, a value of 0 triggers the
1245
same results as noautoconsole. If the time limit is exceeded, virt-install
1246
simply exits, leaving the virtual machine in its current state.
1247
1248
=item --force
1249
1250
Prevent interactive prompts. If the intended prompt was a yes/no prompt, always
1251
say yes. For any other prompts, the application will exit.
1252
1253
=item --dry-run
1254
1255
Proceed through the guest creation process, but do NOT create storage devices,
1256
change host device configuration, or actually teach libvirt about the guest.
1257
virt-install may still fetch install media, since this is required to
1258
properly detect the OS to install.
1259
1260
=item --prompt
1261
1262
Specifically enable prompting for required information. Default prompting
1263
is off (as of virtinst 0.400.0)
1264
1265
=item --check-cpu
1266
1267
Check that the number virtual cpus requested does not exceed physical CPUs and
1268
warn if they do.
1269
1270
=item -q, --quiet
1271
1272
Only print fatal error messages.
1273
1274
=item -d, --debug
1275
1276
Print debugging information to the terminal when running the install process.
1277
The debugging information is also stored in C<$HOME/.virtinst/virt-install.log>
1278
even if this parameter is omitted.
1279
1280
=back
1281
1282
=head1 EXAMPLES
1283
1284
Install a Fedora 13 KVM guest with virtio accelerated disk/network,
1285
creating a new 8GB storage file, installing from media in the hosts
1286
CDROM drive, auto launching a graphical VNC viewer
1287
1288
# virt-install \
1289
--connect qemu:///system \
1290
--virt-type kvm \
1291
--name demo \
1292
--ram 500 \
1293
--disk path=/var/lib/libvirt/images/demo.img,size=8 \
1294
--graphics vnc \
1295
--cdrom /dev/cdrom \
1296
--os-variant fedora13
1297
1298
Install a Fedora 9 plain QEMU guest, using LVM partition, virtual networking,
1299
booting from PXE, using VNC server/viewer
1300
1301
# virt-install \
1302
--connect qemu:///system \
1303
--name demo \
1304
--ram 500 \
1305
--disk path=/dev/HostVG/DemoVM \
1306
--network network=default \
1307
--virt-type qemu
1308
--graphics vnc \
1309
--os-variant fedora9
1310
1311
Install a guest with a real partition, with the default QEMU hypervisor for
1312
a different architecture using SDL graphics, using a remote kernel and initrd
1313
pair:
1314
1315
# virt-install \
1316
--connect qemu:///system \
1317
--name demo \
1318
--ram 500 \
1319
--disk path=/dev/hdc \
1320
--network bridge=eth1 \
1321
--arch ppc64 \
1322
--graphics sdl \
1323
--location http://download.fedora.redhat.com/pub/fedora/linux/core/6/x86_64/os/
1324
1325
Run a Live CD image under Xen fullyvirt, in diskless environment
1326
1327
# virt-install \
1328
--hvm \
1329
--name demo \
1330
--ram 500 \
1331
--nodisks \
1332
--livecd \
1333
--graphics vnc \
1334
--cdrom /root/fedora7live.iso
1335
1336
Run /usr/bin/httpd in a linux container guest (LXC). Resource usage is capped
1337
at 512 MB of ram and 2 host cpus:
1338
1339
# virt-install \
1340
--connect lxc:/// \
1341
--name httpd_guest \
1342
--ram 512 \
1343
--vcpus 2 \
1344
--init /usr/bin/httpd
1345
1346
Install a paravirtualized Xen guest, 500 MB of RAM, a 5 GB of disk, and
1347
Fedora Core 6 from a web server, in text-only mode, with old style --file
1348
options:
1349
1350
# virt-install \
1351
--paravirt \
1352
--name demo \
1353
--ram 500 \
1354
--file /var/lib/xen/images/demo.img \
1355
--file-size 6 \
1356
--graphics none \
1357
--location http://download.fedora.redhat.com/pub/fedora/linux/core/6/x86_64/os/
1358
1359
Create a guest from an existing disk image 'mydisk.img' using defaults for
1360
the rest of the options.
1361
1362
# virt-install \
1363
--name demo
1364
--ram 512
1365
--disk /home/user/VMs/mydisk.img
1366
--import
1367
1368
Test a custom kernel/initrd using an existing disk image, manually
1369
specifying a serial device hooked to a PTY on the host machine.
1370
1371
# virt-install \
1372
--name mykernel
1373
--ram 512
1374
--disk /home/user/VMs/mydisk.img
1375
--boot kernel=/tmp/mykernel,initrd=/tmp/myinitrd,kernel_args="console=ttyS0"
1376
--serial pty
1377
1378
=head1 AUTHORS
1379
1380
Written by Daniel P. Berrange, Hugh Brock, Jeremy Katz, Cole Robinson and a
1381
team of many other contributors. See the AUTHORS file in the source
1382
distribution for the complete list of credits.
1383
1384
=head1 BUGS
1385
1386
Please see http://virt-manager.org/page/BugReporting
1387
1388
=head1 COPYRIGHT
1389
1390
Copyright (C) 2006-2011 Red Hat, Inc, and various contributors.
1391
This is free software. You may redistribute copies of it under the terms of
1392
the GNU General Public License C<http://www.gnu.org/licenses/gpl.html>. There
1393
is NO WARRANTY, to the extent permitted by law.
1394
1395
=head1 SEE ALSO
1396
1397
C<virsh(1)>, C<virt-clone(1)>, C<virt-manager(1)>, the project website C<http://virt-manager.org>
1398
1399
=cut
1400
Loggerhead is a web-based interface for Breezy
Version: 2.0.1