VirtualBox

Changeset 78144 in vbox for trunk/doc/manual/en_US


Ignore:
Timestamp:
Apr 16, 2019 2:14:48 PM (6 years ago)
Author:
vboxsync
Message:

manual/user_VBoxManage.xml: Use clonevm manpage.

File:
1 edited

Legend:

Unmodified
Added
Removed

  • trunk/doc/manual/en_US/user_VBoxManage.xml

    r77910 r78144  
    25922592
    25932593    </sect2>
    2594 
    2595   </sect1>
    2596 
    2597   <sect1 id="vboxmanage-clonevm">
    2598 
    2599     <title>VBoxManage clonevm</title>
    2600 
    2601     <para>
    2602       The <command>VBoxManage clonevm</command> command creates a clone
    2603       of an existing virtual machine (VM). The clone can be a full copy
    2604       of the VM or a linked copy of a VM.
    2605     </para>
    2606 
    2607 <screen>
    2608 VBoxManage clonevm <replaceable>vm</replaceable> [ --basefolder <replaceable>basefolder</replaceable> ]
    2609 [ --group <replaceable>group</replaceable>, ... ] [ --mode machine | machinechildren | all ]
    2610 [ --name <replaceable>name</replaceable> ] [ --options link | keepallmacs | keepnatmacs | keepdisknames | keephwuuids ]
    2611 [ --register ] [ --snapshot <replaceable>vm</replaceable> ] [ --uuid <replaceable>uuid</replaceable> ]
    2612 </screen>
    2613 
    2614     <para>
    2615       In addition to specifying the name of the VM to clone, which is
    2616       required, you can specify any of the following options:
    2617     </para>
    2618 
    2619     <itemizedlist>
    2620 
    2621       <listitem>
    2622         <para>
    2623           <option>--basefolder</option>
    2624           <replaceable>basefolder</replaceable> specifies the name of
    2625           the folder in which to save the configuration for the new VM.
    2626         </para>
    2627       </listitem>
    2628 
    2629       <listitem>
    2630         <para>
    2631           <option>--groups <replaceable>group</replaceable>,
    2632           ...</option> assigns the clone to the specified group or
    2633           groups. If you specify more than one group, separate each
    2634           group name with a comma.
    2635         </para>
    2636 
    2637         <para>
    2638           Note that each group is identified by a group ID that starts
    2639           with a slash character (<computeroutput>/</computeroutput>) so
    2640           that groups can be nested. By default, a clone is always
    2641           assigned membership to the <computeroutput>/</computeroutput>
    2642           group.
    2643         </para>
    2644       </listitem>
    2645 
    2646       <listitem>
    2647         <para>
    2648           <option>--mode machine|machineandchildren|all</option>
    2649           specifies which of the following cloning modes to use:
    2650         </para>
    2651 
    2652         <itemizedlist>
    2653 
    2654           <listitem>
    2655             <para>
    2656               <computeroutput>machine</computeroutput> mode clones the
    2657               current state of the existing VM without any snapshots.
    2658               This is the default mode.
    2659             </para>
    2660           </listitem>
    2661 
    2662           <listitem>
    2663             <para>
    2664               <computeroutput>machineandchildren</computeroutput> mode
    2665               clones the snapshot specified by by the
    2666               <option>--snapshot</option> option and all child
    2667               snapshots.
    2668             </para>
    2669           </listitem>
    2670 
    2671           <listitem>
    2672             <para>
    2673               <computeroutput>all</computeroutput> mode clones all
    2674               snapshots and the current state of the existing VM.
    2675             </para>
    2676           </listitem>
    2677 
    2678         </itemizedlist>
    2679       </listitem>
    2680 
    2681       <listitem>
    2682         <para>
    2683           <option>--name <replaceable>name</replaceable></option>
    2684           specifies a new name for the new VM. The default value is
    2685           "<replaceable>name</replaceable> Clone", where
    2686           <replaceable>name</replaceable> is the original name of the
    2687           VM.
    2688         </para>
    2689       </listitem>
    2690 
    2691       <listitem>
    2692         <para>
    2693           <option>--options</option> specifies how to create a new
    2694           clone.
    2695         </para>
    2696 
    2697         <itemizedlist>
    2698 
    2699           <listitem>
    2700             <para>
    2701               <option>--options link</option> creates a linked clone,
    2702               which can be cloned only from a snapshot.
    2703             </para>
    2704           </listitem>
    2705 
    2706           <listitem>
    2707             <para>
    2708               <option>--options keepallmacs</option> specifies that the
    2709               new clone reuses the MAC addresses of each virtual network
    2710               card from the existing VM.
    2711             </para>
    2712 
    2713             <para>
    2714               If you do not specify this option or the <option>--options
    2715               keepnatmacs</option> option, the default behavior is to
    2716               reinitialize the MAC addresses of each virtual network
    2717               card.
    2718             </para>
    2719           </listitem>
    2720 
    2721           <listitem>
    2722             <para>
    2723               <option>--options keepnatmacs</option> specifies that the
    2724               new clone reuses the MAC addresses of each virtual network
    2725               card from the existing VM when the network type is NAT.
    2726             </para>
    2727 
    2728             <para>
    2729               If you do not specify this option or the <option>--options
    2730               keepallmacs</option> option, the default behavior is to
    2731               reinitialize the MAC addresses of each virtual network
    2732               card.
    2733             </para>
    2734           </listitem>
    2735 
    2736           <listitem>
    2737             <para>
    2738               <option>--option keepdisknames</option> specifies that the
    2739               new clone reuses the disk image names from the existing
    2740               VM. By default, disk images are renamed. You can preserve
    2741               source hardware IDs by adding
    2742               <computeroutput>keephwuuids</computeroutput>.
    2743             </para>
    2744           </listitem>
    2745 
    2746           <listitem>
    2747             <para>
    2748               <option>--option keephwuuids</option> specifies that the
    2749               new clone reuses the hardware IDs from the existing VM. By
    2750               default, new UUIDs are used.
    2751             </para>
    2752           </listitem>
    2753 
    2754         </itemizedlist>
    2755       </listitem>
    2756 
    2757       <listitem>
    2758         <para>
    2759           <option>--register</option> automatically registers the new
    2760           clone in this &product-name; installation. You can manually
    2761           register the new VM later by using the <command>VBoxManage
    2762           registervm</command> command. See
    2763           <xref linkend="vboxmanage-registervm" />.
    2764         </para>
    2765       </listitem>
    2766 
    2767       <listitem>
    2768         <para>
    2769           <option>--snapshot <replaceable>vm</replaceable></option>
    2770           specifies the snapshot on which to base the new VM. By
    2771           default, the clone is created from the current state of the
    2772           specified VM.
    2773         </para>
    2774       </listitem>
    2775 
    2776       <listitem>
    2777         <para>
    2778           <option>--uuid <replaceable>uuid</replaceable></option>
    2779           specifies the UUID for the new VM. Ensure that this ID is
    2780           unique for the &product-name; instance if you decide to
    2781           register this new VM. By default, &product-name; provides a
    2782           new UUID.
    2783         </para>
    2784       </listitem>
    2785 
    2786     </itemizedlist>
    27872594
    27882595  </sect1>
    … …  
    91918998  </sect1>
    91928999
    9193   <xi:include href="user_man_VBoxManage-mediumio.xml"   xpointer="element(/1)" xmlns:xi="http://www.w3.org/2001/XInclude" />
    9194 
    9195   <xi:include href="user_man_VBoxManage-debugvm.xml"    xpointer="element(/1)" xmlns:xi="http://www.w3.org/2001/XInclude" />
    9196 
    9197   <xi:include href="user_man_VBoxManage-extpack.xml"    xpointer="element(/1)" xmlns:xi="http://www.w3.org/2001/XInclude" />
    9198 
    9199   <xi:include href="user_man_VBoxManage-unattended.xml" xpointer="element(/1)" xmlns:xi="http://www.w3.org/2001/XInclude" />
    9200 
    9201   <xi:include href="user_man_VBoxManage-snapshot.xml" xpointer="element(/1)" xmlns:xi="http://www.w3.org/2001/XInclude" />
    9202 
    9203   <xi:include href="user_man_VBoxManage-cloudprofile.xml" xpointer="element(/1)" xmlns:xi="http://www.w3.org/2001/XInclude" />
    9204 
    9205   <xi:include href="user_man_VBoxManage-cloudlist.xml" xpointer="element(/1)" xmlns:xi="http://www.w3.org/2001/XInclude" />
    9206 
     9000  <!-- TODO: Figure out how we can generate a file with the includes... The trouble is
     9001             that xpointer doesn't seem to allow including multiple elements.
     9002
     9003             In the mean time, when adding new VBoxManage man pages to Config.kmk,
     9004             don't forget to add it here too.
     9005   -->
     9006  <xi:include href="user_man_VBoxManage-unattended.xml"     xpointer="element(/1)" xmlns:xi="http://www.w3.org/2001/XInclude" />
     9007  <xi:include href="user_man_VBoxManage-snapshot.xml"       xpointer="element(/1)" xmlns:xi="http://www.w3.org/2001/XInclude" />
     9008  <xi:include href="user_man_VBoxManage-clonevm.xml"        xpointer="element(/1)" xmlns:xi="http://www.w3.org/2001/XInclude" />
     9009  <xi:include href="user_man_VBoxManage-extpack.xml"        xpointer="element(/1)" xmlns:xi="http://www.w3.org/2001/XInclude" />
     9010  <xi:include href="user_man_VBoxManage-cloudprofile.xml"   xpointer="element(/1)" xmlns:xi="http://www.w3.org/2001/XInclude" />
     9011  <xi:include href="user_man_VBoxManage-cloudlist.xml"      xpointer="element(/1)" xmlns:xi="http://www.w3.org/2001/XInclude" />
     9012  <xi:include href="user_man_VBoxManage-debugvm.xml"        xpointer="element(/1)" xmlns:xi="http://www.w3.org/2001/XInclude" />
    92079013</chapter>
Note: See TracChangeset for help on using the changeset viewer.

© 2024 Oracle Support Privacy / Do Not Sell My Info Terms of Use Trademark Policy Automated Access Etiquette