~ubuntu-branches/ubuntu/raring/virtinst/raring-proposed

« back to all changes in this revision

Viewing changes to man/en/virt-image.pod

  • Committer: Bazaar Package Importer
  • Author(s): Guido Günther
  • Date: 2009-03-22 20:13:27 UTC
  • mto: (1.4.1 sid)
  • mto: This revision was merged to the branch mainline in revision 19.
  • Revision ID: james.westby@ubuntu.com-20090322201327-5ch3kqxe772e23zx
Tags: upstream-0.400.3
Import upstream version 0.400.3

Show diffs side-by-side

added added

removed removed

Lines of Context:
24
24
 
25
25
=head1 OPTIONS
26
26
 
27
 
Any of the options can be omitted, in which case B<virt-image> will either
28
 
use defaults from the XML descriptor or interactively prompt for input as
29
 
required. When defaults are taken from the XML descriptor, they are
30
 
indicated below as a path.
 
27
Most options can be omitted, in which case B<virt-image> will use defaults
 
28
from the XML descriptor. When defaults are taken from the XML descriptor,
 
29
they are indicated below as a path. --name is the only required command
 
30
line option.
31
31
 
32
32
=over 4
33
33
 
35
35
 
36
36
Show the help message and exit
37
37
 
38
 
=item  -n NAME, --name=NAME  
 
38
=item --connect=CONNECT
 
39
 
 
40
Connect to a non-default hypervisor. See L<virt-install(1)> for details
 
41
 
 
42
=back
 
43
 
 
44
=head2 General Options
 
45
 
 
46
General configuration parameters that apply to all types of guest installs.
 
47
 
 
48
=over 2
 
49
 
 
50
=item  -n NAME, --name=NAME
39
51
 
40
52
Name of the guest instance
41
53
 
44
56
Memory to allocate for guest instance in megabytes. Defaults to
45
57
C</image/devices/memory> in the XML descriptor.
46
58
 
47
 
=item  -u UUID, --uuid=UUID  
 
59
=item  -u UUID, --uuid=UUID
48
60
 
49
61
UUID for the guest; if none is given a random UUID will be generated. If
50
62
you specify UUID, you should use a 32-digit hexadecimal number.
51
63
 
52
 
=item --vcpus=VCPUS 
 
64
=item --vcpus=VCPUS
53
65
 
54
66
Number of vcpus to configure for your guest. Defaults to
55
67
C</image/devices/vcpu> in the XML descriptor.
58
70
 
59
71
Check that vcpus do not exceed physical CPUs and warn if they do.
60
72
 
 
73
=item  --os-type=OS_TYPE
 
74
 
 
75
Optimize the guest configuration for a type of operating system (ex. 'linux',
 
76
'windows'). This will attempt to pick the most suitable ACPI & APIC settings,
 
77
optimally supported mouse drivers, virtio, and generally accommodate other
 
78
operating system quirks.  See L<virt-install(1)> for valid values.
 
79
 
 
80
=item --os-variant=OS_VARIANT
 
81
 
 
82
Further optimize the guest configuration for a specific operating system
 
83
variant (ex. 'fedora8', 'winxp'). This parameter is optional, and does not
 
84
require an C<--os-type> to be specified. See L<virt-install(1)> for valid
 
85
values.
 
86
 
 
87
=back
 
88
 
 
89
=head2 Full Virtualization specific options
 
90
 
 
91
Parameters specific only to fully virtualized guest installs.
 
92
 
 
93
=over 2
 
94
 
 
95
=item --noapic
 
96
 
 
97
Disables APIC for fully virtualized guest (overrides value in XML descriptor)
 
98
 
 
99
=item --noacpi
 
100
 
 
101
Disables ACPI for fully virtualized guest (overrides value in XML descriptor)
 
102
 
 
103
=back
 
104
 
 
105
=head2 Networking Configuration
 
106
 
 
107
=over 2
 
108
 
61
109
=item -m MAC, --mac=MAC
62
110
 
63
111
Fixed MAC address for the guest. See L<virt-install(1)> for details
64
112
 
