VirtualBox

Changeset 94180 in vbox for trunk/doc/manual


Ignore:
Timestamp:
Mar 11, 2022 4:43:46 PM (3 years ago)
Author:
vboxsync
svn:sync-xref-src-repo-rev:
150436
Message:

doc/manual,FE/VBoxManage: Convert storagectl command to refentry documentation, bugref:9186 [remove old documentation, fix for r150435]

File:
1 edited

Legend:

Unmodified
Added
Removed

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

    r94179 r94180  
    927927  <xi:include href="user_man_VBoxManage-storagectl.xml"    xpointer="element(/1)" xmlns:xi="http://www.w3.org/2001/XInclude" />
    928928
    929   <sect1 id="vboxmanage-storagectl">
    930 
    931     <title>VBoxManage storagectl</title>
    932 
    933     <para>
    934       This command attaches, modifies, and removes a storage controller.
    935       After this, virtual media can be attached to the controller with
    936       the <command>storageattach</command> command.
    937     </para>
    938 
    939     <para>
    940       The syntax for this command is as follows:
    941     </para>
    942 
    943 <screen>VBoxManage storagectl       &lt;uuid|vmname&gt;
    944                             --name &lt;name&gt;
    945                             [--add ide|sata|scsi|floppy|sas|usb|pcie]
    946                             [--controller LSILogic|LSILogicSAS|BusLogic|
    947                                           IntelAhci|PIIX3|PIIX4|ICH6|I82078|
    948                                           USB|NVMe|VirtIO]
    949                             [--portcount &lt;1-30&gt;]
    950                             [--hostiocache on|off]
    951                             [--bootable on|off]
    952                             [--rename &lt;name&gt;]
    953                             [--remove]</screen>
    954 
    955     <para>
    956       The parameters are as follows:
    957     </para>
    958 
    959     <variablelist>
    960 
    961       <varlistentry>
    962         <term>
    963           <computeroutput>uuid|vmname</computeroutput>
    964         </term>
    965 
    966         <listitem>
    967           <para>
    968             The VM UUID or VM Name. Mandatory.
    969           </para>
    970         </listitem>
    971       </varlistentry>
    972 
    973       <varlistentry>
    974         <term>
    975           <computeroutput>--name</computeroutput>
    976         </term>
    977 
    978         <listitem>
    979           <para>
    980             Specifies the name of the storage controller. Mandatory.
    981           </para>
    982         </listitem>
    983       </varlistentry>
    984 
    985       <varlistentry>
    986         <term>
    987           <computeroutput>--add</computeroutput>
    988         </term>
    989 
    990         <listitem>
    991           <para>
    992             Specifies the type of the system bus to which the storage
    993             controller must be connected.
    994           </para>
    995         </listitem>
    996       </varlistentry>
    997 
    998       <varlistentry>
    999         <term>
    1000           <computeroutput>--controller</computeroutput>
    1001         </term>
    1002 
    1003         <listitem>
    1004           <para>
    1005             Enables a choice of chipset type being emulated for the
    1006             given storage controller.
    1007           </para>
    1008         </listitem>
    1009       </varlistentry>
    1010 
    1011       <varlistentry>
    1012         <term>
    1013           <computeroutput>--portcount</computeroutput>
    1014         </term>
    1015 
    1016         <listitem>
    1017           <para>
    1018             This specifies the number of ports the storage controller
    1019             should support.
    1020           </para>
    1021         </listitem>
    1022       </varlistentry>
    1023 
    1024       <varlistentry>
    1025         <term>
    1026           <computeroutput>--hostiocache</computeroutput>
    1027         </term>
    1028 
    1029         <listitem>
    1030           <para>
    1031             Configures the use of the host I/O cache for all disk images
    1032             attached to this storage controller. See
    1033             <xref
    1034             linkend="iocaching" />.
    1035           </para>
    1036         </listitem>
    1037       </varlistentry>
    1038 
    1039       <varlistentry>
    1040         <term>
    1041           <computeroutput>--bootable</computeroutput>
    1042         </term>
    1043 
    1044         <listitem>
    1045           <para>
    1046             Specifies whether this controller is bootable.
    1047           </para>
    1048         </listitem>
    1049       </varlistentry>
    1050 
    1051       <varlistentry>
    1052         <term>
    1053           <computeroutput>--rename</computeroutput>
    1054         </term>
    1055 
    1056         <listitem>
    1057           <para>
    1058             Specifies a new name for the storage controller.
    1059           </para>
    1060         </listitem>
    1061       </varlistentry>
    1062 
    1063       <varlistentry>
    1064         <term>
    1065           <computeroutput>--remove</computeroutput>
    1066         </term>
    1067 
    1068         <listitem>
    1069           <para>
    1070             Removes the storage controller from the VM configuration.
    1071           </para>
    1072         </listitem>
    1073       </varlistentry>
    1074 
    1075     </variablelist>
    1076 
    1077   </sect1>
    1078 
    1079929  <sect1 id="vboxmanage-bandwidthctl">
    1080930
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