blob: 68309bfca0f0fce5afb84a6a953c87fdd46792ad (
plain)
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
|
<?xml version="1.0" encoding="UTF-8"?>
<!--
manpage, user manual, usage: VBoxManage registervm
-->
<!--
Copyright (C) 2006-2022 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-registervm" lang="en">
<refentryinfo>
<pubdate>$Date: 2022-08-22 19:43:14 +0200 (Mon, 22 Aug 2022) $</pubdate>
<title>VBoxManage registervm</title>
</refentryinfo>
<refmeta>
<refentrytitle>VBoxManage-registervm</refentrytitle>
<manvolnum>1</manvolnum>
</refmeta>
<refnamediv>
<refname>VBoxManage-registervm</refname>
<refpurpose>register a virtual machine</refpurpose>
<refclass>&product-name;</refclass>
</refnamediv>
<refsynopsisdiv>
<cmdsynopsis id="synopsis-vboxmanage-registervm">
<!-- The 'id' is mandatory and must start with 'synopsis-'. -->
<command>VBoxManage registervm</command>
<arg choice="req"><replaceable>filename</replaceable></arg>
<arg choice="plain">--password <replaceable>file</replaceable></arg>
</cmdsynopsis>
</refsynopsisdiv>
<refsect1>
<title>Description</title>
<para>
The <command>VBoxManage registervm</command> command enables you
to create a virtual machine (VM) by importing an XML machine
configuration file into &product-name;. The VM cannot have the
same UUID as a VM that is already registered in &product-name;.
Ensure that the XML machine configuration file is in the machines
folder prior to registration.
</para>
<note>
<para>
When you use the <command>VBoxManage createvm</command> command
to create a VM, you can specify the <option>--register</option>
option to register the VM.
</para>
</note>
<variablelist>
<varlistentry>
<term><replaceable>filename</replaceable></term>
<listitem><para>
Specifies the XML machine configuration file. This file has
the <filename>.vbox</filename> file extension.
</para></listitem>
</varlistentry>
<varlistentry>
<term><option>--password</option></term>
<listitem>
<para>
Use the <option>--password</option> to supply the encryption
password of the VM. Either specify the absolute pathname of a
password file on the host operating system, or <literal>-</literal>
to prompt you for the password on the command line.
</para>
</listitem>
</varlistentry>
</variablelist>
</refsect1>
<refsect1>
<title>Examples</title>
<remark role="help-scope" condition="GLOBAL" />
<para>
The following command registers a VM called
<literal>vm2</literal>. The XML machine configuration file for the
VM is located in the default machines folder.
</para>
<screen>$ VBoxManage registervm "/home/user/VirtualBox VMs/vm2/vm2.vbox"</screen>
</refsect1>
<refsect1>
<title>See Also</title>
<para>
<xref linkend="vboxmanage-createvm"/>,
<xref linkend="vboxmanage-unregistervm" />
</para>
</refsect1>
</refentry>
|