65
113
=item -b BRIDGE, --bridge=BRIDGE
66
114
 
67
 
Bridge device to connect the guest NIC to. See L<virt-install(1)> for details
 
115
Bridge device to connect the guest NIC to. This is deprecated in favor of
 
116
C<--network>
68
117
 
69
118
=item -w NETWORK, --network=NETWORK
70
119
 
71
120
Connect the guest to the host network. See L<virt-install(1)> for details
72
121
 
 
122
=back
 
123
 
 
124
=head2 Graphics Configuration
 
125
 
 
126
If no graphics option is specified, C<virt-install> will default to --vnc
 
127
if the DISPLAY environment variable is set, otherwise --nographics is used.
 
128
 
 
129
=over 2
 
130
 
73
131
=item --vnc
74
132
 
75
133
Setup a virtual console in the guest and export it as a VNC server in
95
153
Request that the virtual console be configured to run with a non-English
96
154
keyboard layout.
97
155
 
98
 
=item --connect=CONNECT     Connect to hypervisor with URI
99
 
 
100
 
Connect to a non-default hypervisor. See L<virt-install(1)> for details
101
 
 
102
 
=item --noapic
103
 
 
104
 
Disables APIC for fully virtualized guest (overrides value in XML descriptor)
105
 
 
106
 
=item --noacpi
107
 
 
108
 
Disables ACPI for fully virtualized guest (overrides value in XML descriptor)
109
 
 
110
 
=item -d, --debug
111
 
 
112
 
Print debugging information
 
156
=back
 
157
 
 
158
=head2 Miscellaneous Options
 
159
 
 
160
=over 2
113
161
 
114
162
=item -p, --print
115
163
 
122
170
hypervisors. By default, the one that is most appropriate for the current
123
171
hypervisor is selected.
124
172
 
 
173
=item --replace
 
174
 
 
175
Shutdown and remove any existing guest with the passed C<--name> before
 
176
installing from the image.
 
177
 
 
178
=item --skip-checksum
 
179
 
 
180
Do not check disk images against checksums (if they are listed in the
 
181
image xml).
 
182
 
 
183
=item -d, --debug
 
184
 
 
185
Print debugging information
 
186
 
125
187
=item --force
126
188
 
127
189
Prevent interactive prompts. If the intended prompt was a yes/no prompt, always
143
205
 
144
206
=head1 AUTHOR
145
207
 
146
 
Written by David Lutterkort. See the AUTHORS file in the source distribution for
147
 
the complete list of credits.
 
208
Written by David Lutterkort. See the AUTHORS file in the source
 
209
distribution for the complete list of credits.
148
210
 
149
211
=head1 BUGS
150
212
 
151
 
Report bugs to the mailing list C<http://www.redhat.com/mailman/listinfo/et-mgmt-tools>
152
 
or directly to BugZilla C<http://bugzilla.redhat.com/bugzilla/> against the
153
 
C<Fedora> product, and the C<python-virtinst> component.
 
213
Report bugs to the mailing list
 
214
C<http://www.redhat.com/mailman/listinfo/et-mgmt-tools> or directly to
 
215
BugZilla C<http://bugzilla.redhat.com/bugzilla/> against the C<Fedora>
 
216
product, and the C<python-virtinst> component.
154
217
 
155
218
=head1 COPYRIGHT
156
219
 
157
 
Copyright (C) 2006-2007 Red Hat, Inc, and various contributors. 
158
 
This is free software. You may redistribute copies of it under the terms of the GNU General 
159
 
Public License C<http://www.gnu.org/licenses/gpl.html>. There is NO WARRANTY, to the extent 
160
 
permitted by law.
 
220
Copyright (C) 2006-2007 Red Hat, Inc, and various contributors.
 
221
This is free software. You may redistribute copies of it under the terms
 
222
of the GNU General Public License C<http://www.gnu.org/licenses/gpl.html>.
 
223
There is NO WARRANTY, to the extent permitted by law.
161
224
 
162
225
=head1 SEE ALSO
163
226