VirtualBox

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

Last change on this file since 103131 was 99513, checked in by vboxsync, 19 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: 4.0 KB
Line 
1<?xml version="1.0" encoding="UTF-8"?>
2<!--
3 manpage, user manual, usage: VBoxManage checkmediumpwd
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-checkmediumpwd" lang="en">
32 <refentryinfo>
33 <pubdate>$Date: 2023-04-21 21:59:02 +0000 (Fri, 21 Apr 2023) $</pubdate>
34 <title>VBoxManage checkmediumpwd</title>
35 </refentryinfo>
36
37 <refmeta>
38 <refentrytitle>VBoxManage-checkmediumpwd</refentrytitle>
39 <manvolnum>1</manvolnum>
40 </refmeta>
41
42 <refnamediv>
43 <refname>VBoxManage-checkmediumpwd</refname>
44 <refpurpose>check encryption password on a DEK-encrypted medium or a disk image</refpurpose>
45 <refclass>&product-name;</refclass>
46 </refnamediv>
47
48 <refsynopsisdiv>
49 <cmdsynopsis id="synopsis-vboxmanage-checkmediumpwd">
50<!-- The 'id' is mandatory and must start with 'synopsis-'. -->
51 <command>VBoxManage checkmediumpwd</command>
52 <group choice="req">
53 <arg choice="plain"><replaceable>uuid</replaceable></arg>
54 <arg choice="plain"><replaceable>filename</replaceable></arg>
55 </group>
56 <arg choice="req"><replaceable>password-file</replaceable></arg>
57 </cmdsynopsis>
58 </refsynopsisdiv>
59
60 <refsect1 id="vboxmanage-checkmediumpwd-description">
61 <title>Description</title>
62 <para>
63 The <command>VBoxManage checkmediumpwd</command> command checks
64 the current encryption password on a DEK-encrypted medium or a
65 disk image. See <xref linkend="diskencryption-encryption" />.
66 </para>
67 <para>
68 The command response indicates if the specified password is
69 correct.
70 </para>
71 <variablelist>
72 <varlistentry>
73 <term><replaceable>uuid</replaceable> | <replaceable>filename</replaceable></term>
74 <listitem><para>
75 Specifies the Universally Unique Identifier (UUID) or the
76 absolute path name of the medium or image.
77 </para></listitem>
78 </varlistentry>
79 <varlistentry>
80 <term><replaceable>password-file</replaceable></term>
81 <listitem><para>
82 Specifies the password to check. The password
83 can be the absolute path name of a password file
84 on the host OS or the dash character (<literal>-</literal>)
85 to prompt you for the password on the command line.
86 </para></listitem>
87 </varlistentry>
88 </variablelist>
89 </refsect1>
90
91 <refsect1 id="vboxmanage-checkmediumpwd-examples">
92 <title>Examples</title>
93 <remark role="help-scope" condition="GLOBAL" />
94 <para>
95 The following example checks the encryption password for the
96 <filename>ol7u4-1.vdi</filename> disk image. The password
97 is contained in a file called <filename>pwfile</filename>.
98 </para>
99 <para>
100 The command returns a message indicating that the specified
101 password is correct.
102 </para>
103<screen>$ VBoxManage checkmediumpwd "$HOME/VirtualBox VMs/ol7u4/ol7u4-1.vdi" /home/user/pwfile
104 The given password is correct</screen>
105 </refsect1>
106
107 <refsect1 id="vboxmanage-checkmediumpwd-see-also">
108 <title>See Also</title>
109 <para>
110 <xref linkend="vboxmanage-encryptmedium" />
111 </para>
112 </refsect1>
113</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