VirtualBox

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

Last change on this file since 89918 was 82969, checked in by vboxsync, 5 years ago

Copyright year updates - manual ones.

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