path: root/doc/manual/en_US/man_VBoxManage-list.xml

<?xml version="1.0" encoding="UTF-8"?>
<!--
    manpage, user manual, usage: VBoxManage list
-->
<!--
    Copyright (C) 2006-2022 Oracle and/or its affiliates.

    This file is part of VirtualBox base platform packages, as
    available from https://www.virtualbox.org.

    This program is free software; you can redistribute it and/or
    modify it under the terms of the GNU General Public License
    as published by the Free Software Foundation, in version 3 of the
    License.

    This program is distributed in the hope that it will be useful, but
    WITHOUT ANY WARRANTY; without even the implied warranty of
    MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
    General Public License for more details.

    You should have received a copy of the GNU General Public License
    along with this program; if not, see <https://www.gnu.org/licenses>.

    SPDX-License-Identifier: GPL-3.0-only
-->
<!DOCTYPE refentry PUBLIC "-//OASIS//DTD DocBook XML V4.5//EN"
  "http://www.oasis-open.org/docbook/xml/4.5/docbookx.dtd"[
<!ENTITY % all.entities SYSTEM "all-entities.ent">
%all.entities;
]>
<refentry id="vboxmanage-list" lang="en">
  <refentryinfo>
    <pubdate>$Date: 2022-10-06 17:22:35 +0200 (Thu, 06 Oct 2022) $</pubdate>
    <title>VBoxManage list</title>
  </refentryinfo>

  <refmeta>
    <refentrytitle>VBoxManage-list</refentrytitle>
    <manvolnum>1</manvolnum>
  </refmeta>

  <refnamediv>
    <refname>VBoxManage-list</refname>
    <refpurpose>view system information and VM configuration details</refpurpose>
    <refclass>&product-name;</refclass>
  </refnamediv>

  <refsynopsisdiv>
    <cmdsynopsis id="synopsis-vboxmanage-list">
