| 1 | <?xml version="1.0" encoding="UTF-8"?>
|
|---|
| 2 | <!--
|
|---|
| 3 | manpage, user manual, usage: VBoxManage
|
|---|
| 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-common" lang="en">
|
|---|
| 32 | <refentryinfo>
|
|---|
| 33 | <pubdate>$Date: 2024-02-29 20:47:25 +0000 (Thu, 29 Feb 2024) $</pubdate>
|
|---|
| 34 | <title>VBoxManage</title>
|
|---|
| 35 | </refentryinfo>
|
|---|
| 36 |
|
|---|
| 37 | <refmeta>
|
|---|
| 38 | <refentrytitle>VBoxManage</refentrytitle>
|
|---|
| 39 | <manvolnum>1</manvolnum>
|
|---|
| 40 | </refmeta>
|
|---|
| 41 |
|
|---|
| 42 | <refnamediv>
|
|---|
| 43 | <refname>VBoxManage</refname>
|
|---|
| 44 | <refpurpose>&product-name; интерфейс командной строки</refpurpose>
|
|---|
| 45 | <refclass>&product-name;</refclass>
|
|---|
| 46 | </refnamediv>
|
|---|
| 47 |
|
|---|
| 48 | <refsynopsisdiv>
|
|---|
| 49 | <cmdsynopsis id="synopsis-vboxmanage-common">
|
|---|
| 50 | <!-- The 'id' is mandatory and must start with 'synopsis-'. -->
|
|---|
| 51 | <command>VBoxManage</command>
|
|---|
| 52 | <group>
|
|---|
| 53 | <arg choice="plain">-V</arg>
|
|---|
| 54 | <arg choice="plain">--version</arg>
|
|---|
| 55 | </group>
|
|---|
| 56 | <arg>--dump-build-type</arg>
|
|---|
| 57 | <group>
|
|---|
| 58 | <arg choice="plain">-q</arg>
|
|---|
| 59 | <arg choice="plain">--nologo</arg>
|
|---|
| 60 | </group>
|
|---|
| 61 | <arg>--settingspw=<replaceable>пароль</replaceable></arg>
|
|---|
| 62 | <arg>--settingspwfile=<replaceable>файл с паролем</replaceable></arg>
|
|---|
| 63 | <arg>@<replaceable>файл ответов</replaceable></arg>
|
|---|
| 64 | <arg><arg>help</arg> <replaceable>подкоманда</replaceable></arg>
|
|---|
| 65 | </cmdsynopsis>
|
|---|
| 66 | </refsynopsisdiv>
|
|---|
| 67 |
|
|---|
| 68 | <refsect1 id="vboxmanage-common-description">
|
|---|
| 69 | <title>Описание</title>
|
|---|
| 70 | <para>
|
|---|
| 71 | Команда <command>VBoxManage</command> - это интерфейс командной
|
|---|
| 72 | строки (CLI) для ПО &product-name;. CLI поддерживает весь
|
|---|
| 73 | функционал, доступный из графического интерфейса &product-name;
|
|---|
| 74 | (GUI). В дополнении, можно использовать команду
|
|---|
| 75 | <command>VBoxManage</command> для управления функционалом
|
|---|
| 76 | ядра виртуализации, недоступного из GUI.
|
|---|
| 77 | </para>
|
|---|
| 78 | <para>
|
|---|
| 79 | Каждый раз, когда вы вызываете команду <command>VBoxManage</command>,
|
|---|
| 80 | исполняется только одна команда. Однако заметим, что некоторые
|
|---|
| 81 | подкоманды <command>VBoxManage</command> вызывают несколько
|
|---|
| 82 | подкоманд.
|
|---|
| 83 | </para>
|
|---|
| 84 | <para>
|
|---|
| 85 | Запустите команду <command>VBoxManage</command> из командной строки
|
|---|
| 86 | операционной системы (ОС) хоста для управления ПО &product-name;.
|
|---|
| 87 | </para>
|
|---|
| 88 | <para>
|
|---|
| 89 | Команда <command>VBoxManage</command> находится в следующих местах
|
|---|
| 90 | в зависимости от операционной системы хоста:
|
|---|
| 91 | </para>
|
|---|
| 92 | <itemizedlist>
|
|---|
| 93 | <listitem><para>
|
|---|
| 94 | <emphasis role="bold">Linux:</emphasis>
|
|---|
| 95 | <filename>/usr/bin/VBoxManage</filename>
|
|---|
| 96 | </para></listitem>
|
|---|
| 97 | <listitem><para>
|
|---|
| 98 | <emphasis role="bold">Mac OS X:</emphasis>
|
|---|
| 99 | <filename>/Applications/VirtualBox.app/Contents/MacOS/VBoxManage</filename>
|
|---|
| 100 | </para></listitem>
|
|---|
| 101 | <listitem><para>
|
|---|
| 102 | <emphasis role="bold">Oracle Solaris:</emphasis>
|
|---|
| 103 | <filename>/opt/VirtualBox/bin/VBoxManage</filename>
|
|---|
| 104 | </para></listitem>
|
|---|
| 105 | <listitem><para>
|
|---|
| 106 | <emphasis role="bold">Windows:</emphasis>
|
|---|
| 107 | <filename>C:\Program
|
|---|
| 108 | Files\Oracle\VirtualBox\VBoxManage.exe</filename>
|
|---|
| 109 | </para></listitem>
|
|---|
| 110 | </itemizedlist>
|
|---|
| 111 | <para>
|
|---|
| 112 | В дополнении к управлению виртуальными машинами (ВМ) через CLI или
|
|---|
| 113 | GUI, можно использовать <command>VBoxHeadless</command> CLI для
|
|---|
| 114 | управления ВМ напрямую.
|
|---|
| 115 | </para>
|
|---|
| 116 | <para>
|
|---|
| 117 | Команда <command>VBoxManage</command> производит специфические
|
|---|
| 118 | задачи через подкоманды, такие как <command>list</command>,
|
|---|
| 119 | <command>createvm</command> и <command>startvm</command>. Смотри
|
|---|
| 120 | соответствующую информацию по каждой подкоманде
|
|---|
| 121 | <command>VBoxManage</command>.
|
|---|
| 122 | </para>
|
|---|
| 123 | <para>
|
|---|
| 124 | Если нужно, ВМ может быть указана по ее имени или универсальному
|
|---|
| 125 | уникальному идентификатору (UUID).
|
|---|
| 126 | </para>
|
|---|
| 127 | <para>
|
|---|
| 128 | Команда <command>VBoxManage list vms</command> может быть
|
|---|
| 129 | использована для получения информации обо всех зарегистрированных
|
|---|
| 130 | на данный момент ВМ, включая их имена и UUID.
|
|---|
| 131 | </para>
|
|---|
| 132 | <para>
|
|---|
| 133 | Заметим, что имя ВМ должно быть заключено в кавычки если оно содержит
|
|---|
| 134 | пробелы.
|
|---|
| 135 | </para>
|
|---|
| 136 | <refsect2 id="vboxmanage-common-options">
|
|---|
| 137 | <title>Общие настройки</title>
|
|---|
| 138 | <variablelist>
|
|---|
| 139 | <varlistentry>
|
|---|
| 140 | <term><option>--nologo</option></term>
|
|---|
| 141 | <listitem><para>
|
|---|
| 142 | Подавляет вывод логотипа. Опция полезна для скриптов.
|
|---|
| 143 | </para><para>
|
|---|
| 144 | Краткая версия этой опции: <option>-q</option>.
|
|---|
| 145 | </para></listitem>
|
|---|
| 146 | </varlistentry>
|
|---|
| 147 | <varlistentry>
|
|---|
| 148 | <term><option>--settingspw=[<replaceable>пароль</replaceable>]</option></term>
|
|---|
| 149 | <listitem><para>
|
|---|
| 150 | Указывает пароль для доступа к настройкам. Опционально, можно
|
|---|
| 151 | указать сам пароль в качестве аргумента к опции. Если этого
|
|---|
| 152 | не будет сделано, команда <command>VBoxManage</command>
|
|---|
| 153 | спросит пароль у вас.
|
|---|
| 154 | </para><para>
|
|---|
| 155 | Пароль для доступа к настройкам - это функция безопасности,
|
|---|
| 156 | которая шифрует настройки. По умолчанию настройки сохраняются
|
|---|
| 157 | обычным текстом в открытом виде.
|
|---|
| 158 | </para><para>
|
|---|
| 159 | Вы не можете расшифровать зашифрованные настройки. Так что,
|
|---|
| 160 | если настройки зашифрованы, вы должны продолжать указывать
|
|---|
| 161 | <option>--settingspw</option> или
|
|---|
| 162 | <option>--settingspwfile</option>.
|
|---|
| 163 | </para><para>
|
|---|
| 164 | В настоящее время шифруется только пароль iSCSI.
|
|---|
| 165 | </para><remark>
|
|---|
| 166 | Данный дизайн не укладывается в Рекомендации по безопасности
|
|---|
| 167 | Oracle. Вы не должны указывать пароль в командной строке как
|
|---|
| 168 | аргумент, так как он может отображаться в списке процессов.
|
|---|
| 169 | </remark></listitem>
|
|---|
| 170 | </varlistentry>
|
|---|
| 171 | <varlistentry>
|
|---|
| 172 | <term><option>--settingspwfile=<replaceable>файл с паролем</replaceable></option></term>
|
|---|
| 173 | <listitem><para>
|
|---|
| 174 | Указывает файл, содержащий пароль к настройкам.
|
|---|
| 175 | </para></listitem>
|
|---|
| 176 | </varlistentry>
|
|---|
| 177 | <varlistentry>
|
|---|
| 178 | <term><option>--version</option></term>
|
|---|
| 179 | <listitem><para>
|
|---|
| 180 | Показывает информацию о версии команды
|
|---|
| 181 | <command>VBoxManage</command>.
|
|---|
| 182 | </para><para>
|
|---|
| 183 | Краткая версия это опции: <option>-V</option>.
|
|---|
| 184 | </para></listitem>
|
|---|
| 185 | </varlistentry>
|
|---|
| 186 | <varlistentry>
|
|---|
| 187 | <term>@<replaceable>файл ответов</replaceable></term>
|
|---|
| 188 | <listitem><para>
|
|---|
| 189 | Загружает аргументы из файла ответов в формате
|
|---|
| 190 | Bourne shell.
|
|---|
| 191 | </para></listitem>
|
|---|
| 192 | </varlistentry>
|
|---|
| 193 | <varlistentry>
|
|---|
| 194 | <term><replaceable>подкоманда</replaceable></term>
|
|---|
| 195 | <listitem><para>
|
|---|
| 196 | Указывает одну из подкоманд <command>VBoxManage</command>,
|
|---|
| 197 | такие как <command>controlvm</command>,
|
|---|
| 198 | <command>createvm</command>, <command>list</command>,
|
|---|
| 199 | <command>modifyvm</command>,
|
|---|
| 200 | <command>showvminfo</command>, <command>startvm</command>,
|
|---|
| 201 | <command>storageattach</command> и
|
|---|
| 202 | <command>storagectl</command>.
|
|---|
| 203 | </para><para>
|
|---|
| 204 | Каждая подкоманда описывается в своем топике, некоторые
|
|---|
| 205 | из них показаны в секции 'Смотрите также'.
|
|---|
| 206 | </para></listitem>
|
|---|
| 207 | </varlistentry>
|
|---|
| 208 | </variablelist>
|
|---|
| 209 | </refsect2>
|
|---|
| 210 | </refsect1>
|
|---|
| 211 |
|
|---|
| 212 | <refsect1 id="vboxmanage-common-examples">
|
|---|
| 213 | <title>Примеры</title>
|
|---|
| 214 | <remark role="help-scope" condition="GLOBAL"/>
|
|---|
| 215 | <para>
|
|---|
| 216 | Следующая команда создает виртуальную машину с именем
|
|---|
| 217 | <literal>Win8</literal> и регистрирует ее в &product-name;,
|
|---|
| 218 | используя опцию <option>--register</option>.
|
|---|
| 219 | </para>
|
|---|
| 220 | <screen>$ VBoxManage createvm --name "Win8" --register
|
|---|
| 221 | Виртуальная машина 'Win8' создана и зарегистрирована.
|
|---|
| 222 | UUID: <replaceable>строка UUID</replaceable>
|
|---|
| 223 | Файл настроек: '/home/<replaceable>имя пользователя</replaceable>/VirtualBox VMs/Win8/Win8.vbox'</screen>
|
|---|
| 224 | <para>
|
|---|
| 225 | Вывод команды показывает, что ВМ <literal>Win8</literal>
|
|---|
| 226 | назначен UUID и XML файл настроек машины.
|
|---|
| 227 | </para>
|
|---|
| 228 | <para>
|
|---|
| 229 | Вы можете использовать команду <command>VBoxManage showvminfo</command>
|
|---|
| 230 | для просмотра информации о конфигурации ВМ.
|
|---|
| 231 | </para>
|
|---|
| 232 | <para>
|
|---|
| 233 | Следующий пример использует команду <command>VBoxManage
|
|---|
| 234 | modifyvm</command> для изменения размера памяти у ВМ
|
|---|
| 235 | <literal>Windows XP</literal> VM до 1024 мегабайта:
|
|---|
| 236 | </para>
|
|---|
| 237 | <screen>$ VBoxManage modifyvm "Windows XP" --memory 1024</screen>
|
|---|
| 238 | <para>
|
|---|
| 239 | Заметим, что вы можете использовать команду <command>VBoxManage modifyvm</command>
|
|---|
| 240 | даже если ВМ выключена.
|
|---|
| 241 | </para>
|
|---|
| 242 | <para>
|
|---|
| 243 | Вы можете использовать команду <command>VBoxManage storagectl</command>
|
|---|
| 244 | или команду <command>VBoxManage storageattach</command> для
|
|---|
| 245 | изменения конфигурации носителей у ВМ. Например, чтобы создать
|
|---|
| 246 | SATA контроллер с именем <literal>sata01</literal> и добавить
|
|---|
| 247 | его в ВМ <literal>ol7</literal> VM используйте:
|
|---|
| 248 | </para>
|
|---|
| 249 | <screen>$ VBoxManage storagectl ol7 --name "sata01" --add sata</screen>
|
|---|
| 250 | <para>
|
|---|
| 251 | Используйте команду <command>VBoxManage startvm</command> для старта
|
|---|
| 252 | ВМ, которая сейчас выключена. Например, чтобы запустить ВМ
|
|---|
| 253 | <literal>win7</literal> укажите:
|
|---|
| 254 | </para>
|
|---|
| 255 | <screen>$ VBoxManage startvm win7</screen>
|
|---|
| 256 | <para>
|
|---|
| 257 | Используйте команду <command>VBoxManage controlvm</command>
|
|---|
| 258 | для приостановки или сохранения состояния ВМ, которая сейчас работает.
|
|---|
| 259 | Вы также можете использовать эту команду для изменения настроек
|
|---|
| 260 | ВМ. Например, чтобы включить аудио вход для ВМ <literal>ol6u9</literal>
|
|---|
| 261 | используйте:
|
|---|
| 262 | </para>
|
|---|
| 263 | <screen>$ VBoxManage controlvm ol6u9 audioin on</screen>
|
|---|
| 264 | </refsect1>
|
|---|
| 265 |
|
|---|
| 266 | <refsect1 id="vboxmanage-common-see-also">
|
|---|
| 267 | <title>Смотрите также</title>
|
|---|
| 268 | <para>
|
|---|
| 269 | <xref linkend="vboxmanage-controlvm" />,
|
|---|
| 270 | <xref linkend="vboxmanage-createvm" />,
|
|---|
| 271 | <xref linkend="vboxmanage-list" />,
|
|---|
| 272 | <xref linkend="vboxmanage-modifyvm" />,
|
|---|
| 273 | <xref linkend="vboxmanage-showvminfo" />,
|
|---|
| 274 | <xref linkend="vboxmanage-startvm" />,
|
|---|
| 275 | <xref linkend="vboxmanage-storageattach" />,
|
|---|
| 276 | <xref linkend="vboxmanage-storagectl" />
|
|---|
| 277 | </para>
|
|---|
| 278 | </refsect1>
|
|---|
| 279 | </refentry>
|
|---|
