VirtualBox

source: vbox/trunk/doc/manual/en_US/man_VBoxManage-list.xml@ 94172

Last change on this file since 94172 was 93707, checked in by vboxsync, 3 years ago

doc/manual: Some metadata cleanup and a bit of consistency.

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

© 2024 Oracle Support Privacy / Do Not Sell My Info Terms of Use Trademark Policy Automated Access Etiquette