<!-- The 'id' is mandatory and must start with 'synopsis-'. -->
      <command>VBoxManage list</command>
      <arg>--long</arg>
      <arg>--sorted</arg>
      <group>
        <arg choice="plain">bridgedifs</arg>
        <arg choice="plain">cloudnets</arg>
        <arg choice="plain">cloudprofiles</arg>
        <arg choice="plain">cloudproviders</arg>
        <arg choice="plain">cpu-profiles</arg>
        <arg choice="plain">dhcpservers</arg>
        <arg choice="plain">dvds</arg>
        <arg choice="plain">extpacks</arg>
        <arg choice="plain">floppies</arg>
        <arg choice="plain">groups</arg>
        <arg choice="plain">hddbackends</arg>
        <arg choice="plain">hdds</arg>
        <arg choice="plain">hostcpuids</arg>
        <arg choice="plain">hostdrives</arg>
        <arg choice="plain">hostdvds</arg>
        <arg choice="plain">hostfloppies</arg>
        <arg choice="plain">hostinfo</arg>
        <arg choice="plain">hostonlyifs</arg>
        <arg choice="plain">hostonlynets</arg>
        <arg choice="plain">intnets</arg>
        <arg choice="plain">natnets</arg>
        <arg choice="plain">ostypes</arg>
        <arg choice="plain">runningvms</arg>
        <arg choice="plain">screenshotformats</arg>
        <arg choice="plain">systemproperties</arg>
        <arg choice="plain">usbfilters</arg>
        <arg choice="plain">usbhost</arg>
        <arg choice="plain">vms</arg>
        <arg choice="plain">webcams</arg>
      </group>
    </cmdsynopsis>
  </refsynopsisdiv>

  <refsect1>
    <title>Description</title>
    <para>
      The <command>VBoxManage list</command> subcommands enable you to
      obtain information about the &product-name; software, the VMs
      and associated services that you create.
    </para>
    <refsect2 id="vboxmanage-list-common-options">
      <title>Common Options</title>
      <variablelist>
        <varlistentry>
          <term><option>--long</option></term>
          <listitem><para>
              Shows detailed information about each information entry
              if available. The short form of this option is
              <option>-l</option>.
            </para></listitem>
        </varlistentry>
        <varlistentry>
          <term><option>--sorted</option></term>
          <listitem><para>
              Sorts the list of information entries alphabetically. The
               short form of this option is <option>-s</option>.
            </para></listitem>
        </varlistentry>
      </variablelist>
    </refsect2>
    <refsect2 id="vboxmanage-list-bridgedifs">
      <title>List the Bridged Network Interfaces on the Host System</title>
      <cmdsynopsis id="synopsis-vboxmanage-list-bridgedifs">
        <command>VBoxManage list</command>
        <arg choice="plain">bridgedifs</arg>
      </cmdsynopsis>
      <para>
        The <command>VBoxManage list bridgedifs</command> command lists
        the bridged network interfaces that are currently available on
        the host system. The output shows detailed configuration
        information about each interface. See <xref linkend="networkingdetails"/>.
      </para>
    </refsect2>
    <refsect2 id="vboxmanage-list-cloudnets">
      <title>List the Cloud Network Interfaces</title>
      <cmdsynopsis id="synopsis-vboxmanage-list-cloudnets">
        <command>VBoxManage list</command>
        <arg choice="plain">cloudnets</arg>
      </cmdsynopsis>
      <para>
        The <command>VBoxManage list cloudnets</command> command
        lists the cloud network interfaces that have been configured. A cloud
        network interface provides connectivity between local VMs and a
        cloud network.
      </para>
    </refsect2>
    <refsect2 id="vboxmanage-list-cloudprofiles">
      <title>List the Cloud Profiles</title>
      <cmdsynopsis id="synopsis-vboxmanage-list-cloudprofiles">
        <command>VBoxManage list</command>
        <arg choice="plain">cloudprofiles</arg>
      </cmdsynopsis>
      <para>
        The <command>VBoxManage list cloudprofiles</command> command
        lists the cloud profiles that have been configured. A cloud
        profile contains settings for a cloud service account.
      </para>
    </refsect2>
    <refsect2 id="vboxmanage-list-cloudproviders">
      <title>List the Cloud Providers</title>
      <cmdsynopsis id="synopsis-vboxmanage-list-cloudproviders">
        <command>VBoxManage list</command>
        <arg choice="plain">cloudproviders</arg>
      </cmdsynopsis>
      <para>
        The <command>VBoxManage list cloudproviders</command> command
        lists the cloud providers that are supported by &product-name;.
        Oracle Cloud Infrastructure is an example of a cloud provider.
      </para>
    </refsect2>
    <refsect2 id="vboxmanage-list-cpu-profiles">
      <title>List the known CPU Profiles</title>
      <cmdsynopsis id="synopsis-vboxmanage-list-cpu-profiles">
        <command>VBoxManage list</command>
        <arg choice="plain">cpu-profiles</arg>
      </cmdsynopsis>
      <para>
        The <command>VBoxManage list cpu-profiles</command> command
        lists the CPU profiles that are known by &product-name;.
      </para>
    </refsect2>
    <refsect2 id="vboxmanage-list-dhcpservers">
      <title>List the DHCP Servers on the Host System</title>
      <cmdsynopsis id="synopsis-vboxmanage-list-dhcpservers">
        <command>VBoxManage list</command>
        <arg choice="plain">dhcpservers</arg>
      </cmdsynopsis>
      <para>
        The <command>VBoxManage list dhcpservers</command> command lists
        the DHCP servers that are currently available on the host
        system. The output shows detailed configuration information
        about each DHCP server. See <xref linkend="networkingdetails"/>.
      </para>
    </refsect2>
    <refsect2 id="vboxmanage-list-dvds">
      <title>List the DVD Virtual Disk Images</title>
      <cmdsynopsis id="synopsis-vboxmanage-list-dvds">
        <command>VBoxManage list</command>
        <arg choice="plain">dvds</arg>
      </cmdsynopsis>
      <para>
        The <command>VBoxManage list dvds</command> command shows
        information about the DVD virtual disk images that are currently
        in use by the &product-name; software. For each image, the
        output shows all the settings, the UUIDs associated with the
        image by &product-name;, and all files associated with the
        image.
      </para>
      <para>
        This command performs the same function as the Virtual Media
        Manager. See <xref linkend="virtual-media-manager"/>.
      </para>
    </refsect2>
    <refsect2 id="vboxmanage-list-extpacks">
      <title>List the Installed &product-name; Extension Packs</title>
      <cmdsynopsis id="synopsis-vboxmanage-list-extpacks">
        <command>VBoxManage list</command>
        <arg choice="plain">extpacks</arg>
      </cmdsynopsis>
      <para>
        The <command>VBoxManage list extpacks</command> command shows
        all &product-name; extension packs that are currently installed.
        See <xref linkend="intro-installing"/> and
        <xref linkend="vboxmanage-extpack"/>.
      </para>
    </refsect2>
    <refsect2 id="vboxmanage-list-floppies">
      <title>List the Floppy Disk Virtual Disk Images</title>
      <cmdsynopsis id="synopsis-vboxmanage-list-floppies">
        <command>VBoxManage list</command>
        <arg choice="plain">floppies</arg>
      </cmdsynopsis>
      <para>
        The <command>VBoxManage list floppies</command> command shows
        information about the floppy disk images that are currently in
        use by the &product-name; software. For each image, the output
        shows all the settings, the UUIDs associated with the image by
        &product-name;, and all files associated with the image.
      </para>
      <para>
        This command performs the same function as the Virtual Media
        Manager. See <xref linkend="virtual-media-manager"/>.
      </para>
    </refsect2>
    <refsect2 id="vboxmanage-list-groups">
      <title>List the Virtual Machine Groups</title>
      <cmdsynopsis id="synopsis-vboxmanage-list-groups">
        <command>VBoxManage list</command>
        <arg choice="plain">groups</arg>
      </cmdsynopsis>
      <para>
        The <command>VBoxManage list groups</command> command shows
        all VM groups. See <xref linkend="gui-vmgroups"/>.
      </para>
    </refsect2>
    <refsect2 id="vboxmanage-list-hddbackends">
      <title>List the Virtual Disk Backends</title>
      <cmdsynopsis id="synopsis-vboxmanage-list-hddbackends">
        <command>VBoxManage list</command>
        <arg choice="plain">hddbackends</arg>
      </cmdsynopsis>
      <para>
        The <command>VBoxManage list hddbackends</command> command lists
        all known virtual disk backends of the &product-name; software.
        For each such format, such as VDI, VMDK, or RAW, this command
        lists the backend's capabilities and configuration.
      </para>
    </refsect2>
    <refsect2 id="vboxmanage-list-hdds">
      <title>List the Hard Disk Virtual Disk Images</title>
      <cmdsynopsis id="synopsis-vboxmanage-list-hdds">
        <command>VBoxManage list</command>
        <arg choice="plain">hdds</arg>
      </cmdsynopsis>
      <para>
        The <command>VBoxManage list hdds</command> command shows
        information about the hard disk virtual disk images that are
        currently in use by the &product-name; software. For each image,
        the output shows all the settings, the UUIDs associated with the
        image by &product-name;, and all files associated with the
        image.
      </para>
      <para>
        This command performs the same function as the Virtual Media
        Manager. See <xref linkend="virtual-media-manager"/>.
      </para>
    </refsect2>
    <refsect2 id="vboxmanage-list-hostcpuids">
      <title>List the CPUID Information for the Host System CPUs</title>
      <cmdsynopsis id="synopsis-vboxmanage-list-hostcpuids">
        <command>VBoxManage list</command>
        <arg choice="plain">hostcpuids</arg>
      </cmdsynopsis>
      <para>
        The <command>VBoxManage list hostcpuids</command> command lists
        CPUID information for each CPU on the host system. Use this
        information to perform a more fine grained analyis of the host
        system's virtualization capabilities.
      </para>
    </refsect2>
    <refsect2 id="vboxmanage-list-hostdrives">
      <title>List the Storage Drives on the Host System</title>
      <cmdsynopsis id="synopsis-vboxmanage-list-hostdrives">
        <command>VBoxManage list</command>
        <arg choice="plain">hostdrives</arg>
      </cmdsynopsis>
      <para>
        The <command>VBoxManage list hostdrives</command> command lists
        the disk drives on the host system potentially useful for creating
        a VMDK raw disk image. Each entry includes the name used to
        reference them from within &product-name;.
      </para>
    </refsect2>
    <refsect2 id="vboxmanage-list-hostdvds">
      <title>List the DVD Drives on the Host System</title>
      <cmdsynopsis id="synopsis-vboxmanage-list-hostdvds">
        <command>VBoxManage list</command>
        <arg choice="plain">hostdvds</arg>
      </cmdsynopsis>
      <para>
        The <command>VBoxManage list hostdvds</command> command lists
        the DVD drives on the host system. Each DVD entry includes
        the name used to access them from within &product-name;.
      </para>
    </refsect2>
    <refsect2 id="vboxmanage-list-hostfloppies">
      <title>List the Floppy Disk Drives on the Host System</title>
      <cmdsynopsis id="synopsis-vboxmanage-list-hostfloppies">
        <command>VBoxManage list</command>
        <arg choice="plain">hostfloppies</arg>
      </cmdsynopsis>
      <para>
        The <command>VBoxManage list hostfloppies</command> command
        lists the floppy disk drives on the host system. Each floppy
        disk entry includes the name used to access them from within
        &product-name;.
      </para>
    </refsect2>
    <refsect2 id="vboxmanage-list-hostinfo">
      <title>List Information About the Host System</title>
      <cmdsynopsis id="synopsis-vboxmanage-list-hostinfo">
        <command>VBoxManage list</command>
        <arg choice="plain">hostinfo</arg>
      </cmdsynopsis>
      <para>
        The <command>VBoxManage list hostinfo</command> command shows
        information about the host system. The output includes
        information about the CPUs, memory, and the OS version.
      </para>
    </refsect2>
    <refsect2 id="vboxmanage-list-hostonlyifs">
      <title>List the Host-Only Network Interfaces on the Host System</title>
      <cmdsynopsis id="synopsis-vboxmanage-list-hostonlyifs">
        <command>VBoxManage list</command>
        <arg choice="plain">hostonlyifs</arg>
      </cmdsynopsis>
      <para>
        The <command>VBoxManage list hostonlyifs</command> command lists
        the host-only network interfaces that are currently available on
        the host system. The output shows detailed configuration
        information about each interface. See <xref linkend="networkingdetails"/>.
      </para>
    </refsect2>
    <refsect2 id="vboxmanage-list-hostonlynets">
      <title>List Host-Only Networks</title>
      <cmdsynopsis id="synopsis-vboxmanage-list-hostonlynets">
        <command>VBoxManage list</command>
        <arg choice="plain">hostonlynets</arg>
      </cmdsynopsis>
      <para>
        The <command>VBoxManage list hostonlynets</command> command
        lists the host-only networks that have been configured. A
        host-only network provides connectivity between the host and
        local VMs. See <xref linkend="networkingdetails"/>.
      </para>
    </refsect2>
    <refsect2 id="vboxmanage-list-intnets">
      <title>List Internal Networks</title>
      <cmdsynopsis id="synopsis-vboxmanage-list-intnets">
        <command>VBoxManage list</command>
        <arg choice="plain">intnets</arg>
      </cmdsynopsis>
      <para>
        The <command>VBoxManage list intnets</command> command shows
        information about the internal networks. See
        <xref linkend="networkingdetails"/>.
      </para>
    </refsect2>
    <refsect2 id="vboxmanage-list-natnets">
      <title>List the NAT Network Interfaces on the Host System</title>
      <cmdsynopsis id="synopsis-vboxmanage-list-natnets">
        <command>VBoxManage list</command>
        <arg choice="plain">natnets</arg>
      </cmdsynopsis>
      <para>
        The <command>VBoxManage list natnets</command> command lists the
        NAT network interfaces that are currently available on the host
        system. See <xref linkend="networkingdetails"/>.
      </para>
    </refsect2>
    <refsect2 id="vboxmanage-list-ostypes">
      <title>List the Guest Operating Systems</title>
      <cmdsynopsis id="synopsis-vboxmanage-list-ostypes">
        <command>VBoxManage list</command>
        <arg choice="plain">ostypes</arg>
      </cmdsynopsis>
      <para>
        The <command>VBoxManage list ostypes</command> command lists all
        guest operating systems (OSes) that are known to &product-name;.
        Each OS entry includes an identifier, a description, a family
        identifier, a family description, and whether the OS has 64-bit
        support.
      </para>
      <para>
        You can use these identifiers with the <command>VBoxManage
        modifyvm</command> command.
      </para>
    </refsect2>
    <refsect2 id="vboxmanage-list-runningvms">
      <title>List the Running Virtual Machines</title>
      <cmdsynopsis id="synopsis-vboxmanage-list-runningvms">
        <command>VBoxManage list</command>
        <arg choice="plain">runningvms</arg>
      </cmdsynopsis>
      <para>
        The <command>VBoxManage list runningvms</command> command lists
        all virtual machines (VMs) that are currently running. By
        default this displays a compact list that shows the name and
        UUID of each VM.
      </para>
    </refsect2>
    <refsect2 id="vboxmanage-list-screenshotformats">
      <title>List the Available Screen Shot Formats</title>
      <cmdsynopsis id="synopsis-vboxmanage-list-screenshotformats">
        <command>VBoxManage list</command>
        <arg choice="plain">screenshotformats</arg>
      </cmdsynopsis>
      <para>
        The <command>VBoxManage list screenshotformats</command> command
        shows the list of available screen shot formats.
      </para>
    </refsect2>
    <refsect2 id="vboxmanage-list-systemproperties">
      <title>List System Properties</title>
      <cmdsynopsis id="synopsis-vboxmanage-list-systemproperties">
        <command>VBoxManage list</command>
        <arg choice="plain">systemproperties</arg>
      </cmdsynopsis>
      <para>
        The <command>VBoxManage list systemproperties</command> command
        shows a large collection of global &product-name; settings and
        limits, such as minimum and maximum guest RAM, virtual hard disk
        size, folder settings, and the current authentication library in
        use.
      </para>
    </refsect2>
    <refsect2 id="vboxmanage-list-usbfilters">
      <title>List the Registered Global USB Filters</title>
      <cmdsynopsis id="synopsis-vboxmanage-list-usbfilters">
        <command>VBoxManage list</command>
        <arg choice="plain">usbfilters</arg>
      </cmdsynopsis>
      <para>
        The <command>VBoxManage list usbfilters</command> command lists
        all global USB filters registered with &product-name; and
        displays the filter parameters. Global USB filters are for
        devices which are accessible to all virtual machines.
      </para>
    </refsect2>
    <refsect2 id="vboxmanage-list-usbhost">
      <title>List the USB Devices on the Host System</title>
      <cmdsynopsis id="synopsis-vboxmanage-list-usbhost">
        <command>VBoxManage list</command>
        <arg choice="plain">usbhost</arg>
      </cmdsynopsis>
      <para>
        The <command>VBoxManage list usbhost</command> command shows
        information about the USB devices that are attached to the host
        system. The output includes information that you can use to
        construct USB filters and indicates whether the device is
        currently in use by the host system.
      </para>
    </refsect2>
    <refsect2 id="vboxmanage-list-vms">
      <title>List Virtual Machines</title>
      <cmdsynopsis id="synopsis-vboxmanage-list-vms">
        <command>VBoxManage list</command>
        <arg choice="plain">vms</arg>
      </cmdsynopsis>
      <para>
        The <command>VBoxManage list vms</command> command lists all
        virtual machines (VMs) that are currently registered with
        &product-name;. By default this command displays a compact list
        that shows the name and UUID of each VM.
      </para>
    </refsect2>
    <refsect2 id="vboxmanage-list-webcams">
      <title>List the Webcams Attached to a Running Virtual Machine</title>
      <cmdsynopsis id="synopsis-vboxmanage-list-webcams">
        <command>VBoxManage list</command>
        <arg choice="plain">webcams</arg>
      </cmdsynopsis>
      <para>
        The <command>VBoxManage list webcams</command> command shows the
        list of webcams that are attached to the running VM.
      </para>
      <para>
        The output is a list of absolute paths or aliases that are used
        to attach the webcams to the VM by using the <command>VBoxManage
        webcam attach</command> command.
      </para>
    </refsect2>
  </refsect1>

  <refsect1>
    <title>Examples</title>
    <remark role="help-scope" condition="GLOBAL" />
    <para>
      The following command lists the VM groups configured for
      &product-name;.
    </para>
<screen>$ VBoxManage list groups
"/Linux-VMs"
"/Windows-VMs"</screen>
    <para>
      The following command lists the VMs that are currently running.
    </para>
<screen>$ VBoxManage list runningvms
"ol7" {<replaceable>ol7-UUID</replaceable>}
"win8" {<replaceable>win8-UUID</replaceable>}</screen>
  </refsect1>
</refentry>