VirtualBox

source: vbox/trunk/doc/manual/en_US/man_VBoxManage-registervm.xml@ 96300

Last change on this file since 96300 was 96300, checked in by vboxsync, 2 years ago

doc: comment fixing

  • Property svn:eol-style set to native
  • Property svn:keywords set to Author Date Id Revision
File size: 3.6 KB
Line 
1<?xml version="1.0" encoding="UTF-8"?>
2<!--
3 manpage, user manual, usage: VBoxManage registervm
4-->
5<!--
6 Copyright (C) 2006-2020 Oracle Corporation
7
8 This file is part of VirtualBox Open Source Edition (OSE), as
9 available from http://www.virtualbox.org. This file is free software;
10 you can redistribute it and/or modify it under the terms of the GNU
11 General Public License (GPL) as published by the Free Software
12 Foundation, in version 2 as it comes in the "COPYING" file of the
13 VirtualBox OSE distribution. VirtualBox OSE is distributed in the
14 hope that it will be useful, but WITHOUT ANY WARRANTY of any kind.
15-->
16<!DOCTYPE refentry PUBLIC "-//OASIS//DTD DocBook XML V4.5//EN"
17 "http://www.oasis-open.org/docbook/xml/4.5/docbookx.dtd"[
18<!ENTITY % all.entities SYSTEM "all-entities.ent">
19%all.entities;
20]>
21<refentry id="vboxmanage-registervm" lang="en">
22 <refentryinfo>
23 <pubdate>$Date: 2022-08-18 17:27:14 +0000 (Thu, 18 Aug 2022) $</pubdate>
24 <title>VBoxManage registervm</title>
25 </refentryinfo>
26
27 <refmeta>
28 <refentrytitle>VBoxManage-registervm</refentrytitle>
29 <manvolnum>1</manvolnum>
30 </refmeta>
31
32 <refnamediv>
33 <refname>VBoxManage-registervm</refname>
34 <refpurpose>register a virtual machine</refpurpose>
35 <refclass>&product-name;</refclass>
36 </refnamediv>
37
38 <refsynopsisdiv>
39 <cmdsynopsis id="synopsis-vboxmanage-registervm">
40<!-- The 'id' is mandatory and must start with 'synopsis-'. -->
41 <command>VBoxManage registervm</command>
42 <arg choice="req"><replaceable>filename</replaceable></arg>
43 <arg choice="plain">--password <replaceable>file</replaceable></arg>
44 </cmdsynopsis>
45 </refsynopsisdiv>
46
47 <refsect1>
48 <title>Description</title>
49 <para>
50 The <command>VBoxManage registervm</command> command enables you
51 to create a virtual machine (VM) by importing an XML machine
52 configuration file into &product-name;. The VM cannot have the
53 same UUID as a VM that is already registered in &product-name;.
54 Ensure that the XML machine configuration file is in the machines
55 folder prior to registration.
56 </para>
57 <note>
58 <para>
59 When you use the <command>VBoxManage createvm</command> command
60 to create a VM, you can specify the <option>--register</option>
61 option to register the VM.
62 </para>
63 </note>
64 <variablelist>
65 <varlistentry>
66 <term><replaceable>filename</replaceable></term>
67 <listitem><para>
68 Specifies the XML machine configuration file. This file has
69 the <filename>.vbox</filename> file extension.
70 </para></listitem>
71 </varlistentry>
72 <varlistentry>
73 <term><option>--password</option></term>
74 <listitem>
75 <para>
76 Use the <option>--password</option> to supply the encryption
77 password of the VM. Either specify the absolute pathname of a
78 password file on the host operating system, or <literal>-</literal>
79 to prompt you for the password on the command line.
80 </para>
81 </listitem>
82 </varlistentry>
83 </variablelist>
84 </refsect1>
85
86 <refsect1>
87 <title>Examples</title>
88 <remark role="help-scope" condition="GLOBAL" />
89 <para>
90 The following command registers a VM called
91 <literal>vm2</literal>. The XML machine configuration file for the
92 VM is located in the default machines folder.
93 </para>
94<screen>$ VBoxManage registervm "/home/user/VirtualBox VMs/vm2/vm2.vbox"</screen>
95 </refsect1>
96
97 <refsect1>
98 <title>See Also</title>
99 <para>
100 <xref linkend="vboxmanage-createvm"/>,
101 <xref linkend="vboxmanage-unregistervm" />
102 </para>
103 </refsect1>
104</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