VirtualBox

source: vbox/trunk/doc/manual/en_US/man_VBoxManage-showvminfo.xml@ 103131

Last change on this file since 103131 was 99513, checked in by vboxsync, 20 months ago

manual,VBoxManage,isomaker/viso: Require all refsect1 and refsect2 elements to have @id attributes in manpages (refentry) to make these predictable and the split up topic files easier to handle for the docs team. Also requires these @id values to start with the refentry @id + '-'. Corrected a few bogus ones. Because 'controlvm' has too many sub-commands, HELP_SCOPE_ IDs will not be generated for 'See Also' and 'Examples' sections. bugref:10302

  • Property svn:eol-style set to native
  • Property svn:keywords set to Author Date Id Revision
File size: 8.3 KB
Line 
1<?xml version="1.0" encoding="UTF-8"?>
2<!--
3 manpage, user manual, usage: VBoxManage showvminfo
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-showvminfo" lang="en">
32 <refentryinfo>
33 <pubdate>$Date: 2023-04-21 21:59:02 +0000 (Fri, 21 Apr 2023) $</pubdate>
34 <title>VBoxManage showvminfo</title>
35 </refentryinfo>
36
37 <refmeta>
38 <refentrytitle>VBoxManage-showvminfo</refentrytitle>
39 <manvolnum>1</manvolnum>
40 </refmeta>
41
42 <refnamediv>
43 <refname>VBoxManage-showvminfo</refname>
44 <refpurpose>show configuration information or log file contents for a virtual
45 machine</refpurpose>
46 <refclass>&product-name;</refclass>
47 </refnamediv>
48
49 <refsynopsisdiv>
50 <cmdsynopsis id="synopsis-vboxmanage-showvminfo-default">
51<!-- The 'id' is mandatory and must start with 'synopsis-'. -->
52 <command>VBoxManage showvminfo</command>
53 <group choice="req">
54 <arg choice="plain"><replaceable>uuid</replaceable></arg>
55 <arg choice="plain"><replaceable>vmname</replaceable></arg>
56 </group>
57 <arg>--details</arg>
58 <arg>--machinereadable</arg>
59 <arg>--password-id</arg>
60 <arg>--password</arg>
61 </cmdsynopsis>
62
63 <cmdsynopsis id="synopsis-vboxmanage-showvminfo-log">
64 <command>VBoxManage showvminfo</command>
65 <group choice="req">
66 <arg choice="plain"><replaceable>uuid</replaceable></arg>
67 <arg choice="plain"><replaceable>vmname</replaceable></arg>
68 </group>
69 <arg choice="req">--log=<replaceable>index</replaceable></arg>
70 <arg>--password-id <replaceable>id</replaceable></arg>
71 <arg>--password <replaceable>file</replaceable>|-</arg>
72 </cmdsynopsis>
73 </refsynopsisdiv>
74
75 <refsect1 id="vboxmanage-showvminfo-description">
76 <title>Description</title>
77 <para>
78 The <command>VBoxManage showvminfo</command> command outputs
79 configuration information or log file contents for a specified
80 virtual machine (VM).
81 </para>
82 <refsect2 id="vboxmanage-showvminfo-default">
83 <title>Viewing Virtual Machine Information</title>
84 <remark role="help-copy-synopsis"/>
85 <para>
86 The <command>VBoxManage showvminfo</command> command outputs
87 information about the specified VM in a detailed format or in a
88 machine-readable format.
89 </para>
90 <para>
91 The <command>VBoxManage showvminfo</command> command shows the
92 same information for the specified VM in the same format as the
93 <command>VBoxManage list vms --long</command> command.
94 </para>
95 <variablelist>
96 <varlistentry>
97 <term><option>--details</option></term>
98 <listitem><para>
99 Includes detailed information about the VM.
100 </para></listitem>
101 </varlistentry>
102 <varlistentry>
103 <term><option>--machinereadable</option></term>
104 <listitem><para>
105 Specifies that the VM information be in a machine-readable
106 format.
107 </para></listitem>
108 </varlistentry>
109 <varlistentry>
110 <term><option>--password-id <replaceable>id</replaceable></option></term>
111 <listitem><para>
112 Specifies password id of the VM if it is encrypted.
113 </para></listitem>
114 </varlistentry>
115 <varlistentry>
116 <term><option>--password <replaceable>file</replaceable>|-</option></term>
117 <listitem><para>
118 Specifies password of the VM if it is encrypted. Either
119 specify the absolute pathname of a password file on the
120 host operating system, or <literal>-</literal> to prompt
121 you for the password.
122 </para></listitem>
123 </varlistentry>
124 </variablelist>
125 </refsect2>
126 <refsect2 id="vboxmanage-showvminfo-log">
127 <title>Viewing Virtual Machine Log Contents</title>
128 <remark role="help-copy-synopsis"/>
129 <para>
130 The <command>VBoxManage showvminfo --log</command> command
131 outputs the contents of one of the specified VM's log files.
132 </para>
133 <variablelist>
134 <varlistentry>
135 <term><option>--log=<replaceable>index</replaceable></option></term>
136 <listitem><para>
137 Specifies a numerical index that identifies the log file.
138 </para><para>
139 The index value starts at <literal>0</literal>, which
140 indicates the <filename>VBox.log</filename> file. An index
141 value of <literal>1</literal> indicates the
142 <filename>VBoxHardening.log</filename> file. Index values
143 starting at <literal>2</literal> indicate other log files,
144 such as the <filename>VBox.log.1</filename> file.
145 </para></listitem>
146 </varlistentry>
147 <varlistentry>
148 <term><option>--password-id <replaceable>id</replaceable></option></term>
149 <listitem><para>
150 Specifies password id of the VM if it is encrypted.
151 </para></listitem>
152 </varlistentry>
153 <varlistentry>
154 <term><option>--password <replaceable>file</replaceable>|-</option></term>
155 <listitem><para>
156 Specifies password of the VM if it is encrypted. Either
157 specify the absolute pathname of a password file on the
158 host operating system, or <literal>-</literal> to prompt
159 you for the password.
160 </para></listitem>
161 </varlistentry>
162 </variablelist>
163 </refsect2>
164 </refsect1>
165
166 <refsect1 id="vboxmanage-showvminfo-examples">
167 <title>Examples</title>
168 <remark role="help-scope" condition="GLOBAL"/>
169 <para>
170 The following example shows typical output for this command:
171 </para>
172<screen>$ VBoxManage showvminfo "Windows 10"
173VirtualBox Command Line Management Interface Version <replaceable>version-number</replaceable>
174Copyright (C) 2005-2023 Oracle and/or its affiliates
175
176Name: Windows 10
177Groups: /
178Guest OS: Windows 10 (64-bit)
179UUID: 1bf3464d-57c6-4d49-92a9-a5cc3816b7e7
180Config file: /home/username/VirtualBox VMs/Windows 10/Windows 10.vbox
181Snapshot folder: /home/username/VirtualBox VMs/Windows 10/Snapshots
182Log folder: /home/username/VirtualBox VMs/Windows 10/Logs
183Hardware UUID: 1bf3464d-57c6-4d49-92a9-a5cc3816b7e7
184Memory size: 2048MB
185Page Fusion: off
186VRAM size: 12MB
187CPU exec cap: 100%
188...</screen>
189 <para>
190 The following example shows the information output in a
191 machine-readable format, which shows the entries as a
192 <replaceable>property</replaceable>=<replaceable>value</replaceable>
193 string:
194 </para>
195<screen>$ VBoxManage showvminfo "Windows 10" --machinereadable
196...
197groups="/"
198ostype="Windows 10 (64-bit)"
199UUID="1bf3464d-57c6-4d49-92a9-a5cc3816b7e7"
200...</screen>
201 <para>
202 The following example shows the contents of the
203 <filename>VBox.log</filename> log file:
204 </para>
205<screen>$ VBoxManage showvminfo "Windows 10" --log 0
20600:00:02.895106 VirtualBox VM 6.0.0_RC1 r127378 linux.amd64 (Dec 10 2018 17:16:06) release log
20700:00:02.895109 Log opened 2018-12-14T14:31:44.088259000Z
20800:00:02.895111 Build Type: release
20900:00:02.895115 OS Product: Linux
21000:00:02.895117 OS Release: 4.1.12-61.1.22.el7uek.x86_64
21100:00:02.895119 OS Version: #2 SMP Fri Dec 2 09:28:44 PST 2016
212...</screen>
213 </refsect1>
214
215 <refsect1 id="vboxmanage-showvminfo-see-also">
216 <title>See Also</title>
217 <para>
218 <xref linkend="vboxmanage-list" />
219 </para>
220 </refsect1>
221</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