100
106
to be unique across the entire data center, and indeed world. Bear this in
101
107
mind if manually specifying a UUID
105
Number of virtual cpus to configure for the guest. Not all hypervisors support
106
SMP guests, in which case this argument will be silently ignored
109
=item --vcpus=VCPUS[,maxvcpus=MAX][,sockets=#][,cores=#][,threads=#]
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.
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
108
119
=item --cpuset=CPUSET
115
126
If the value 'auto' is passed, virt-install attempts to automatically determine
116
127
an optimal cpu pinning using NUMA data, if available.
129
=item --cpu MODEL[,+feature][,-feature][,match=MATCH][,vendor=VENDOR]
131
Configure the CPU model and CPU features exposed to the guest. The only
132
required value is MODEL, which is a valid CPU model as listed in libvirt's
135
Specific CPU features can be specified in a number of ways: using one of
136
libvirt's feature policy values force, require, optional, disable, or forbid,
137
or with the shorthand '+feature' and '-feature', which equal 'force=feature'
138
and 'disable=feature' respectively
144
=item B<--cpu core2duo,+x2apic,disable=vmx>
146
Expose the core2duo CPU model, force enable x2apic, but do not expose vmx
150
Expose the host CPUs configuration to the guest. This enables the guest to
151
take advantage of many of the host CPUs features (better performance), but
152
may cause issues if migrating the guest to a host without an identical CPU.
118
156
=item --description
120
158
Human readable text description of the virtual machine. This will be stored
302
Microsoft Windows Vista
306
Microsoft Windows XP (x86_64)
314
Microsoft Windows 2000
318
Microsoft Windows Server 2008
322
Microsoft Windows Server 2003
320
Generic 2.6.25 or later kernel with virtio
450
Mandriva Enterprise Server 5.1 and later
454
Mandriva Enterprise Server 5.0
458
Mandriva Linux 2010 and later
322
460
=item mandriva2009
324
462
Mandriva Linux 2009 and earlier
328
Mandriva Linux 2010 and later
332
Mandriva Enterprise Server 5.0
336
Mandriva Enterprise Server 5.1 and later
466
Red Hat Enterprise Linux 6
470
Red Hat Enterprise Linux 5.4 or later
474
Red Hat Enterprise Linux 5
478
Red Hat Enterprise Linux 4
482
Red Hat Enterprise Linux 3
340
486
Red Hat Enterprise Linux 2.1
344
Red Hat Enterprise Linux 3
348
Red Hat Enterprise Linux 4
352
Red Hat Enterprise Linux 5
356
Red Hat Enterprise Linux 5.4 or later
360
Red Hat Enterprise Linux 6
490
Suse Linux Enterprise Server 11
364
494
Suse Linux Enterprise Server
368
Suse Linux Enterprise Server 11
498
Ubuntu 10.10 (Maverick Meerkat)
502
Ubuntu 10.4 (Lucid Lynx)
506
Ubuntu 9.10 (Karmic Koala)
510
Ubuntu 9.04 (Jaunty Jackalope)
514
Ubuntu 8.10 (Intrepid Ibex)
370
516
=item ubuntuhardy
372
518
Ubuntu 8.04 LTS (Hardy Heron)
376
Ubuntu 8.10 (Intrepid Ibex)
380
Ubuntu 9.04 (Jaunty Jackalope)
384
Ubuntu 9.10 (Karmic Koala)
388
Ubuntu 10.4 (Lucid Lynx)
464
Microsoft Windows Vista
468
Microsoft Windows 2000
472
Microsoft Windows 2003
476
Microsoft Windows 2008
484
Microsoft Windows XP (x86)
488
Microsoft Windows XP (x86_64)
522
Generic 2.6.25 or later kernel with virtio
797
=item --graphics TYPE,opt1=arg1,opt2=arg2,...
799
Specifies the graphical display configuration. This does not configure any
800
virtual hardware, just how the guest's graphical display can be accessed.
801
Typically the user does not need to specify this option, virt-install will
802
try and choose a useful default, and launch a suitable connection.
804
General format of a graphical string is
806
--graphics TYPE,opt1=arg1,opt2=arg2,...
810
--graphics vnc,password=foobar
812
The supported options are:
818
The display type. This is one of:
757
822
Setup a virtual console in the guest and export it as a VNC server in
758
the host. Unless the C<--vncport> parameter is also provided, the VNC
823
the host. Unless the C<port> parameter is also provided, the VNC
759
824
server will run on the first free port number at 5900 or above. The
760
825
actual VNC display allocated can be obtained using the C<vncdisplay>
761
826
command to C<virsh> (or L<virt-viewer(1)> can be used which handles this
762
827
detail for the use).
764
=item --vncport=VNCPORT
766
Request a permanent, statically assigned port number for the guest VNC
767
console. Use of this option is discouraged as other guests may automatically
768
choose to run on this port causing a clash.
770
=item --vnclisten=VNCLISTEN
772
Address to listen on for VNC connections. Default is typically 127.0.0.1
831
Setup a virtual console in the guest and display an SDL window in the
832
host to render the output. If the SDL window is closed the guest may
833
be unconditionally terminated.
837
Export the guest's console using the Spice protocol. Spice allows advanced
838
features like audio and USB device streaming, as well as improved graphical
843
No graphical console will be allocated for the guest. Fully virtualized guests
844
(Xen FV or QEmu/KVM) will need to have a text console configured on the first
845
serial port in the guest (this can be done via the --extra-args option). Xen
846
PV will set this up automatically. The command 'virsh console NAME' can be
847
used to connect to the serial device.
851
Request a permanent, statically assigned port number for the guest
852
console. This is used by 'vnc' and 'spice'
856
Specify the spice tlsport.
860
Address to listen on for VNC/Spice connections. Default is typically 127.0.0.1
773
861
(localhost only), but some hypervisors allow changing this globally (for
774
862
example, the qemu driver default can be changed in /etc/libvirt/qemu.conf).
775
Use 0.0.0.0 to allow access from other machines.
863
Use 0.0.0.0 to allow access from other machines. This is use by 'vnc' and
777
=item -k KEYMAP, --keymap=KEYMAP
779
868
Request that the virtual VNC console be configured to run with a specific
780
869
keyboard layout. If the special value 'local' is specified, virt-install
781
870
will attempt to configure to use the same keymap as the local system. A value
782
871
of 'none' specifically defers to the hypervisor. Default behavior is
783
hypervisor specific, but typically is the same as 'local'.
872
hypervisor specific, but typically is the same as 'local'. This is used
877
Request a VNC password, required at connection time. Beware, this info may
878
end up in virt-install log files, so don't use an important password. This
879
is used by 'vnc' and 'spice'
881
=item B<passwordvalidto>
883
Set an expiration date for password. After the date/time has passed,
884
all new graphical connections are denyed until a new password is set.
885
This is used by 'vnc' and 'spice'
887
The format for this value is YYYY-MM-DDTHH:MM:SS, for example
894
This option is deprecated in favor of C<--graphics vnc,...>
896
=item --vncport=VNCPORT
898
This option is deprecated in favor of C<--graphics vnc,port=PORT,...>
900
=item --vnclisten=VNCLISTEN
902
This option is deprecated in favor of C<--graphics vnc,listen=LISTEN,...>
904
=item -k KEYMAP, --keymap=KEYMAP
906
This option is deprecated in favor of C<--graphics vnc,keymap=KEYMAP,...>
787
Setup a virtual console in the guest and display an SDL window in the
788
host to render the output. If the SDL window is closed the guest may
789
be unconditionally terminated.
910
This option is deprecated in favor of C<--graphics sdl,...>
791
912
=item --nographics
793
No graphical console will be allocated for the guest. Fully virtualized guests
794
(Xen FV or QEmu/KVM) will need to have a text console configured on the first
795
serial port in the guest (this can be done via the --extra-args option). Xen
796
PV will set this up automatically. The command 'virsh console NAME' can be
797
used to connect to the serial device.
914
This option is deprecated in favor of C<--graphics none>
799
916
=item --noautoconsole
1079
1196
Set the autostart flag for a domain. This causes the domain to be started
1080
1197
on host boot up.
1201
If the requested guest has no install phase (--import, --boot), print the
1202
generated XML instead of defining the guest. By default this WILL do storage
1203
creation (can be disabled with --dry-run).
1205
If the guest has an install phase, you will need to use --print-step to
1206
specify exactly what XML output you want. This option implies --quiet.
1210
Acts similarly to --print-xml, except requires specifying which install step
1211
to print XML for. Possible values are 1, 2, 3, or all. Stage 1 is typically
1212
booting from the install media, and stage 2 is typically the final guest
1213
config booting off hardisk. Stage 3 is only relevant for windows installs,
1214
which by default have a second install stage. This option implies --quiet.
1082
1216
=item --noreboot
1084
1218
Prevent the domain from automatically rebooting after the install has
added
removed
man/en/virt-install.pod
