1 | <?xml version="1.0" encoding="UTF-8"?>
|
---|
2 | <!--
|
---|
3 | manpage, user manual, usage: VBoxManage list
|
---|
4 | -->
|
---|
5 | <!--
|
---|
6 | Copyright (C) 2006-2023 Oracle and/or its affiliates.
|
---|
7 |
|
---|
8 | This file is part of VirtualBox base platform packages, as
|
---|
9 | available from https://www.virtualbox.org.
|
---|
10 |
|
---|
11 | This program is free software; you can redistribute it and/or
|
---|
12 | modify it under the terms of the GNU General Public License
|
---|
13 | as published by the Free Software Foundation, in version 3 of the
|
---|
14 | License.
|
---|
15 |
|
---|
16 | This program is distributed in the hope that it will be useful, but
|
---|
17 | WITHOUT ANY WARRANTY; without even the implied warranty of
|
---|
18 | MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
|
---|
19 | General Public License for more details.
|
---|
20 |
|
---|
21 | You should have received a copy of the GNU General Public License
|
---|
22 | along with this program; if not, see <https://www.gnu.org/licenses>.
|
---|
23 |
|
---|
24 | SPDX-License-Identifier: GPL-3.0-only
|
---|
25 | -->
|
---|
26 | <!DOCTYPE refentry PUBLIC "-//OASIS//DTD DocBook XML V4.5//EN"
|
---|
27 | "http://www.oasis-open.org/docbook/xml/4.5/docbookx.dtd"[
|
---|
28 | <!ENTITY % all.entities SYSTEM "all-entities.ent">
|
---|
29 | %all.entities;
|
---|
30 | ]>
|
---|
31 | <refentry id="vboxmanage-list" lang="en">
|
---|
32 | <refentryinfo>
|
---|
33 | <pubdate>$Date: 2023-10-25 15:37:09 +0000 (Wed, 25 Oct 2023) $</pubdate>
|
---|
34 | <title>VBoxManage list</title>
|
---|
35 | </refentryinfo>
|
---|
36 |
|
---|
37 | <refmeta>
|
---|
38 | <refentrytitle>VBoxManage-list</refentrytitle>
|
---|
39 | <manvolnum>1</manvolnum>
|
---|
40 | </refmeta>
|
---|
41 |
|
---|
42 | <refnamediv>
|
---|
43 | <refname>VBoxManage-list</refname>
|
---|
44 | <refpurpose>view system information and VM configuration details</refpurpose>
|
---|
45 | <refclass>&product-name;</refclass>
|
---|
46 | </refnamediv>
|
---|
47 |
|
---|
48 | <refsynopsisdiv>
|
---|
49 | <cmdsynopsis id="synopsis-vboxmanage-list">
|
---|
50 | <!-- The 'id' is mandatory and must start with 'synopsis-'. -->
|
---|
51 | <command>VBoxManage list</command>
|
---|
52 | <arg>--long</arg>
|
---|
53 | <arg>--sorted</arg>
|
---|
54 | <group>
|
---|
55 | <arg choice="plain">bridgedifs</arg>
|
---|
56 | <arg choice="plain">cloudnets</arg>
|
---|
57 | <arg choice="plain">cloudprofiles</arg>
|
---|
58 | <arg choice="plain">cloudproviders</arg>
|
---|
59 | <arg choice="plain">cpu-profiles</arg>
|
---|
60 | <arg choice="plain">dhcpservers</arg>
|
---|
61 | <arg choice="plain">dvds</arg>
|
---|
62 | <arg choice="plain">extpacks</arg>
|
---|
63 | <arg choice="plain">floppies</arg>
|
---|
64 | <arg choice="plain">groups</arg>
|
---|
65 | <arg choice="plain">hddbackends</arg>
|
---|
66 | <arg choice="plain">hdds</arg>
|
---|
67 | <arg choice="plain">hostcpuids</arg>
|
---|
68 | <arg choice="plain">hostdrives</arg>
|
---|
69 | <arg choice="plain">hostdvds</arg>
|
---|
70 | <arg choice="plain">hostfloppies</arg>
|
---|
71 | <arg choice="plain">hostinfo</arg>
|
---|
72 | <arg choice="plain">hostonlyifs</arg>
|
---|
73 | <arg choice="plain">hostonlynets</arg>
|
---|
74 | <arg choice="plain">intnets</arg>
|
---|
75 | <arg choice="plain">natnets</arg>
|
---|
76 | <arg choice="plain">ostypes</arg>
|
---|
77 | <arg choice="plain">ossubtypes</arg>
|
---|
78 | <arg choice="plain">runningvms</arg>
|
---|
79 | <arg choice="plain">screenshotformats</arg>
|
---|
80 | <arg choice="plain">systemproperties</arg>
|
---|
81 | <arg choice="plain">usbfilters</arg>
|
---|
82 | <arg choice="plain">usbhost</arg>
|
---|
83 | <arg choice="plain">vms</arg>
|
---|
84 | <arg choice="plain">webcams</arg>
|
---|
85 | </group>
|
---|
86 | </cmdsynopsis>
|
---|
87 | </refsynopsisdiv>
|
---|
88 |
|
---|
89 | <refsect1 id="vboxmanage-list-description">
|
---|
90 | <title>Description</title>
|
---|
91 | <para>
|
---|
92 | The <command>VBoxManage list</command> subcommands enable you to
|
---|
93 | obtain information about the &product-name; software, the VMs
|
---|
94 | and associated services that you create.
|
---|
95 | </para>
|
---|
96 | <refsect2 id="vboxmanage-list-common-options">
|
---|
97 | <title>Common Options</title>
|
---|
98 | <variablelist>
|
---|
99 | <varlistentry>
|
---|
100 | <term><option>--long</option></term>
|
---|
101 | <listitem><para>
|
---|
102 | Shows detailed information about each information entry
|
---|
103 | if available. The short form of this option is
|
---|
104 | <option>-l</option>.
|
---|
105 | </para></listitem>
|
---|
106 | </varlistentry>
|
---|
107 | <varlistentry>
|
---|
108 | <term><option>--sorted</option></term>
|
---|
109 | <listitem><para>
|
---|
110 | Sorts the list of information entries alphabetically. The
|
---|
111 | short form of this option is <option>-s</option>.
|
---|
112 | </para></listitem>
|
---|
113 | </varlistentry>
|
---|
114 | </variablelist>
|
---|
115 | </refsect2>
|
---|
116 | <refsect2 id="vboxmanage-list-bridgedifs">
|
---|
117 | <title>List the Bridged Network Interfaces on the Host System</title>
|
---|
118 | <cmdsynopsis id="synopsis-vboxmanage-list-bridgedifs">
|
---|
119 | <command>VBoxManage list</command>
|
---|
120 | <arg choice="plain">bridgedifs</arg>
|
---|
121 | </cmdsynopsis>
|
---|
122 | <para>
|
---|
123 | The <command>VBoxManage list bridgedifs</command> command lists
|
---|
124 | the bridged network interfaces that are currently available on
|
---|
125 | the host system. The output shows detailed configuration
|
---|
126 | information about each interface. See <xref linkend="networkingdetails"/>.
|
---|
127 | </para>
|
---|
128 | </refsect2>
|
---|
129 | <refsect2 id="vboxmanage-list-cloudnets">
|
---|
130 | <title>List the Cloud Network Interfaces</title>
|
---|
131 | <cmdsynopsis id="synopsis-vboxmanage-list-cloudnets">
|
---|
132 | <command>VBoxManage list</command>
|
---|
133 | <arg choice="plain">cloudnets</arg>
|
---|
134 | </cmdsynopsis>
|
---|
135 | <para>
|
---|
136 | The <command>VBoxManage list cloudnets</command> command
|
---|
137 | lists the cloud network interfaces that have been configured. A cloud
|
---|
138 | network interface provides connectivity between local VMs and a
|
---|
139 | cloud network.
|
---|
140 | </para>
|
---|
141 | </refsect2>
|
---|
142 | <refsect2 id="vboxmanage-list-cloudprofiles">
|
---|
143 | <title>List the Cloud Profiles</title>
|
---|
144 | <cmdsynopsis id="synopsis-vboxmanage-list-cloudprofiles">
|
---|
145 | <command>VBoxManage list</command>
|
---|
146 | <arg choice="plain">cloudprofiles</arg>
|
---|
147 | </cmdsynopsis>
|
---|
148 | <para>
|
---|
149 | The <command>VBoxManage list cloudprofiles</command> command
|
---|
150 | lists the cloud profiles that have been configured. A cloud
|
---|
151 | profile contains settings for a cloud service account.
|
---|
152 | </para>
|
---|
153 | </refsect2>
|
---|
154 | <refsect2 id="vboxmanage-list-cloudproviders">
|
---|
155 | <title>List the Cloud Providers</title>
|
---|
156 | <cmdsynopsis id="synopsis-vboxmanage-list-cloudproviders">
|
---|
157 | <command>VBoxManage list</command>
|
---|
158 | <arg choice="plain">cloudproviders</arg>
|
---|
159 | </cmdsynopsis>
|
---|
160 | <para>
|
---|
161 | The <command>VBoxManage list cloudproviders</command> command
|
---|
162 | lists the cloud providers that are supported by &product-name;.
|
---|
163 | Oracle Cloud Infrastructure is an example of a cloud provider.
|
---|
164 | </para>
|
---|
165 | </refsect2>
|
---|
166 | <refsect2 id="vboxmanage-list-cpu-profiles">
|
---|
167 | <title>List the known CPU Profiles</title>
|
---|
168 | <cmdsynopsis id="synopsis-vboxmanage-list-cpu-profiles">
|
---|
169 | <command>VBoxManage list</command>
|
---|
170 | <arg choice="plain">cpu-profiles</arg>
|
---|
171 | </cmdsynopsis>
|
---|
172 | <para>
|
---|
173 | The <command>VBoxManage list cpu-profiles</command> command
|
---|
174 | lists the CPU profiles that are known by &product-name;.
|
---|
175 | </para>
|
---|
176 | </refsect2>
|
---|
177 | <refsect2 id="vboxmanage-list-dhcpservers">
|
---|
178 | <title>List the DHCP Servers on the Host System</title>
|
---|
179 | <cmdsynopsis id="synopsis-vboxmanage-list-dhcpservers">
|
---|
180 | <command>VBoxManage list</command>
|
---|
181 | <arg choice="plain">dhcpservers</arg>
|
---|
182 | </cmdsynopsis>
|
---|
183 | <para>
|
---|
184 | The <command>VBoxManage list dhcpservers</command> command lists
|
---|
185 | the DHCP servers that are currently available on the host
|
---|
186 | system. The output shows detailed configuration information
|
---|
187 | about each DHCP server. See <xref linkend="networkingdetails"/>.
|
---|
188 | </para>
|
---|
189 | </refsect2>
|
---|
190 | <refsect2 id="vboxmanage-list-dvds">
|
---|
191 | <title>List the DVD Virtual Disk Images</title>
|
---|
192 | <cmdsynopsis id="synopsis-vboxmanage-list-dvds">
|
---|
193 | <command>VBoxManage list</command>
|
---|
194 | <arg choice="plain">dvds</arg>
|
---|
195 | </cmdsynopsis>
|
---|
196 | <para>
|
---|
197 | The <command>VBoxManage list dvds</command> command shows
|
---|
198 | information about the DVD virtual disk images that are currently
|
---|
199 | in use by the &product-name; software. For each image, the
|
---|
200 | output shows all the settings, the UUIDs associated with the
|
---|
201 | image by &product-name;, and all files associated with the
|
---|
202 | image.
|
---|
203 | </para>
|
---|
204 | <para>
|
---|
205 | This command performs the same function as the Virtual Media
|
---|
206 | Manager. See <xref linkend="virtual-media-manager"/>.
|
---|
207 | </para>
|
---|
208 | </refsect2>
|
---|
209 | <refsect2 id="vboxmanage-list-extpacks">
|
---|
210 | <title>List the Installed &product-name; Extension Packs</title>
|
---|
211 | <cmdsynopsis id="synopsis-vboxmanage-list-extpacks">
|
---|
212 | <command>VBoxManage list</command>
|
---|
213 | <arg choice="plain">extpacks</arg>
|
---|
214 | </cmdsynopsis>
|
---|
215 | <para>
|
---|
216 | The <command>VBoxManage list extpacks</command> command shows
|
---|
217 | all &product-name; extension packs that are currently installed.
|
---|
218 | See <xref linkend="intro-installing"/> and
|
---|
219 | <xref linkend="vboxmanage-extpack"/>.
|
---|
220 | </para>
|
---|
221 | </refsect2>
|
---|
222 | <refsect2 id="vboxmanage-list-floppies">
|
---|
223 | <title>List the Floppy Disk Virtual Disk Images</title>
|
---|
224 | <cmdsynopsis id="synopsis-vboxmanage-list-floppies">
|
---|
225 | <command>VBoxManage list</command>
|
---|
226 | <arg choice="plain">floppies</arg>
|
---|
227 | </cmdsynopsis>
|
---|
228 | <para>
|
---|
229 | The <command>VBoxManage list floppies</command> command shows
|
---|
230 | information about the floppy disk images that are currently in
|
---|
231 | use by the &product-name; software. For each image, the output
|
---|
232 | shows all the settings, the UUIDs associated with the image by
|
---|
233 | &product-name;, and all files associated with the image.
|
---|
234 | </para>
|
---|
235 | <para>
|
---|
236 | This command performs the same function as the Virtual Media
|
---|
237 | Manager. See <xref linkend="virtual-media-manager"/>.
|
---|
238 | </para>
|
---|
239 | </refsect2>
|
---|
240 | <refsect2 id="vboxmanage-list-groups">
|
---|
241 | <title>List the Virtual Machine Groups</title>
|
---|
242 | <cmdsynopsis id="synopsis-vboxmanage-list-groups">
|
---|
243 | <command>VBoxManage list</command>
|
---|
244 | <arg choice="plain">groups</arg>
|
---|
245 | </cmdsynopsis>
|
---|
246 | <para>
|
---|
247 | The <command>VBoxManage list groups</command> command shows
|
---|
248 | all VM groups. See <xref linkend="gui-vmgroups"/>.
|
---|
249 | </para>
|
---|
250 | </refsect2>
|
---|
251 | <refsect2 id="vboxmanage-list-hddbackends">
|
---|
252 | <title>List the Virtual Disk Backends</title>
|
---|
253 | <cmdsynopsis id="synopsis-vboxmanage-list-hddbackends">
|
---|
254 | <command>VBoxManage list</command>
|
---|
255 | <arg choice="plain">hddbackends</arg>
|
---|
256 | </cmdsynopsis>
|
---|
257 | <para>
|
---|
258 | The <command>VBoxManage list hddbackends</command> command lists
|
---|
259 | all known virtual disk backends of the &product-name; software.
|
---|
260 | For each such format, such as VDI, VMDK, or RAW, this command
|
---|
261 | lists the backend's capabilities and configuration.
|
---|
262 | </para>
|
---|
263 | </refsect2>
|
---|
264 | <refsect2 id="vboxmanage-list-hdds">
|
---|
265 | <title>List the Hard Disk Virtual Disk Images</title>
|
---|
266 | <cmdsynopsis id="synopsis-vboxmanage-list-hdds">
|
---|
267 | <command>VBoxManage list</command>
|
---|
268 | <arg choice="plain">hdds</arg>
|
---|
269 | </cmdsynopsis>
|
---|
270 | <para>
|
---|
271 | The <command>VBoxManage list hdds</command> command shows
|
---|
272 | information about the hard disk virtual disk images that are
|
---|
273 | currently in use by the &product-name; software. For each image,
|
---|
274 | the output shows all the settings, the UUIDs associated with the
|
---|
275 | image by &product-name;, and all files associated with the
|
---|
276 | image.
|
---|
277 | </para>
|
---|
278 | <para>
|
---|
279 | This command performs the same function as the Virtual Media
|
---|
280 | Manager. See <xref linkend="virtual-media-manager"/>.
|
---|
281 | </para>
|
---|
282 | </refsect2>
|
---|
283 | <refsect2 id="vboxmanage-list-hostcpuids">
|
---|
284 | <title>List the CPUID Information for the Host System CPUs</title>
|
---|
285 | <cmdsynopsis id="synopsis-vboxmanage-list-hostcpuids">
|
---|
286 | <command>VBoxManage list</command>
|
---|
287 | <arg choice="plain">hostcpuids</arg>
|
---|
288 | </cmdsynopsis>
|
---|
289 | <para>
|
---|
290 | The <command>VBoxManage list hostcpuids</command> command lists
|
---|
291 | CPUID information for each CPU on the host system. Use this
|
---|
292 | information to perform a more fine grained analyis of the host
|
---|
293 | system's virtualization capabilities.
|
---|
294 | </para>
|
---|
295 | </refsect2>
|
---|
296 | <refsect2 id="vboxmanage-list-hostdrives">
|
---|
297 | <title>List the Storage Drives on the Host System</title>
|
---|
298 | <cmdsynopsis id="synopsis-vboxmanage-list-hostdrives">
|
---|
299 | <command>VBoxManage list</command>
|
---|
300 | <arg choice="plain">hostdrives</arg>
|
---|
301 | </cmdsynopsis>
|
---|
302 | <para>
|
---|
303 | The <command>VBoxManage list hostdrives</command> command lists
|
---|
304 | the disk drives on the host system potentially useful for creating
|
---|
305 | a VMDK raw disk image. Each entry includes the name used to
|
---|
306 | reference them from within &product-name;.
|
---|
307 | </para>
|
---|
308 | </refsect2>
|
---|
309 | <refsect2 id="vboxmanage-list-hostdvds">
|
---|
310 | <title>List the DVD Drives on the Host System</title>
|
---|
311 | <cmdsynopsis id="synopsis-vboxmanage-list-hostdvds">
|
---|
312 | <command>VBoxManage list</command>
|
---|
313 | <arg choice="plain">hostdvds</arg>
|
---|
314 | </cmdsynopsis>
|
---|
315 | <para>
|
---|
316 | The <command>VBoxManage list hostdvds</command> command lists
|
---|
317 | the DVD drives on the host system. Each DVD entry includes
|
---|
318 | the name used to access them from within &product-name;.
|
---|
319 | </para>
|
---|
320 | </refsect2>
|
---|
321 | <refsect2 id="vboxmanage-list-hostfloppies">
|
---|
322 | <title>List the Floppy Disk Drives on the Host System</title>
|
---|
323 | <cmdsynopsis id="synopsis-vboxmanage-list-hostfloppies">
|
---|
324 | <command>VBoxManage list</command>
|
---|
325 | <arg choice="plain">hostfloppies</arg>
|
---|
326 | </cmdsynopsis>
|
---|
327 | <para>
|
---|
328 | The <command>VBoxManage list hostfloppies</command> command
|
---|
329 | lists the floppy disk drives on the host system. Each floppy
|
---|
330 | disk entry includes the name used to access them from within
|
---|
331 | &product-name;.
|
---|
332 | </para>
|
---|
333 | </refsect2>
|
---|
334 | <refsect2 id="vboxmanage-list-hostinfo">
|
---|
335 | <title>List Information About the Host System</title>
|
---|
336 | <cmdsynopsis id="synopsis-vboxmanage-list-hostinfo">
|
---|
337 | <command>VBoxManage list</command>
|
---|
338 | <arg choice="plain">hostinfo</arg>
|
---|
339 | </cmdsynopsis>
|
---|
340 | <para>
|
---|
341 | The <command>VBoxManage list hostinfo</command> command shows
|
---|
342 | information about the host system. The output includes
|
---|
343 | information about the CPUs, memory, and the OS version.
|
---|
344 | </para>
|
---|
345 | </refsect2>
|
---|
346 | <refsect2 id="vboxmanage-list-hostonlyifs">
|
---|
347 | <title>List the Host-Only Network Interfaces on the Host System</title>
|
---|
348 | <cmdsynopsis id="synopsis-vboxmanage-list-hostonlyifs">
|
---|
349 | <command>VBoxManage list</command>
|
---|
350 | <arg choice="plain">hostonlyifs</arg>
|
---|
351 | </cmdsynopsis>
|
---|
352 | <para>
|
---|
353 | The <command>VBoxManage list hostonlyifs</command> command lists
|
---|
354 | the host-only network interfaces that are currently available on
|
---|
355 | the host system. The output shows detailed configuration
|
---|
356 | information about each interface. See <xref linkend="networkingdetails"/>.
|
---|
357 | </para>
|
---|
358 | </refsect2>
|
---|
359 | <refsect2 id="vboxmanage-list-hostonlynets">
|
---|
360 | <title>List Host-Only Networks</title>
|
---|
361 | <cmdsynopsis id="synopsis-vboxmanage-list-hostonlynets">
|
---|
362 | <command>VBoxManage list</command>
|
---|
363 | <arg choice="plain">hostonlynets</arg>
|
---|
364 | </cmdsynopsis>
|
---|
365 | <para>
|
---|
366 | The <command>VBoxManage list hostonlynets</command> command
|
---|
367 | lists the host-only networks that have been configured. A
|
---|
368 | host-only network provides connectivity between the host and
|
---|
369 | local VMs. See <xref linkend="networkingdetails"/>.
|
---|
370 | </para>
|
---|
371 | </refsect2>
|
---|
372 | <refsect2 id="vboxmanage-list-intnets">
|
---|
373 | <title>List Internal Networks</title>
|
---|
374 | <cmdsynopsis id="synopsis-vboxmanage-list-intnets">
|
---|
375 | <command>VBoxManage list</command>
|
---|
376 | <arg choice="plain">intnets</arg>
|
---|
377 | </cmdsynopsis>
|
---|
378 | <para>
|
---|
379 | The <command>VBoxManage list intnets</command> command shows
|
---|
380 | information about the internal networks. See
|
---|
381 | <xref linkend="networkingdetails"/>.
|
---|
382 | </para>
|
---|
383 | </refsect2>
|
---|
384 | <refsect2 id="vboxmanage-list-natnets">
|
---|
385 | <title>List the NAT Network Interfaces on the Host System</title>
|
---|
386 | <cmdsynopsis id="synopsis-vboxmanage-list-natnets">
|
---|
387 | <command>VBoxManage list</command>
|
---|
388 | <arg choice="plain">natnets</arg>
|
---|
389 | </cmdsynopsis>
|
---|
390 | <para>
|
---|
391 | The <command>VBoxManage list natnets</command> command lists the
|
---|
392 | NAT network interfaces that are currently available on the host
|
---|
393 | system. See <xref linkend="networkingdetails"/>.
|
---|
394 | </para>
|
---|
395 | </refsect2>
|
---|
396 | <refsect2 id="vboxmanage-list-ostypes">
|
---|
397 | <title>List the Guest Operating Systems</title>
|
---|
398 | <cmdsynopsis id="synopsis-vboxmanage-list-ostypes">
|
---|
399 | <command>VBoxManage list</command>
|
---|
400 | <arg choice="plain">ostypes</arg>
|
---|
401 | </cmdsynopsis>
|
---|
402 | <para>
|
---|
403 | The <command>VBoxManage list ostypes</command> command lists all
|
---|
404 | guest operating systems (OSes) that are known to &product-name;.
|
---|
405 | Each OS entry includes an identifier, a description, a family
|
---|
406 | identifier, a family description, and whether the OS has 64-bit
|
---|
407 | support.
|
---|
408 | </para>
|
---|
409 | <para>
|
---|
410 | You can use these identifiers with the <command>VBoxManage
|
---|
411 | modifyvm</command> command.
|
---|
412 | </para>
|
---|
413 | </refsect2>
|
---|
414 | <refsect2 id="vboxmanage-list-ossubtypes">
|
---|
415 | <title>List the Guest Operating System Subtypes</title>
|
---|
416 | <cmdsynopsis id="synopsis-vboxmanage-list-ossubtypes">
|
---|
417 | <command>VBoxManage list</command>
|
---|
418 | <arg choice="plain">ossubtypes</arg>
|
---|
419 | </cmdsynopsis>
|
---|
420 | <para>
|
---|
421 | The <command>VBoxManage list ossubtypes</command> command lists
|
---|
422 | all guest operating system (OS) subtypes along with the
|
---|
423 | associated guest OS descriptions that are known to &product-name;.
|
---|
424 | Each list entry includes a guest OS family identifier, the guest
|
---|
425 | OS subtypes associated with that OS family (if any), and a
|
---|
426 | description the guest OSes associated with that OS subtype.
|
---|
427 | </para>
|
---|
428 | </refsect2>
|
---|
429 | <refsect2 id="vboxmanage-list-runningvms">
|
---|
430 | <title>List the Running Virtual Machines</title>
|
---|
431 | <cmdsynopsis id="synopsis-vboxmanage-list-runningvms">
|
---|
432 | <command>VBoxManage list</command>
|
---|
433 | <arg choice="plain">runningvms</arg>
|
---|
434 | </cmdsynopsis>
|
---|
435 | <para>
|
---|
436 | The <command>VBoxManage list runningvms</command> command lists
|
---|
437 | all virtual machines (VMs) that are currently running. By
|
---|
438 | default this displays a compact list that shows the name and
|
---|
439 | UUID of each VM.
|
---|
440 | </para>
|
---|
441 | </refsect2>
|
---|
442 | <refsect2 id="vboxmanage-list-screenshotformats">
|
---|
443 | <title>List the Available Screen Shot Formats</title>
|
---|
444 | <cmdsynopsis id="synopsis-vboxmanage-list-screenshotformats">
|
---|
445 | <command>VBoxManage list</command>
|
---|
446 | <arg choice="plain">screenshotformats</arg>
|
---|
447 | </cmdsynopsis>
|
---|
448 | <para>
|
---|
449 | The <command>VBoxManage list screenshotformats</command> command
|
---|
450 | shows the list of available screen shot formats.
|
---|
451 | </para>
|
---|
452 | </refsect2>
|
---|
453 | <refsect2 id="vboxmanage-list-systemproperties">
|
---|
454 | <title>List System Properties</title>
|
---|
455 | <cmdsynopsis id="synopsis-vboxmanage-list-systemproperties">
|
---|
456 | <command>VBoxManage list</command>
|
---|
457 | <arg choice="plain">systemproperties</arg>
|
---|
458 | </cmdsynopsis>
|
---|
459 | <para>
|
---|
460 | The <command>VBoxManage list systemproperties</command> command
|
---|
461 | shows a large collection of global &product-name; settings and
|
---|
462 | limits, such as minimum and maximum guest RAM, virtual hard disk
|
---|
463 | size, folder settings, and the current authentication library in
|
---|
464 | use.
|
---|
465 | </para>
|
---|
466 | </refsect2>
|
---|
467 | <refsect2 id="vboxmanage-list-usbfilters">
|
---|
468 | <title>List the Registered Global USB Filters</title>
|
---|
469 | <cmdsynopsis id="synopsis-vboxmanage-list-usbfilters">
|
---|
470 | <command>VBoxManage list</command>
|
---|
471 | <arg choice="plain">usbfilters</arg>
|
---|
472 | </cmdsynopsis>
|
---|
473 | <para>
|
---|
474 | The <command>VBoxManage list usbfilters</command> command lists
|
---|
475 | all global USB filters registered with &product-name; and
|
---|
476 | displays the filter parameters. Global USB filters are for
|
---|
477 | devices which are accessible to all virtual machines.
|
---|
478 | </para>
|
---|
479 | </refsect2>
|
---|
480 | <refsect2 id="vboxmanage-list-usbhost">
|
---|
481 | <title>List the USB Devices on the Host System</title>
|
---|
482 | <cmdsynopsis id="synopsis-vboxmanage-list-usbhost">
|
---|
483 | <command>VBoxManage list</command>
|
---|
484 | <arg choice="plain">usbhost</arg>
|
---|
485 | </cmdsynopsis>
|
---|
486 | <para>
|
---|
487 | The <command>VBoxManage list usbhost</command> command shows
|
---|
488 | information about the USB devices that are attached to the host
|
---|
489 | system. The output includes information that you can use to
|
---|
490 | construct USB filters and indicates whether the device is
|
---|
491 | currently in use by the host system.
|
---|
492 | </para>
|
---|
493 | </refsect2>
|
---|
494 | <refsect2 id="vboxmanage-list-vms">
|
---|
495 | <title>List Virtual Machines</title>
|
---|
496 | <cmdsynopsis id="synopsis-vboxmanage-list-vms">
|
---|
497 | <command>VBoxManage list</command>
|
---|
498 | <arg choice="plain">vms</arg>
|
---|
499 | </cmdsynopsis>
|
---|
500 | <para>
|
---|
501 | The <command>VBoxManage list vms</command> command lists all
|
---|
502 | virtual machines (VMs) that are currently registered with
|
---|
503 | &product-name;. By default this command displays a compact list
|
---|
504 | that shows the name and UUID of each VM.
|
---|
505 | </para>
|
---|
506 | </refsect2>
|
---|
507 | <refsect2 id="vboxmanage-list-webcams">
|
---|
508 | <title>List the Webcams Attached to a Running Virtual Machine</title>
|
---|
509 | <cmdsynopsis id="synopsis-vboxmanage-list-webcams">
|
---|
510 | <command>VBoxManage list</command>
|
---|
511 | <arg choice="plain">webcams</arg>
|
---|
512 | </cmdsynopsis>
|
---|
513 | <para>
|
---|
514 | The <command>VBoxManage list webcams</command> command shows the
|
---|
515 | list of webcams that are attached to the running VM.
|
---|
516 | </para>
|
---|
517 | <para>
|
---|
518 | The output is a list of absolute paths or aliases that are used
|
---|
519 | to attach the webcams to the VM by using the <command>VBoxManage
|
---|
520 | webcam attach</command> command.
|
---|
521 | </para>
|
---|
522 | </refsect2>
|
---|
523 | </refsect1>
|
---|
524 |
|
---|
525 | <refsect1 id="vboxmanage-list-examples">
|
---|
526 | <title>Examples</title>
|
---|
527 | <remark role="help-scope" condition="GLOBAL" />
|
---|
528 | <para>
|
---|
529 | The following command lists the VM groups configured for
|
---|
530 | &product-name;.
|
---|
531 | </para>
|
---|
532 | <screen>$ VBoxManage list groups
|
---|
533 | "/Linux-VMs"
|
---|
534 | "/Windows-VMs"</screen>
|
---|
535 | <para>
|
---|
536 | The following command lists the VMs that are currently running.
|
---|
537 | </para>
|
---|
538 | <screen>$ VBoxManage list runningvms
|
---|
539 | "ol7" {<replaceable>ol7-UUID</replaceable>}
|
---|
540 | "win8" {<replaceable>win8-UUID</replaceable>}</screen>
|
---|
541 | </refsect1>
|
---|
542 | </refentry>
|
---|