VirtualBox

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