1 | <?xml version="1.0" encoding="UTF-8"?>
|
---|
2 | <!--
|
---|
3 | manpage, user manual, usage: VBoxManage registervm
|
---|
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-registervm" lang="en">
|
---|
32 | <refentryinfo>
|
---|
33 | <pubdate>$Date: 2023-04-21 21:59:02 +0000 (Fri, 21 Apr 2023) $</pubdate>
|
---|
34 | <title>VBoxManage registervm</title>
|
---|
35 | </refentryinfo>
|
---|
36 |
|
---|
37 | <refmeta>
|
---|
38 | <refentrytitle>VBoxManage-registervm</refentrytitle>
|
---|
39 | <manvolnum>1</manvolnum>
|
---|
40 | </refmeta>
|
---|
41 |
|
---|
42 | <refnamediv>
|
---|
43 | <refname>VBoxManage-registervm</refname>
|
---|
44 | <refpurpose>register a virtual machine</refpurpose>
|
---|
45 | <refclass>&product-name;</refclass>
|
---|
46 | </refnamediv>
|
---|
47 |
|
---|
48 | <refsynopsisdiv>
|
---|
49 | <cmdsynopsis id="synopsis-vboxmanage-registervm">
|
---|
50 | <!-- The 'id' is mandatory and must start with 'synopsis-'. -->
|
---|
51 | <command>VBoxManage registervm</command>
|
---|
52 | <arg choice="req"><replaceable>filename</replaceable></arg>
|
---|
53 | <arg choice="plain">--password <replaceable>file</replaceable></arg>
|
---|
54 | </cmdsynopsis>
|
---|
55 | </refsynopsisdiv>
|
---|
56 |
|
---|
57 | <refsect1 id="vboxmanage-registervm-description">
|
---|
58 | <title>Description</title>
|
---|
59 | <para>
|
---|
60 | The <command>VBoxManage registervm</command> command enables you
|
---|
61 | to create a virtual machine (VM) by importing an XML machine
|
---|
62 | configuration file into &product-name;. The VM cannot have the
|
---|
63 | same UUID as a VM that is already registered in &product-name;.
|
---|
64 | Ensure that the XML machine configuration file is in the machines
|
---|
65 | folder prior to registration.
|
---|
66 | </para>
|
---|
67 | <note>
|
---|
68 | <para>
|
---|
69 | When you use the <command>VBoxManage createvm</command> command
|
---|
70 | to create a VM, you can specify the <option>--register</option>
|
---|
71 | option to register the VM.
|
---|
72 | </para>
|
---|
73 | </note>
|
---|
74 | <variablelist>
|
---|
75 | <varlistentry>
|
---|
76 | <term><replaceable>filename</replaceable></term>
|
---|
77 | <listitem><para>
|
---|
78 | Specifies the XML machine configuration file. This file has
|
---|
79 | the <filename>.vbox</filename> file extension.
|
---|
80 | </para></listitem>
|
---|
81 | </varlistentry>
|
---|
82 | <varlistentry>
|
---|
83 | <term><option>--password</option></term>
|
---|
84 | <listitem>
|
---|
85 | <para>
|
---|
86 | Use the <option>--password</option> to supply the encryption
|
---|
87 | password of the VM. Either specify the absolute pathname of a
|
---|
88 | password file on the host operating system, or <literal>-</literal>
|
---|
89 | to prompt you for the password on the command line.
|
---|
90 | </para>
|
---|
91 | </listitem>
|
---|
92 | </varlistentry>
|
---|
93 | </variablelist>
|
---|
94 | </refsect1>
|
---|
95 |
|
---|
96 | <refsect1 id="vboxmanage-registervm-examples">
|
---|
97 | <title>Examples</title>
|
---|
98 | <remark role="help-scope" condition="GLOBAL" />
|
---|
99 | <para>
|
---|
100 | The following command registers a VM called
|
---|
101 | <literal>vm2</literal>. The XML machine configuration file for the
|
---|
102 | VM is located in the default machines folder.
|
---|
103 | </para>
|
---|
104 | <screen>$ VBoxManage registervm "/home/user/VirtualBox VMs/vm2/vm2.vbox"</screen>
|
---|
105 | </refsect1>
|
---|
106 |
|
---|
107 | <refsect1 id="vboxmanage-registervm-see-also">
|
---|
108 | <title>See Also</title>
|
---|
109 | <para>
|
---|
110 | <xref linkend="vboxmanage-createvm"/>,
|
---|
111 | <xref linkend="vboxmanage-unregistervm" />
|
---|
112 | </para>
|
---|
113 | </refsect1>
|
---|
114 | </refentry>
|
---|