1 | <?xml version="1.0" encoding="UTF-8"?>
|
---|
2 | <!--
|
---|
3 | manpage, user manual, usage: VBoxManage storagectl
|
---|
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-storagectl" lang="en">
|
---|
32 | <refentryinfo>
|
---|
33 | <pubdate>$Date: 2023-04-21 21:59:02 +0000 (Fri, 21 Apr 2023) $</pubdate>
|
---|
34 | <title>VBoxManage storagectl</title>
|
---|
35 | </refentryinfo>
|
---|
36 |
|
---|
37 | <refmeta>
|
---|
38 | <refentrytitle>VBoxManage-storagectl</refentrytitle>
|
---|
39 | <manvolnum>1</manvolnum>
|
---|
40 | </refmeta>
|
---|
41 |
|
---|
42 | <refnamediv>
|
---|
43 | <refname>VBoxManage-storagectl</refname>
|
---|
44 | <refpurpose>manage a storage controller</refpurpose>
|
---|
45 | <refclass>&product-name;</refclass>
|
---|
46 | </refnamediv>
|
---|
47 |
|
---|
48 | <refsynopsisdiv>
|
---|
49 | <!-- The 'id' is mandatory and must start with 'synopsis-'. -->
|
---|
50 | <cmdsynopsis id="synopsis-vboxmanage-storagectl">
|
---|
51 | <command>VBoxManage storagectl</command>
|
---|
52 | <group choice="req">
|
---|
53 | <arg choice="plain"><replaceable>uuid</replaceable></arg>
|
---|
54 | <arg choice="plain"><replaceable>vmname</replaceable></arg>
|
---|
55 | </group>
|
---|
56 | <arg choice="req">--name=<replaceable>controller-name</replaceable></arg>
|
---|
57 | <arg>--add=<group choice="plain">
|
---|
58 | <arg choice="plain">floppy</arg>
|
---|
59 | <arg choice="plain">ide</arg>
|
---|
60 | <arg choice="plain">pcie</arg>
|
---|
61 | <arg choice="plain">sas</arg>
|
---|
62 | <arg choice="plain">sata</arg>
|
---|
63 | <arg choice="plain">scsi</arg>
|
---|
64 | <arg choice="plain">usb</arg>
|
---|
65 | </group></arg>
|
---|
66 | <arg>--controller=<group choice="plain">
|
---|
67 | <arg choice="plain">BusLogic</arg>
|
---|
68 | <arg choice="plain">I82078</arg>
|
---|
69 | <arg choice="plain">ICH6</arg>
|
---|
70 | <arg choice="plain">IntelAhci</arg>
|
---|
71 | <arg choice="plain">LSILogic</arg>
|
---|
72 | <arg choice="plain">LSILogicSAS</arg>
|
---|
73 | <arg choice="plain">NVMe</arg>
|
---|
74 | <arg choice="plain">PIIX3</arg>
|
---|
75 | <arg choice="plain">PIIX4</arg>
|
---|
76 | <arg choice="plain">USB</arg>
|
---|
77 | <arg choice="plain">VirtIO</arg>
|
---|
78 | </group></arg>
|
---|
79 | <arg>--bootable=<group choice="plain">
|
---|
80 | <arg choice="plain">on</arg>
|
---|
81 | <arg choice="plain">off</arg>
|
---|
82 | </group></arg>
|
---|
83 | <arg>--hostiocache=<group choice="plain">
|
---|
84 | <arg choice="plain">on</arg>
|
---|
85 | <arg choice="plain">off</arg>
|
---|
86 | </group></arg>
|
---|
87 | <arg>--portcount=<replaceable>count</replaceable></arg>
|
---|
88 | <arg>--remove</arg>
|
---|
89 | <arg>--rename=<replaceable>new-controller-name</replaceable></arg>
|
---|
90 | </cmdsynopsis>
|
---|
91 | </refsynopsisdiv>
|
---|
92 |
|
---|
93 | <refsect1 id="vboxmanage-storagectl-description">
|
---|
94 | <title>Description</title>
|
---|
95 | <para>
|
---|
96 | The <command>VBoxManage storagectl</command> command enables you
|
---|
97 | to attach, modify, and remove a storage controller. After you
|
---|
98 | configure the storage controller, you can use the
|
---|
99 | <command>VBoxManage storageattach</command> command to attach
|
---|
100 | virtual media to the controller.
|
---|
101 | </para>
|
---|
102 | <variablelist>
|
---|
103 | <varlistentry>
|
---|
104 | <term><option><replaceable>uuid</replaceable> | <replaceable>vmname</replaceable></option></term>
|
---|
105 | <listitem><para>
|
---|
106 | Specifies the Universally Unique Identifier (UUID) or name
|
---|
107 | of the virtual machine (VM).
|
---|
108 | </para></listitem>
|
---|
109 | </varlistentry>
|
---|
110 | <varlistentry>
|
---|
111 | <term><option>--name=<replaceable>controller-name</replaceable></option></term>
|
---|
112 | <listitem><para>
|
---|
113 | Specifies the name of the storage controller.
|
---|
114 | </para></listitem>
|
---|
115 | </varlistentry>
|
---|
116 | <varlistentry>
|
---|
117 | <term><option>--add=<replaceable>system-bus-type</replaceable></option></term>
|
---|
118 | <listitem><para>
|
---|
119 | Specifies the type of the system bus to which to connect the
|
---|
120 | storage controller. Valid values are
|
---|
121 | <literal>floppy</literal>, <literal>ide</literal>,
|
---|
122 | <literal>pcie</literal>, <literal>sas</literal>,
|
---|
123 | <literal>sata</literal>, <literal>scsi</literal>, and
|
---|
124 | <literal>usb</literal>.
|
---|
125 | </para></listitem>
|
---|
126 | </varlistentry>
|
---|
127 | <varlistentry>
|
---|
128 | <term><option>--controller=<replaceable>chipset-type</replaceable></option></term>
|
---|
129 | <listitem><para>
|
---|
130 | Specifies the chipset type to emulate for the specified
|
---|
131 | storage controller. Valid values are
|
---|
132 | <literal>BusLogic</literal>, <literal>I82078</literal>,
|
---|
133 | <literal>ICH6</literal>, <literal>IntelAHCI</literal>,
|
---|
134 | <literal>LSILogic</literal>, <literal>LSILogicSAS</literal>,
|
---|
135 | <literal>NVMe</literal>, <literal>PIIX3</literal>,
|
---|
136 | <literal>PIIX4</literal>, and <literal>USB</literal>.
|
---|
137 | </para><para>
|
---|
138 | The default value varies, according to the type of storage
|
---|
139 | controller.
|
---|
140 | </para></listitem>
|
---|
141 | </varlistentry>
|
---|
142 | <varlistentry>
|
---|
143 | <term><option>--portcount=<replaceable>count</replaceable></option></term>
|
---|
144 | <listitem><para>
|
---|
145 | Specifies the number of ports that the storage controller
|
---|
146 | supports. Valid values depend on the type of storage
|
---|
147 | controller.
|
---|
148 | </para></listitem>
|
---|
149 | </varlistentry>
|
---|
150 | <varlistentry>
|
---|
151 | <term><option>--hostiocache=on|off</option></term>
|
---|
152 | <listitem><para>
|
---|
153 | Specifies whether to use the host I/O cache for all disk
|
---|
154 | images attached to this storage controller. Valid values are
|
---|
155 | <literal>on</literal> and <literal>off</literal>. See
|
---|
156 | <xref linkend="iocaching" />.
|
---|
157 | </para></listitem>
|
---|
158 | </varlistentry>
|
---|
159 | <varlistentry>
|
---|
160 | <term><option>--bootable=on|off</option></term>
|
---|
161 | <listitem><para>
|
---|
162 | Specifies whether this controller is bootable. Valid values
|
---|
163 | are <literal>on</literal> and <literal>off</literal>.
|
---|
164 | </para></listitem>
|
---|
165 | </varlistentry>
|
---|
166 | <varlistentry>
|
---|
167 | <term><option>--rename=<replaceable>new-controller-name</replaceable></option></term>
|
---|
168 | <listitem><para>
|
---|
169 | Specifies a new name for the storage controller.
|
---|
170 | </para></listitem>
|
---|
171 | </varlistentry>
|
---|
172 | <varlistentry>
|
---|
173 | <term><option>--remove</option></term>
|
---|
174 | <listitem><para>
|
---|
175 | Removes a storage controller from the VM configuration.
|
---|
176 | </para></listitem>
|
---|
177 | </varlistentry>
|
---|
178 | </variablelist>
|
---|
179 | </refsect1>
|
---|
180 |
|
---|
181 | <refsect1 id="vboxmanage-storagectl-examples">
|
---|
182 | <title>Examples</title>
|
---|
183 | <remark role="help-scope" condition="GLOBAL" />
|
---|
184 | <para>
|
---|
185 | The following command creates a SATA storage controller called
|
---|
186 | <literal>sata01</literal> and adds it to the
|
---|
187 | <literal>ol7</literal> VM. The storage controller emulates the
|
---|
188 | IntelAHCI chipset.
|
---|
189 | </para>
|
---|
190 | <screen>$ VBoxManage storagectl ol7 --name "sata01" --add sata --controller IntelAHCI</screen>
|
---|
191 | <para>
|
---|
192 | The following command creates an IDE storage controller called
|
---|
193 | <literal>ide01</literal> and adds it to the <literal>ol7</literal>
|
---|
194 | VM.
|
---|
195 | </para>
|
---|
196 | <screen>$ VBoxManage storagectl ol7 --name "ide01" --add ide</screen>
|
---|
197 | </refsect1>
|
---|
198 |
|
---|
199 | <refsect1 id="vboxmanage-storagectl-see-also">
|
---|
200 | <title>See Also</title>
|
---|
201 | <para>
|
---|
202 | <xref linkend="vboxmanage-storageattach" />
|
---|
203 | </para>
|
---|
204 | </refsect1>
|
---|
205 | </refentry>
|
---|