<?xml version="1.0" encoding="UTF-8"?>
<!--
    manpage, user manual, usage: VBoxManage
-->
<!--
    Copyright (C) 2006-2023 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-common" lang="en">
  <refentryinfo>
    <pubdate>$Date: 2023-01-17 15:15:46 +0100 (Tue, 17 Jan 2023) $</pubdate>
    <title>VBoxManage</title>
  </refentryinfo>

  <refmeta>
    <refentrytitle>VBoxManage</refentrytitle>
    <manvolnum>1</manvolnum>
  </refmeta>

  <refnamediv>
    <refname>VBoxManage</refname>
    <refpurpose>&product-name; интерфейс командной строки</refpurpose>
    <refclass>&product-name;</refclass>
  </refnamediv>

  <refsynopsisdiv>
    <cmdsynopsis id="synopsis-vboxmanage-common">
<!-- The 'id' is mandatory and must start with 'synopsis-'. -->
      <command>VBoxManage</command>
      <group>
        <arg choice="plain">-V</arg>
        <arg choice="plain">--version</arg>
      </group>
      <arg>--dump-build-type</arg>
      <group>
        <arg choice="plain">-q</arg>
        <arg choice="plain">--nologo</arg>
      </group>
      <arg>--settingspw=<replaceable>пароль</replaceable></arg>
      <arg>--settingspwfile=<replaceable>файл с паролем</replaceable></arg>
      <arg>@<replaceable>файл ответов</replaceable></arg>
      <arg><arg>help</arg> <replaceable>подкоманда</replaceable></arg>
    </cmdsynopsis>
  </refsynopsisdiv>

  <refsect1>
    <title>Описание</title>
    <para>
      Команда <command>VBoxManage</command> - это интерфейс командной
      строки (CLI) для ПО &product-name;. CLI поддерживает весь
      функционал, доступный из графического интерфейса &product-name;
      (GUI). В дополнении, можно использовать команду
      <command>VBoxManage</command> для управления функционалом
      ядра виртуализации, недоступного из GUI.
    </para>
    <para>
      Каждый раз, когда вы вызываете команду <command>VBoxManage</command>,
      исполняется только одна команда. Однако заметим, что некоторые
      подкоманды <command>VBoxManage</command> вызывают несколько
      подкоманд.
    </para>
    <para>
      Запустите команду <command>VBoxManage</command> из командной строки
      операционной системы (ОС) хоста для управления ПО &product-name;.
    </para>
    <para>
      Команда <command>VBoxManage</command> находится в следующих местах
      в зависимости от операционной системы хоста:
    </para>
    <itemizedlist>
      <listitem><para>
          <emphasis role="bold">Linux:</emphasis>
          <filename>/usr/bin/VBoxManage</filename>
        </para></listitem>
      <listitem><para>
          <emphasis role="bold">Mac OS X:</emphasis>
          <filename>/Applications/VirtualBox.app/Contents/MacOS/VBoxManage</filename>
        </para></listitem>
      <listitem><para>
          <emphasis role="bold">Oracle Solaris:</emphasis>
          <filename>/opt/VirtualBox/bin/VBoxManage</filename>
        </para></listitem>
      <listitem><para>
          <emphasis role="bold">Windows:</emphasis>
          <filename>C:\Program
          Files\Oracle\VirtualBox\VBoxManage.exe</filename>
        </para></listitem>
    </itemizedlist>
    <para>
      В дополнении к управлению виртуальными машинами (ВМ) через CLI или
      GUI, можно использовать <command>VBoxHeadless</command> CLI для
      управления ВМ напрямую.
    </para>
    <para>
      Команда <command>VBoxManage</command> производит специфические
      задачи через подкоманды, такие как <command>list</command>,
      <command>createvm</command> и <command>startvm</command>. Смотри
      соответствующую информацию по каждой подкоманде
      <command>VBoxManage</command>.
    </para>
    <para>
      Если нужно, ВМ может быть указана по ее имени или универсальному
      уникальному идентификатору (UUID).
    </para>
    <para>
      Команда <command>VBoxManage list vms</command> может быть
      использована для получения информации обо всех зарегистрированных
      на данный момент ВМ, включая их имена и UUID.
    </para>
    <para>
      Заметим, что имя ВМ должно быть заключено в кавычки если оно содержит
      пробелы.
    </para>
    <refsect2 id="vboxmanage-common-options">
      <title>Общие настройки</title>
      <variablelist>
        <varlistentry>
          <term><option>--nologo</option></term>
          <listitem><para>
              Подавляет вывод логотипа. Опция полезна для скриптов.
            </para><para>
              Краткая версия этой опции: <option>-q</option>.
            </para></listitem>
        </varlistentry>
        <varlistentry>
          <term><option>--settingspw=[<replaceable>пароль</replaceable>]</option></term>
          <listitem><para>
              Указывает пароль для доступа к настройкам. Опционально, можно
              указать сам пароль в качестве аргумента к опции. Если этого
              не будет сделано, команда <command>VBoxManage</command>
              спросит пароль у вас.
            </para><para>
              Пароль для доступа к настройкам - это функция безопасности,
              которая шифрует настройки. По умолчанию настройки сохраняются
              обычным текстом в открытом виде.
            </para><para>
              Вы не можете расшифровать зашифрованные настройки. Так что,
              если настройки зашифрованы, вы должны продолжать указывать
              <option>--settingspw</option> или
              <option>--settingspwfile</option>.
            </para><para>
              В настоящее время шифруется только пароль iSCSI.
            </para><remark>
              Данный дизайн не укладывается в Рекомендации по безопасности
              Oracle. Вы не должны указывать пароль в командной строке как
              аргумент, так как он может отображаться в списке процессов.
            </remark></listitem>
        </varlistentry>
        <varlistentry>
          <term><option>--settingspwfile=<replaceable>файл с паролем</replaceable></option></term>
          <listitem><para>
              Указывает файл, содержащий пароль к настройкам.
            </para></listitem>
        </varlistentry>
        <varlistentry>
          <term><option>--version</option></term>
          <listitem><para>
              Показывает информацию о версии команды
              <command>VBoxManage</command>.
            </para><para>
              Краткая версия это опции: <option>-V</option>.
            </para></listitem>
        </varlistentry>
        <varlistentry>
          <term>@<replaceable>файл ответов</replaceable></term>
          <listitem><para>
              Загружает аргументы из файла ответов в формате
              Bourne shell.
            </para></listitem>
        </varlistentry>
        <varlistentry>
          <term><replaceable>подкоманда</replaceable></term>
          <listitem><para>
              Указывает одну из подкоманд <command>VBoxManage</command>,
              такие как <command>controlvm</command>,
              <command>createvm</command>, <command>list</command>,
              <command>modifyvm</command>,
              <command>showvminfo</command>, <command>startvm</command>,
              <command>storageattach</command> и
              <command>storagectl</command>.
            </para><para>
              Каждая подкоманда описывается в своем топике, некоторые
              из них показаны в секции &apos;Смотрите также&apos;.
            </para></listitem>
        </varlistentry>
      </variablelist>
    </refsect2>
  </refsect1>

  <refsect1>
    <title>Примеры</title>
    <remark role="help-scope" condition="GLOBAL"/>
    <para>
      Следующая команда создает виртуальную машину с именем
      <literal>Win8</literal> и регистрирует ее в &product-name;,
      используя опцию <option>--register</option>.
    </para>
