VirtualBox

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

Last change on this file since 93707 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: 6.4 KB
Line 
1<?xml version="1.0" encoding="UTF-8"?>
2<!--
3 manpage, user manual, usage: VBoxManage showvminfo
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-showvminfo" lang="en">
21 <refentryinfo>
22 <pubdate>$Date: 2022-02-11 20:10:19 +0000 (Fri, 11 Feb 2022) $</pubdate>
23 <title>VBoxManage showvminfo</title>
24 </refentryinfo>
25
26 <refmeta>
27 <refentrytitle>VBoxManage-showvminfo</refentrytitle>
28 <manvolnum>1</manvolnum>
29 </refmeta>
30
31 <refnamediv>
32 <refname>VBoxManage-showvminfo</refname>
33 <refpurpose>show configuration information or log file contents for a virtual
34 machine</refpurpose>
35 <refclass>&product-name;</refclass>
36 </refnamediv>
37
38 <refsynopsisdiv>
39 <cmdsynopsis id="synopsis-vboxmanage-showvminfo-default">
40<!-- The 'id' is mandatory and must start with 'synopsis-'. -->
41 <command>VBoxManage showvminfo</command>
42 <group choice="req">
43 <arg choice="plain"><replaceable>uuid</replaceable></arg>
44 <arg choice="plain"><replaceable>vmname</replaceable></arg>
45 </group>
46 <arg>--details</arg>
47 <arg>--machinereadable</arg>
48 </cmdsynopsis>
49
50 <cmdsynopsis id="synopsis-vboxmanage-showvminfo-log">
51 <command>VBoxManage showvminfo</command>
52 <group choice="req">
53 <arg choice="plain"><replaceable>uuid</replaceable></arg>
54 <arg choice="plain"><replaceable>vmname</replaceable></arg>
55 </group>
56 <arg choice="req">--log=<replaceable>index</replaceable></arg>
57 </cmdsynopsis>
58 </refsynopsisdiv>
59
60 <refsect1>
61 <title>Description</title>
62 <para>
63 The <command>VBoxManage showvminfo</command> command outputs
64 configuration information or log file contents for a specified
65 virtual machine (VM).
66 </para>
67 <refsect2 id="vboxmanage-showvminfo-default">
68 <title>Viewing Virtual Machine Information</title>
69 <remark role="help-copy-synopsis"/>
70 <para>
71 The <command>VBoxManage showvminfo</command> command outputs
72 information about the specified VM in a detailed format or in a
73 machine-readable format.
74 </para>
75 <para>
76 The <command>VBoxManage showvminfo</command> command shows the
77 same information for the specified VM in the same format as the
78 <command>VBoxManage list vms --long</command> command.
79 </para>
80 <variablelist>
81 <varlistentry>
82 <term><option>--details</option></term>
83 <listitem><para>
84 Includes detailed information about the VM.
85 </para></listitem>
86 </varlistentry>
87 <varlistentry>
88 <term><option>--machinereadable</option></term>
89 <listitem><para>
90 Specifies that the VM information be in a machine-readable
91 format.
92 </para></listitem>
93 </varlistentry>
94 </variablelist>
95 </refsect2>
96 <refsect2 id="vboxmanage-showvminfo-log">
97 <title>Viewing Virtual Machine Log Contents</title>
98 <remark role="help-copy-synopsis"/>
99 <para>
100 The <command>VBoxManage showvminfo --log</command> command
101 outputs the contents of one of the specified VM's log files.
102 </para>
103 <variablelist>
104 <varlistentry>
105 <term><option>--log=<replaceable>index</replaceable></option></term>
106 <listitem><para>
107 Specifies a numerical index that identifies the log file.
108 </para><para>
109 The index value starts at <literal>0</literal>, which
110 indicates the <filename>VBox.log</filename> file. An index
111 value of <literal>1</literal> indicates the
112 <filename>VBoxHardening.log</filename> file. Index values
113 starting at <literal>2</literal> indicate other log files,
114 such as the <filename>VBox.log.1</filename> file.
115 </para></listitem>
116 </varlistentry>
117 </variablelist>
118 </refsect2>
119 </refsect1>
120
121 <refsect1>
122 <title>Examples</title>
123 <remark role="help-scope" condition="GLOBAL"/>
124 <para>
125 The following example shows typical output for this command:
126 </para>
127<screen>$ VBoxManage showvminfo "Windows 10"
128VirtualBox Command Line Management Interface Version <replaceable>version-number</replaceable>
129(C) 2005-2019 Oracle Corporation
130All rights reserved.
131
132Name: Windows 10
133Groups: /
134Guest OS: Windows 10 (64-bit)
135UUID: 1bf3464d-57c6-4d49-92a9-a5cc3816b7e7
136Config file: /home/username/VirtualBox VMs/Windows 10/Windows 10.vbox
137Snapshot folder: /home/username/VirtualBox VMs/Windows 10/Snapshots
138Log folder: /home/username/VirtualBox VMs/Windows 10/Logs
139Hardware UUID: 1bf3464d-57c6-4d49-92a9-a5cc3816b7e7
140Memory size: 2048MB
141Page Fusion: off
142VRAM size: 12MB
143CPU exec cap: 100%
144...</screen>
145 <para>
146 The following example shows the information output in a
147 machine-readable format, which shows the entries as a
148 <replaceable>property</replaceable>=<replaceable>value</replaceable>
149 string:
150 </para>
151<screen>$ VBoxManage showvminfo "Windows 10" --machinereadable
152...
153groups="/"
154ostype="Windows 10 (64-bit)"
155UUID="1bf3464d-57c6-4d49-92a9-a5cc3816b7e7"
156...</screen>
157 <para>
158 The following example shows the contents of the
159 <filename>VBox.log</filename> log file:
160 </para>
161<screen>$ VBoxManage showvminfo "Windows 10" --log 0
16200:00:02.895106 VirtualBox VM 6.0.0_RC1 r127378 linux.amd64 (Dec 10 2018 17:16:06) release log
16300:00:02.895109 Log opened 2018-12-14T14:31:44.088259000Z
16400:00:02.895111 Build Type: release
16500:00:02.895115 OS Product: Linux
16600:00:02.895117 OS Release: 4.1.12-61.1.22.el7uek.x86_64
16700:00:02.895119 OS Version: #2 SMP Fri Dec 2 09:28:44 PST 2016
168...</screen>
169 </refsect1>
170
171 <refsect1>
172 <title>See Also</title>
173 <para>
174 <xref linkend="vboxmanage-list" />
175 </para>
176 </refsect1>
177</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