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

<?xml version="1.0" encoding="UTF-8"?>
<!--
    manpage, user manual, usage: VBoxManage registervm
-->
<!--
    Copyright (C) 2006-2023 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: 2023-04-21 21:59:02 +0000 (Fri, 21 Apr 2023) $</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 id="vboxmanage-registervm-description">
    <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 id="vboxmanage-registervm-examples">
    <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 id="vboxmanage-registervm-see-also">
    <title>See Also</title>
    <para>
      <xref linkend="vboxmanage-createvm"/>,
      <xref linkend="vboxmanage-unregistervm" />
    </para>
  </refsect1>
</refentry>