<screen>$ VBoxManage createvm --name "Win8" --register
Виртуальная машина 'Win8' создана и зарегистрирована.
UUID: <replaceable>строка UUID</replaceable>
Файл настроек: '/home/<replaceable>имя пользователя</replaceable>/VirtualBox VMs/Win8/Win8.vbox'</screen>
    <para>
      Вывод команды показывает, что ВМ <literal>Win8</literal>
      назначен UUID и XML файл настроек машины.
    </para>
    <para>
      Вы можете использовать команду <command>VBoxManage showvminfo</command>
      для просмотра информации о конфигурации ВМ.
    </para>
    <para>
      Следующий пример использует команду <command>VBoxManage
      modifyvm</command> для изменения размера памяти у ВМ
      <literal>Windows XP</literal> VM до 1024 мегабайта:
    </para>
<screen>$ VBoxManage modifyvm "Windows XP" --memory 1024</screen>
    <para>
      Заметим, что вы можете использовать команду <command>VBoxManage modifyvm</command>
      даже если ВМ выключена.
    </para>
    <para>
      Вы можете использовать команду <command>VBoxManage storagectl</command>
      или команду <command>VBoxManage storageattach</command> для
      изменения конфигурации носителей у ВМ. Например, чтобы создать
      SATA контроллер с именем <literal>sata01</literal> и добавить
      его в ВМ <literal>ol7</literal> VM используйте:
    </para>
<screen>$ VBoxManage storagectl ol7 --name "sata01" --add sata</screen>
    <para>
      Используйте команду <command>VBoxManage startvm</command> для старта
      ВМ, которая сейчас выключена. Например, чтобы запустить ВМ
      <literal>win7</literal> укажите:
    </para>
<screen>$ VBoxManage startvm win7</screen>
    <para>
      Используйте команду <command>VBoxManage controlvm</command>
      для приостановки или сохранения состояния ВМ, которая сейчас работает.
      Вы также можете использовать эту команду для изменения настроек
      ВМ. Например, чтобы включить аудио вход для ВМ <literal>ol6u9</literal>
      используйте:
    </para>
<screen>$ VBoxManage controlvm ol6u9 audioin on</screen>
  </refsect1>

  <refsect1>
    <title>Смотрите также</title>
    <para>
      <xref linkend="vboxmanage-controlvm" />,
      <xref linkend="vboxmanage-createvm" />,
      <xref linkend="vboxmanage-list" />,
      <xref linkend="vboxmanage-modifyvm" />,
      <xref linkend="vboxmanage-showvminfo" />,
      <xref linkend="vboxmanage-startvm" />,
      <xref linkend="vboxmanage-storageattach" />,
      <xref linkend="vboxmanage-storagectl" />
    </para>
  </refsect1>
</refentry>
