[94660] | 1 | <?xml version="1.0" encoding="UTF-8"?>
|
---|
| 2 | <!--
|
---|
| 3 | manpage, user manual, usage: VBoxManage encryptvm
|
---|
[96300] | 4 | -->
|
---|
| 5 | <!--
|
---|
[98103] | 6 | Copyright (C) 2006-2023 Oracle and/or its affiliates.
|
---|
[94660] | 7 |
|
---|
[96407] | 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
|
---|
[96300] | 25 | -->
|
---|
[94660] | 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-encryptvm" lang="en">
|
---|
| 32 | <refentryinfo>
|
---|
[94811] | 33 | <pubdate>$Date: 2023-04-21 21:59:02 +0000 (Fri, 21 Apr 2023) $</pubdate>
|
---|
[94660] | 34 | <title>VBoxManage encryptvm</title>
|
---|
| 35 | </refentryinfo>
|
---|
| 36 |
|
---|
| 37 | <refmeta>
|
---|
| 38 | <refentrytitle>VBoxManage-encryptvm</refentrytitle>
|
---|
| 39 | <manvolnum>1</manvolnum>
|
---|
| 40 | </refmeta>
|
---|
| 41 |
|
---|
| 42 | <refnamediv>
|
---|
| 43 | <refname>VBoxManage-encryptvm</refname>
|
---|
| 44 | <refpurpose>change encryption and passwords of the VM</refpurpose>
|
---|
[94811] | 45 | <refclass>&product-name;</refclass>
|
---|
[94660] | 46 | </refnamediv>
|
---|
| 47 |
|
---|
| 48 | <refsynopsisdiv>
|
---|
| 49 | <cmdsynopsis id="synopsis-vboxmanage-encryptvm-setencryption">
|
---|
| 50 | <!-- The 'id' is mandatory and must start with 'synopsis-'. -->
|
---|
| 51 | <command>VBoxManage encryptvm</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="plain">setencryption</arg>
|
---|
| 57 | <arg choice="plain">--old-password <replaceable>file</replaceable></arg>
|
---|
| 58 | <arg choice="plain">--cipher <replaceable>cipher-identifier</replaceable></arg>
|
---|
| 59 | <arg choice="plain">--new-password <replaceable>file</replaceable></arg>
|
---|
| 60 | <arg choice="plain">--new-password-id <replaceable>password-identifier</replaceable></arg>
|
---|
| 61 | <arg choice="plain">--force</arg>
|
---|
| 62 | </cmdsynopsis>
|
---|
| 63 |
|
---|
| 64 | <cmdsynopsis id="synopsis-vboxmanage-encryptvm-checkpassword">
|
---|
| 65 | <command>VBoxManage encryptvm</command>
|
---|
| 66 | <group choice="req">
|
---|
| 67 | <arg choice="plain"><replaceable>uuid</replaceable></arg>
|
---|
| 68 | <arg choice="plain"><replaceable>vmname</replaceable></arg>
|
---|
| 69 | </group>
|
---|
| 70 | <arg choice="plain">checkpassword</arg>
|
---|
| 71 | <arg choice="req"><replaceable>file</replaceable></arg>
|
---|
| 72 | </cmdsynopsis>
|
---|
| 73 |
|
---|
| 74 | <cmdsynopsis id="synopsis-vboxmanage-encryptvm-addpassword">
|
---|
| 75 | <command>VBoxManage encryptvm</command>
|
---|
| 76 | <group choice="req">
|
---|
| 77 | <arg choice="plain"><replaceable>uuid</replaceable></arg>
|
---|
| 78 | <arg choice="plain"><replaceable>vmname</replaceable></arg>
|
---|
| 79 | </group>
|
---|
| 80 | <arg choice="plain">addpassword</arg>
|
---|
| 81 | <arg choice="plain">--password <replaceable>file</replaceable></arg>
|
---|
| 82 | <arg choice="plain">--password-id <replaceable>password-identifier</replaceable></arg>
|
---|
| 83 | </cmdsynopsis>
|
---|
| 84 |
|
---|
| 85 | <cmdsynopsis id="synopsis-vboxmanage-encryptvm-removepassword">
|
---|
| 86 | <command>VBoxManage encryptvm</command>
|
---|
| 87 | <group choice="req">
|
---|
| 88 | <arg choice="plain"><replaceable>uuid</replaceable></arg>
|
---|
| 89 | <arg choice="plain"><replaceable>vmname</replaceable></arg>
|
---|
| 90 | </group>
|
---|
| 91 | <arg choice="plain">removepassword</arg>
|
---|
| 92 | <arg choice="req"><replaceable>password-identifier</replaceable></arg>
|
---|
| 93 | </cmdsynopsis>
|
---|
| 94 | </refsynopsisdiv>
|
---|
| 95 |
|
---|
[99513] | 96 | <refsect1 id="vboxmanage-encryptvm-description">
|
---|
[94660] | 97 | <title>Description</title>
|
---|
| 98 | <para>
|
---|
| 99 | The <command>VBoxManage encryptvm</command> command enables you to
|
---|
| 100 | change the encryption or add and remove user passwords for the
|
---|
| 101 | virtual machine (VM). The following sections describe the subcommands
|
---|
| 102 | that you can use:
|
---|
| 103 | </para>
|
---|
| 104 | <refsect2 id="vboxmanage-encryptvm-setencryption">
|
---|
| 105 | <title>Set encryption of the Virtual Machine</title>
|
---|
| 106 | <remark role="help-copy-synopsis"/>
|
---|
| 107 | <para>
|
---|
| 108 | The <command>VBoxManage encryptvm
|
---|
| 109 | <replaceable>vmname</replaceable> setencryption</command> command
|
---|
| 110 | changes encryption of a VM.
|
---|
| 111 | </para>
|
---|
| 112 | <para>
|
---|
| 113 | Use the <option>--old-password</option> to supply old encryption
|
---|
| 114 | password. Either specify the absolute pathname of a password file
|
---|
| 115 | on the host operating system, or <literal>-</literal> to prompt
|
---|
| 116 | you for the old password.
|
---|
| 117 | </para>
|
---|
| 118 | <para>
|
---|
| 119 | Use the <option>--cipher</option> option to specify the
|
---|
| 120 | new cipher for encryption of the VM. Only <literal>AES-128</literal>
|
---|
| 121 | and <literal>AES-256</literal> are supported. Appropriate mode
|
---|
| 122 | GCM, CTR or XTS will be selected by VM depending on encrypting
|
---|
| 123 | component.
|
---|
| 124 | </para>
|
---|
| 125 | <para>
|
---|
| 126 | Use the <option>--new-password</option> option to specify the
|
---|
| 127 | new password for encryption of the VM. Either specify the absolute
|
---|
| 128 | pathname of a password file on the host operating system, or
|
---|
| 129 | <literal>-</literal> to prompt you for the new password.
|
---|
| 130 | </para>
|
---|
| 131 | <para>
|
---|
| 132 | Use the <option>--new-password-id</option> option to specify the
|
---|
| 133 | new id for the password for encryption of the VM.
|
---|
| 134 | </para>
|
---|
| 135 | <para>
|
---|
| 136 | Use the <option>--force</option> option to make the system
|
---|
| 137 | to reencrypt the VM instead of simple changing the password.
|
---|
| 138 | </para>
|
---|
| 139 | </refsect2>
|
---|
| 140 | <refsect2 id="vboxmanage-encryptvm-checkpassword">
|
---|
| 141 | <title>Check the supplied password is correct</title>
|
---|
| 142 | <remark role="help-copy-synopsis"/>
|
---|
| 143 | <para>
|
---|
| 144 | The <command>VBoxManage encryptvm
|
---|
| 145 | <replaceable>vmname</replaceable> checkpassword</command> command
|
---|
| 146 | checks the correctness of the supplied password.
|
---|
| 147 | </para>
|
---|
| 148 | <para>
|
---|
| 149 | The password can be supplied from file. Specify the absolute
|
---|
| 150 | pathname of a password file on the host operating system. Also,
|
---|
| 151 | you can specify <literal>-</literal> to prompt you for the password.
|
---|
| 152 | </para>
|
---|
| 153 | </refsect2>
|
---|
| 154 | <refsect2 id="vboxmanage-encryptvm-addpassword">
|
---|
| 155 | <title>Add password for decrypting the Virtual Machine</title>
|
---|
| 156 | <remark role="help-copy-synopsis"/>
|
---|
| 157 | <para>
|
---|
| 158 | The <command>VBoxManage encryptvm
|
---|
| 159 | <replaceable>vmname</replaceable> addpassword</command> command
|
---|
| 160 | adds a password for decrypting the VM.
|
---|
| 161 | </para>
|
---|
| 162 | <para>
|
---|
| 163 | Use the <option>--password</option> to supply the encryption
|
---|
| 164 | password. Either specify the absolute pathname of a password file
|
---|
| 165 | on the host operating system, or <literal>-</literal> to prompt
|
---|
| 166 | you for the password.
|
---|
| 167 | </para>
|
---|
| 168 | <para>
|
---|
| 169 | Use the <option>--password-id</option> option to specify the
|
---|
| 170 | id the password is supplied for.
|
---|
| 171 | </para>
|
---|
| 172 | </refsect2>
|
---|
| 173 | <refsect2 id="vboxmanage-encryptvm-removepassword">
|
---|
| 174 | <title>Remove password used for decrypting the Virtual Machine</title>
|
---|
| 175 | <remark role="help-copy-synopsis"/>
|
---|
| 176 | <para>
|
---|
| 177 | The <command>VBoxManage encryptvm
|
---|
| 178 | <replaceable>vmname</replaceable> removepassword</command> command
|
---|
| 179 | removes a password used for decrypting the VM.
|
---|
| 180 | </para>
|
---|
| 181 | <para>
|
---|
| 182 | Specify the password identifier for removing. The password becomes
|
---|
| 183 | unknown and the VM can not be decrypted.
|
---|
| 184 | </para>
|
---|
| 185 | </refsect2>
|
---|
| 186 | </refsect1>
|
---|
| 187 |
|
---|
[99513] | 188 | <refsect1 id="vboxmanage-encryptvm-examples">
|
---|
[94660] | 189 | <title>Examples</title>
|
---|
| 190 | <remark role="help-scope" condition="GLOBAL" />
|
---|
| 191 | <para>
|
---|
| 192 | The following command encrypts the <filename>ol7</filename> VM using
|
---|
| 193 | AES-256 giving password via command prompt:
|
---|
| 194 | </para>
|
---|
| 195 | <screen>$ VBoxManage encryptvm ol7 setencryption --cipher=AES-256 --new-password - --new-password-id vmid</screen>
|
---|
| 196 | </refsect1>
|
---|
| 197 |
|
---|
[99513] | 198 | <refsect1 id="vboxmanage-encryptvm-see-also">
|
---|
[94660] | 199 | <title>See Also</title>
|
---|
| 200 | <para>
|
---|
| 201 | <xref linkend="vboxmanage-createvm" />,
|
---|
| 202 | </para>
|
---|
| 203 | </refsect1>
|
---|
| 204 | </refentry>
|
---|