118
113
If the value 'auto' is passed, virt-install attempts to automatically determine
119
114
an optimal cpu pinning using NUMA data, if available.
121
=item --os-type=OS_TYPE
123
Optimize the guest configuration for a type of operating system (ex. 'linux',
124
'windows'). This will attempt to pick the most suitable ACPI & APIC settings,
125
optimally supported mouse drivers, virtio, and generally accommodate other
126
operating system quirks.
128
By default, virt-install will attempt to auto detect this value from
129
the install media (currently only supported for URL installs). Autodetection
130
can be disabled with the special value 'none'
132
See C<--os-variant> for valid options.
134
=item --os-variant=OS_VARIANT
136
Further optimize the guest configuration for a specific operating system
137
variant (ex. 'fedora8', 'winxp'). This parameter is optional, and does not
138
require an C<--os-type> to be specified.
140
By default, virt-install will attempt to auto detect this value from
141
the install media (currently only supported for URL installs). Autodetection
142
can be disabled with the special value 'none'.
148
=item --host-device=HOSTDEV
150
Attach a physical host device to the guest. HOSTDEV is a node device name
151
as used by libvirt (as shown by 'virsh nodedev-list').
155
=head2 Full Virtualization specific options
157
Parameters specific only to fully virtualized guest installs.
163
Attach a virtual audio device to the guest.
165
=item --parallel=CHAROPTS
167
=item --serial=CHAROPTS
169
Specifies a serial device to attach to the guest, with various options. The
170
general format of a serial string is
172
--serial type,opt1=val1,opt2=val2,...
174
--serial and --parallel devices share all the same options, unless otherwise
175
noted. Some of the types of character device redirection are:
179
=item B<--serial pty>
181
Psuedo TTY. The allocated pty will be listed in the running guests XML
184
=item B<--serial dev,path=HOSTPATH>
186
Host device. For serial devices, this could be /dev/ttyS0. For parallel
187
devices, this could be /dev/parport0.
189
=item B<--serial file,path=FILENAME>
191
Write output to FILENAME.
193
=item B<--serial pipe,path=PIPEPATH>
195
Named pipe (see pipe(7))
197
=item B<--serial tcp,host=HOST:PORT,mode=MODE,protocol=PROTOCOL>
199
TCP net console. MODE is either 'bind' (wait for connections on HOST:PORT)
200
or 'connect' (send output to HOST:PORT), default is 'connect'. HOST defaults
201
to '127.0.0.1', but PORT is required. PROTOCOL can be either 'raw' or 'telnet'
202
(default 'raw'). If 'telnet', the port acts like a telnet server or client.
205
Connect to localhost, port 1234:
207
--serial tcp,host=:1234
209
Wait for connections on any address, port 4567:
211
--serial tcp,host=0.0.0.0:4567,mode=bind
213
Wait for telnet connection on localhost, port 2222. The user could then
214
connect interactively to this console via 'telnet localhost 2222':
216
--serial tcp,host=:2222,mode=bind,protocol=telnet
218
=item B<--serial udp,host=CONNECT_HOST:PORT,bind_port=BIND_HOST:BIND_PORT>
220
UDP net console. HOST:PORT is the destination to send output to (default
221
HOST is '127.0.0.1', PORT is required. BIND_HOST:PORT is the optional local
222
address to bind to (default BIND_HOST is 127.0.0.1, but is only set if
223
BIND_PORT is specified.) Some examples:
225
Send output to default syslog port (may need to edit /etc/rsyslog.conf
228
--serial udp,host=:514
230
Send output to remote host 192.168.10.20, port 4444 (this output can be
231
read on the remote host using 'nc -u -l 4444':
233
--serial udp,host=192.168.10.20:4444
235
=item B<--serial unix,path=UNIXPATH,mode=MODE>
237
Unix socket (see unix(7). MODE has similar behavior and defaults as 'tcp'.
243
Override the OS type / variant to disables the APIC setting for fully
248
Override the OS type / variant to disables the ACPI setting for fully
253
=head2 Virtualization Type options
255
Options to override the default virtualization type choices.
261
Request the use of full virtualization, if both para & full virtualization are
262
available on the host. This parameter may not be available if connecting to a
263
Xen hypervisor on a machine without hardware virtualization support. This
264
parameter is implied if connecting to a QEMU based hypervisor.
268
This guest should be a paravirtualized guest. If the host supports both
269
para & full virtualization, and neither this parameter nor the C<--hvm>
270
are specified, this will be assumed.
274
The hypervisor to install on. Example choices are kvm, qemu, xen, or kqemu.
275
Availabile options are listed via 'virsh capabilities' in the <domain> tags.
279
Prefer KVM or KQEMU (in that order) if installing a QEMU guest. This behavior
280
is now the default, and this option is deprecated. To install a plain QEMU
281
guest, use '--virt-type qemu'
118
Human readable text description of the virtual machine. This will be stored
119
in the guests XML configuration for access by other applications.
121
=item --security type=TYPE[,label=LABEL]
123
Configure domain security driver settings. Type can be either 'static' or
124
'dynamic'. 'static' configuration requires a security LABEL. Specifying
125
LABEL without TYPE implies static configuration.
285
133
=head2 Installation Method options
364
212
Additional kernel command line arguments to pass to the installer when
365
213
performing a guest install from C<--location>.
215
=item --os-type=OS_TYPE
217
Optimize the guest configuration for a type of operating system (ex. 'linux',
218
'windows'). This will attempt to pick the most suitable ACPI & APIC settings,
219
optimally supported mouse drivers, virtio, and generally accommodate other
220
operating system quirks.
222
By default, virt-install will attempt to auto detect this value from
223
the install media (currently only supported for URL installs). Autodetection
224
can be disabled with the special value 'none'
226
See C<--os-variant> for valid options.
228
=item --os-variant=OS_VARIANT
230
Further optimize the guest configuration for a specific operating system
231
variant (ex. 'fedora8', 'winxp'). This parameter is optional, and does not
232
require an C<--os-type> to be specified.
234
By default, virt-install will attempt to auto detect this value from
235
the install media (currently only supported for URL installs). Autodetection
236
can be disabled with the special value 'none'.
369
248
=head2 Storage Configuration
508
=head2 Virtualization Type options
510
Options to override the default virtualization type choices.
516
Request the use of full virtualization, if both para & full virtualization are
517
available on the host. This parameter may not be available if connecting to a
518
Xen hypervisor on a machine without hardware virtualization support. This
519
parameter is implied if connecting to a QEMU based hypervisor.
523
This guest should be a paravirtualized guest. If the host supports both
524
para & full virtualization, and neither this parameter nor the C<--hvm>
525
are specified, this will be assumed.
529
The hypervisor to install on. Example choices are kvm, qemu, xen, or kqemu.
530
Availabile options are listed via 'virsh capabilities' in the <domain> tags.
534
Prefer KVM or KQEMU (in that order) if installing a QEMU guest. This behavior
535
is now the default, and this option is deprecated. To install a plain QEMU
536
guest, use '--virt-type qemu'
540
Override the OS type / variant to disables the APIC setting for fully
545
Override the OS type / variant to disables the ACPI setting for fully
554
=head2 Device Options
558
=item --host-device=HOSTDEV
560
Attach a physical host device to the guest. Some example values for HOSTDEV:
564
=item B<--host-device pci_0000_00_1b_0>
566
A node device name via libvirt, as shown by 'virsh nodedev-list'
568
=item B<--host-device 001.003>
570
USB by bus, device (via lsusb).
572
=item B<--host-device 0x1234:0x5678>
574
USB by vendor, product (via lsusb).
576
=item B<--host-device 1f.01.02>
578
PCI device (via lspci).
582
=item --soundhw MODEL
584
Attach a virtual audio device to the guest. MODEL specifies the emulated
585
sound card model. Possible values are ac97, es1370, sb16, pcspk, or default.
586
'default' willl be AC97 if the hypervisor supports it, otherwise it will be
589
This deprecates the old boolean --sound model (which still works the same
590
as a single '--soundhw default')
592
=item --watchdog MODEL[,action=ACTION]
594
Attach a virtual hardware watchdog device to the guest. This requires a
595
daemon and device driver in the guest. The watchdog fires a signal when
596
the virtual machine appears to hung. ACTION specifies what libvirt will do
597
when the watchdog fires. Values are
603
Forcefully reset the guest (the default)
607
Forcefully power off the guest
619
Gracefully shutdown the guest (not recommended, since a hung guest probably
620
won't respond to a graceful shutdown)
624
MODEL is the emulated device model: either i6300esb (the default) or ib700.
627
Use the recommended settings:
631
Use the i6300esb with the 'poweroff' action
633
--watchdog i6300esb,action=poweroff
635
=item --parallel=CHAROPTS
637
=item --serial=CHAROPTS
639
Specifies a serial device to attach to the guest, with various options. The
640
general format of a serial string is
642
--serial type,opt1=val1,opt2=val2,...
644
--serial and --parallel devices share all the same options, unless otherwise
645
noted. Some of the types of character device redirection are:
649
=item B<--serial pty>
651
Pseudo TTY. The allocated pty will be listed in the running guests XML
654
=item B<--serial dev,path=HOSTPATH>
656
Host device. For serial devices, this could be /dev/ttyS0. For parallel
657
devices, this could be /dev/parport0.
659
=item B<--serial file,path=FILENAME>
661
Write output to FILENAME.
663
=item B<--serial pipe,path=PIPEPATH>
665
Named pipe (see pipe(7))
667
=item B<--serial tcp,host=HOST:PORT,mode=MODE,protocol=PROTOCOL>
669
TCP net console. MODE is either 'bind' (wait for connections on HOST:PORT)
670
or 'connect' (send output to HOST:PORT), default is 'connect'. HOST defaults
671
to '127.0.0.1', but PORT is required. PROTOCOL can be either 'raw' or 'telnet'
672
(default 'raw'). If 'telnet', the port acts like a telnet server or client.
675
Connect to localhost, port 1234:
677
--serial tcp,host=:1234
679
Wait for connections on any address, port 4567:
681
--serial tcp,host=0.0.0.0:4567,mode=bind
683
Wait for telnet connection on localhost, port 2222. The user could then
684
connect interactively to this console via 'telnet localhost 2222':
686
--serial tcp,host=:2222,mode=bind,protocol=telnet
688
=item B<--serial udp,host=CONNECT_HOST:PORT,bind_port=BIND_HOST:BIND_PORT>
690
UDP net console. HOST:PORT is the destination to send output to (default
691
HOST is '127.0.0.1', PORT is required. BIND_HOST:PORT is the optional local
692
address to bind to (default BIND_HOST is 127.0.0.1, but is only set if
693
BIND_PORT is specified.) Some examples:
695
Send output to default syslog port (may need to edit /etc/rsyslog.conf
698
--serial udp,host=:514
700
Send output to remote host 192.168.10.20, port 4444 (this output can be
701
read on the remote host using 'nc -u -l 4444':
703
--serial udp,host=192.168.10.20:4444
705
=item B<--serial unix,path=UNIXPATH,mode=MODE>
707
Unix socket (see unix(7). MODE has similar behavior and defaults as 'tcp'.
713
Specify what video device model will be attached to the guest. Valid values
714
for VIDEO are hypervisor specific, but some options for recent kvm are
715
cirrus, vga, or vmvga (vmware).
624
723
=head2 Miscellaneous Options
630
Print debugging information to the terminal when running the install process.
631
The debugging information is also stored in C<$HOME/.virtinst/virt-install.log>
632
even if this parameter is omitted.
729
Set the autostart flag for a domain. This causes the domain to be started
added
removed
man/en/virt-install.pod.in
