1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
|
<?xml version="1.0" encoding="UTF-8"?>
<!--
manpage, user manual, usage: VBoxManage modifynvram
-->
<!--
Copyright (C) 2021-2024 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-modifynvram" lang="en">
<refentryinfo>
<pubdate>$Date: 2024-09-16 16:03:52 +0200 (Mon, 16 Sep 2024) $</pubdate>
<title>VBoxManage modifynvram</title>
</refentryinfo>
<refmeta>
<refentrytitle>VBoxManage-modifynvram</refentrytitle>
<manvolnum>1</manvolnum>
</refmeta>
<refnamediv>
<refname>VBoxManage-modifynvram</refname>
<refpurpose>List and modify the NVRAM content of a virtual machine</refpurpose>
<refclass>&product-name;</refclass>
</refnamediv>
<refsynopsisdiv>
<cmdsynopsis id="synopsis-vboxmanage-modifynvram-inituefivarstore">
<command>VBoxManage modifynvram</command>
<group choice="req">
<arg choice="plain"><replaceable>uuid</replaceable></arg>
<arg choice="plain"><replaceable>vmname</replaceable></arg>
</group>
<arg choice="plain">inituefivarstore</arg>
</cmdsynopsis>
<cmdsynopsis id="synopsis-vboxmanage-modifynvram-enrollmssignatures">
<command>VBoxManage modifynvram</command>
<group choice="req">
<arg choice="plain"><replaceable>uuid</replaceable></arg>
<arg choice="plain"><replaceable>vmname</replaceable></arg>
</group>
<arg choice="plain">enrollmssignatures</arg>
</cmdsynopsis>
<cmdsynopsis id="synopsis-vboxmanage-modifynvram-enrollorclpk">
<command>VBoxManage modifynvram</command>
<group choice="req">
<arg choice="plain"><replaceable>uuid</replaceable></arg>
<arg choice="plain"><replaceable>vmname</replaceable></arg>
</group>
<arg choice="plain">enrollorclpk</arg>
</cmdsynopsis>
<cmdsynopsis id="synopsis-vboxmanage-modifynvram-enrollpk">
<command>VBoxManage modifynvram</command>
<group choice="req">
<arg choice="plain"><replaceable>uuid</replaceable></arg>
<arg choice="plain"><replaceable>vmname</replaceable></arg>
</group>
<arg choice="plain">enrollpk</arg>
<arg>--platform-key=<replaceable>filename</replaceable></arg>
<arg>--owner-uuid=<replaceable>uuid</replaceable></arg>
</cmdsynopsis>
<cmdsynopsis id="synopsis-vboxmanage-modifynvram-enrollmok">
<command>VBoxManage modifynvram</command>
<group choice="req">
<arg choice="plain"><replaceable>uuid</replaceable></arg>
<arg choice="plain"><replaceable>vmname</replaceable></arg>
</group>
<arg choice="plain">enrollmok</arg>
<arg>--mok=<replaceable>filename</replaceable></arg>
<arg>--owner-uuid=<replaceable>uuid</replaceable></arg>
</cmdsynopsis>
<cmdsynopsis id="synopsis-vboxmanage-modifynvram-secureboot">
<command>VBoxManage modifynvram</command>
<group choice="req">
<arg choice="plain"><replaceable>uuid</replaceable></arg>
<arg choice="plain"><replaceable>vmname</replaceable></arg>
</group>
<arg choice="plain">secureboot</arg>
<group choice="req">
<arg choice="plain">--enable</arg>
<arg choice="plain">--disable</arg>
</group>
</cmdsynopsis>
<cmdsynopsis id="synopsis-vboxmanage-modifynvram-listvars">
<command>VBoxManage modifynvram</command>
<group choice="req">
<arg choice="plain"><replaceable>uuid</replaceable></arg>
<arg choice="plain"><replaceable>vmname</replaceable></arg>
</group>
<arg choice="plain">listvars</arg>
</cmdsynopsis>
<cmdsynopsis id="synopsis-vboxmanage-modifynvram-queryvar">
<command>VBoxManage modifynvram</command>
<group choice="req">
<arg choice="plain"><replaceable>uuid</replaceable></arg>
<arg choice="plain"><replaceable>vmname</replaceable></arg>
</group>
<arg choice="plain">queryvar</arg>
<arg>--name=<replaceable>name</replaceable></arg>
<arg>--filename=<replaceable>filename</replaceable></arg>
</cmdsynopsis>
<cmdsynopsis id="synopsis-vboxmanage-modifynvram-deletevar">
<command>VBoxManage modifynvram</command>
<group choice="req">
<arg choice="plain"><replaceable>uuid</replaceable></arg>
<arg choice="plain"><replaceable>vmname</replaceable></arg>
</group>
<arg choice="plain">deletevar</arg>
<arg>--name=<replaceable>name</replaceable></arg>
<arg>--owner-uuid=<replaceable>uuid</replaceable></arg>
</cmdsynopsis>
<cmdsynopsis id="synopsis-vboxmanage-modifynvram-changevar">
<command>VBoxManage modifynvram</command>
<group choice="req">
<arg choice="plain"><replaceable>uuid</replaceable></arg>
<arg choice="plain"><replaceable>vmname</replaceable></arg>
</group>
<arg choice="plain">changevar</arg>
<arg>--name=<replaceable>name</replaceable></arg>
<arg>--filename=<replaceable>filename</replaceable></arg>
</cmdsynopsis>
</refsynopsisdiv>
<refsect1 id="vboxmanage-modifynvram-description">
<title>Description</title>
<para>The "modifynvram" commands are for experts who want to inspect and modify the
UEFI variable store of a virtual machine. Any mistakes made here can result in
a non-bootable virtual machine.</para>
<refsect2 id="vboxmanage-modifynvram-common-options">
<title>Common options</title>
<remark role="help-scope" condition="GLOBAL"/>
<para>The subcommands of <command>modifynvram</command> all operate on a running virtual
machine:</para>
<variablelist>
<varlistentry>
<term><option><replaceable>uuid</replaceable> | <replaceable>vmname</replaceable></option></term>
<listitem><para>Either the UUID or the name (case sensitive) of a VM.</para></listitem>
</varlistentry>
</variablelist>
</refsect2>
<refsect2 id="vboxmanage-modifynvram-inituefivarstore">
<title>modifynvram inituefivarstore</title>
<remark role="help-copy-synopsis"/>
<para>
Initalizes the UEFI variable store to a default state. Any previous existing variable
store is deleted. Use with extreme caution!
</para>
</refsect2>
<refsect2 id="vboxmanage-modifynvram-enrollmssignatures">
<title>modifynvram enrollmssignatures</title>
<remark role="help-copy-synopsis"/>
<para>
Enrolls the default Microsoft KEK and DB signatures required for UEFI secure boot.
</para>
</refsect2>
<refsect2 id="vboxmanage-modifynvram-enrollorclpk">
<title>modifynvram enrollorclpk</title>
<remark role="help-copy-synopsis"/>
<para>
Enrolls the default platform key provided by Oracle required for UEFI secure boot.
</para>
</refsect2>
<refsect2 id="vboxmanage-modifynvram-enrollpk">
<title>modifynvram enrollpk</title>
<remark role="help-copy-synopsis"/>
<para>
Enrolls a custom platform key provided by the user required for UEFI secure boot.
The following commands use openssl to generate a new platform key:
</para>
<screen>$ openssl req -new -x509 -newkey rsa:2048 -keyout PK.key -out PK.crt</screen>
<screen>$ openssl x509 -in PK.crt -out PK.cer -outform DER</screen>
<variablelist>
<varlistentry>
<term><option>--platform-key=<replaceable>filename</replaceable></option></term>
<listitem><para>The platform key provided as a DER encoded X.509 signature.</para>
</listitem>
</varlistentry>
<varlistentry>
<term><option>--owner-uuid=<replaceable>uuid</replaceable></option></term>
<listitem><para>The UUID identifying the owner of the platform key.</para>
</listitem>
</varlistentry>
</variablelist>
</refsect2>
<refsect2 id="vboxmanage-modifynvram-secureboot">
<title>modifynvram secureboot</title>
<remark role="help-copy-synopsis"/>
<para>
Enables or disables UEFI secure boot.
</para>
<variablelist>
<varlistentry>
<term><option>--enable</option></term>
<listitem><para>Enables UEFI secure boot if the state of the key
enrolment permits.</para>
</listitem>
</varlistentry>
<varlistentry>
<term><option>--disable</option></term>
<listitem><para>Disables UEFI secure boot.</para>
</listitem>
</varlistentry>
</variablelist>
</refsect2>
<refsect2 id="vboxmanage-modifynvram-listvars">
<title>modifynvram listvars</title>
<remark role="help-copy-synopsis"/>
<para>
Lists all UEFI variables in the virtual machine's store along with their owner UUID.
</para>
</refsect2>
<refsect2 id="vboxmanage-modifynvram-queryvar">
<title>modifynvram queryvar</title>
<remark role="help-copy-synopsis"/>
<para>
Queries the content of a given UEFI variable identified by its name.
</para>
<variablelist>
<varlistentry>
<term><option>--name=<replaceable>name</replaceable></option></term>
<listitem><para>UEFI variable name to query.</para>
</listitem>
</varlistentry>
<varlistentry>
<term><option>--filename=<replaceable>filename</replaceable></option></term>
<listitem>
<para>
Where to store the content of the variable upon success. This is optional,
if omitted the content will be dumped to the terminal as a hex dump.
</para>
</listitem>
</varlistentry>
</variablelist>
</refsect2>
<refsect2 id="vboxmanage-modifynvram-deletevar">
<title>modifynvram deletevar</title>
<remark role="help-copy-synopsis"/>
<para>
Deletes the given variable identified by its name and owner UUID.
</para>
<variablelist>
<varlistentry>
<term><option>--name=<replaceable>name</replaceable></option></term>
<listitem><para>UEFI variable name to delete.</para>
</listitem>
</varlistentry>
<varlistentry>
<term><option>--owner-uuid=<replaceable>uuid</replaceable></option></term>
<listitem><para>The UUID identifying the owner of the variable to delete.</para>
</listitem>
</varlistentry>
</variablelist>
</refsect2>
<refsect2 id="vboxmanage-modifynvram-changevar">
<title>modifynvram changevar</title>
<remark role="help-copy-synopsis"/>
<para>
Changes the UEFI variable content to the one form the given file.
</para>
<variablelist>
<varlistentry>
<term><option>--name=<replaceable>name</replaceable></option></term>
<listitem><para>UEFI variable name to change the data for.</para>
</listitem>
</varlistentry>
<varlistentry>
<term><option>--filename=<replaceable>filename</replaceable></option></term>
<listitem>
<para>The file to read the data from.</para>
</listitem>
</varlistentry>
</variablelist>
</refsect2>
</refsect1>
</refentry>
|
