diff options
Diffstat (limited to 'doc/manual/en_US/man_VBoxManage-storagectl.xml')
| -rw-r--r-- | doc/manual/en_US/man_VBoxManage-storagectl.xml | 205 |
1 files changed, 205 insertions, 0 deletions
diff --git a/doc/manual/en_US/man_VBoxManage-storagectl.xml b/doc/manual/en_US/man_VBoxManage-storagectl.xml new file mode 100644 index 00000000..3b18a824 --- /dev/null +++ b/doc/manual/en_US/man_VBoxManage-storagectl.xml @@ -0,0 +1,205 @@ +<?xml version="1.0" encoding="UTF-8"?> +<!-- + manpage, user manual, usage: VBoxManage storagectl +--> +<!-- + Copyright (C) 2006-2022 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-storagectl" lang="en"> + <refentryinfo> + <pubdate>$Date: 2022-08-22 19:43:14 +0200 (Mon, 22 Aug 2022) $</pubdate> + <title>VBoxManage storagectl</title> + </refentryinfo> + + <refmeta> + <refentrytitle>VBoxManage-storagectl</refentrytitle> + <manvolnum>1</manvolnum> + </refmeta> + + <refnamediv> + <refname>VBoxManage-storagectl</refname> + <refpurpose>manage a storage controller</refpurpose> + <refclass>&product-name;</refclass> + </refnamediv> + + <refsynopsisdiv> +<!-- The 'id' is mandatory and must start with 'synopsis-'. --> + <cmdsynopsis id="synopsis-vboxmanage-storagectl"> + <command>VBoxManage storagectl</command> + <group choice="req"> + <arg choice="plain"><replaceable>uuid</replaceable></arg> + <arg choice="plain"><replaceable>vmname</replaceable></arg> + </group> + <arg choice="req">--name=<replaceable>controller-name</replaceable></arg> + <arg>--add=<group choice="plain"> + <arg choice="plain">floppy</arg> + <arg choice="plain">ide</arg> + <arg choice="plain">pcie</arg> + <arg choice="plain">sas</arg> + <arg choice="plain">sata</arg> + <arg choice="plain">scsi</arg> + <arg choice="plain">usb</arg> + </group></arg> + <arg>--controller=<group choice="plain"> + <arg choice="plain">BusLogic</arg> + <arg choice="plain">I82078</arg> + <arg choice="plain">ICH6</arg> + <arg choice="plain">IntelAhci</arg> + <arg choice="plain">LSILogic</arg> + <arg choice="plain">LSILogicSAS</arg> + <arg choice="plain">NVMe</arg> + <arg choice="plain">PIIX3</arg> + <arg choice="plain">PIIX4</arg> + <arg choice="plain">USB</arg> + <arg choice="plain">VirtIO</arg> + </group></arg> + <arg>--bootable=<group choice="plain"> + <arg choice="plain">on</arg> + <arg choice="plain">off</arg> + </group></arg> + <arg>--hostiocache=<group choice="plain"> + <arg choice="plain">on</arg> + <arg choice="plain">off</arg> + </group></arg> + <arg>--portcount=<replaceable>count</replaceable></arg> + <arg>--remove</arg> + <arg>--rename=<replaceable>new-controller-name</replaceable></arg> + </cmdsynopsis> + </refsynopsisdiv> + + <refsect1> + <title>Description</title> + <para> + The <command>VBoxManage storagectl</command> command enables you + to attach, modify, and remove a storage controller. After you + configure the storage controller, you can use the + <command>VBoxManage storageattach</command> command to attach + virtual media to the controller. + </para> + <variablelist> + <varlistentry> + <term><replaceable>uuid</replaceable> | <replaceable>vmname</replaceable></term> + <listitem><para> + Specifies the Universally Unique Identifier (UUID) or name + of the virtual machine (VM). + </para></listitem> + </varlistentry> + <varlistentry> + <term><option>--name=<replaceable>controller-name</replaceable></option></term> + <listitem><para> + Specifies the name of the storage controller. + </para></listitem> + </varlistentry> + <varlistentry> + <term><option>--add=<replaceable>system-bus-type</replaceable></option></term> + <listitem><para> + Specifies the type of the system bus to which to connect the + storage controller. Valid values are + <literal>floppy</literal>, <literal>ide</literal>, + <literal>pcie</literal>, <literal>sas</literal>, + <literal>sata</literal>, <literal>scsi</literal>, and + <literal>usb</literal>. + </para></listitem> + </varlistentry> + <varlistentry> + <term><option>--controller=<replaceable>chipset-type</replaceable></option></term> + <listitem><para> + Specifies the chipset type to emulate for the specified + storage controller. Valid values are + <literal>BusLogic</literal>, <literal>I82078</literal>, + <literal>ICH6</literal>, <literal>IntelAHCI</literal>, + <literal>LSILogic</literal>, <literal>LSILogicSAS</literal>, + <literal>NVMe</literal>, <literal>PIIX3</literal>, + <literal>PIIX4</literal>, and <literal>USB</literal>. + </para><para> + The default value varies, according to the type of storage + controller. + </para></listitem> + </varlistentry> + <varlistentry> + <term><option>--portcount=<replaceable>count</replaceable></option></term> + <listitem><para> + Specifies the number of ports that the storage controller + supports. Valid values depend on the type of storage + controller. + </para></listitem> + </varlistentry> + <varlistentry> + <term><option>--hostiocache=on|off</option></term> + <listitem><para> + Specifies whether to use the host I/O cache for all disk + images attached to this storage controller. Valid values are + <literal>on</literal> and <literal>off</literal>. See + <xref linkend="iocaching" />. + </para></listitem> + </varlistentry> + <varlistentry> + <term><option>--bootable=on|off</option></term> + <listitem><para> + Specifies whether this controller is bootable. Valid values + are <literal>on</literal> and <literal>off</literal>. + </para></listitem> + </varlistentry> + <varlistentry> + <term><option>--rename=<replaceable>new-controller-name</replaceable></option></term> + <listitem><para> + Specifies a new name for the storage controller. + </para></listitem> + </varlistentry> + <varlistentry> + <term><option>--remove</option></term> + <listitem><para> + Removes a storage controller from the VM configuration. + </para></listitem> + </varlistentry> + </variablelist> + </refsect1> + + <refsect1> + <title>Examples</title> + <remark role="help-scope" condition="GLOBAL" /> + <para> + The following command creates a SATA storage controller called + <literal>sata01</literal> and adds it to the + <literal>ol7</literal> VM. The storage controller emulates the + IntelAHCI chipset. + </para> +<screen>$ VBoxManage storagectl ol7 --name "sata01" --add sata --controller IntelAHCI</screen> + <para> + The following command creates an IDE storage controller called + <literal>ide01</literal> and adds it to the <literal>ol7</literal> + VM. + </para> +<screen>$ VBoxManage storagectl ol7 --name "ide01" --add ide</screen> + </refsect1> + + <refsect1> + <title>See Also</title> + <para> + <xref linkend="vboxmanage-storageattach" /> + </para> + </refsect1> +</refentry> |