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

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

  <refnamediv>
    <refname>VBoxManage-cloudinstance</refname>
    <refpurpose>Управление облачными экземплярами</refpurpose>
    <refclass>&product-name;</refclass>
  </refnamediv>

  <refsynopsisdiv>
     <cmdsynopsis id="synopsis-vboxmanage-cloudinstance-create" sepchar=" ">
      <command moreinfo="none">VBoxManage cloud</command>
      <arg choice="req">--provider=<replaceable>имя</replaceable></arg>
      <arg choice="req">--profile=<replaceable>имя</replaceable></arg>
      <arg choice="plain">instance</arg>
      <arg choice="plain">create</arg>
      <arg choice="req">--domain-name=<replaceable>имя</replaceable></arg>
      <group choice="req">
          <arg choice="req">--image-id=<replaceable>id</replaceable></arg>
          <arg choice="req">--boot-volume-id=<replaceable>id</replaceable></arg>
      </group>
      <arg choice="req">--display-name=<replaceable>имя</replaceable></arg>
      <arg choice="req">--shape=<replaceable>тип</replaceable></arg>
      <arg choice="req">--subnet=<replaceable>id</replaceable></arg>
      <arg>--boot-disk-size=<replaceable>размер в ГБ</replaceable></arg>
      <arg>--publicip=<replaceable>true/false</replaceable></arg>
      <arg>--privateip=<replaceable>IP адрес</replaceable></arg>
      <arg rep="repeat">--public-ssh-key=<replaceable>ключевая строка</replaceable></arg>
      <arg>--launch-mode=<replaceable>NATIVE/EMULATED/PARAVIRTUALIZED</replaceable></arg>
    </cmdsynopsis>
    <cmdsynopsis id="synopsis-vboxmanage-cloudinstance-info" sepchar=" ">
      <command moreinfo="none">VBoxManage cloud</command>
      <arg choice="req">--provider=<replaceable>имя</replaceable></arg>
      <arg choice="req">--profile=<replaceable>имя</replaceable></arg>
      <arg choice="plain">instance</arg>
      <arg choice="plain">info</arg>
      <arg choice="req">--id=<replaceable>уникальный id</replaceable></arg>
    </cmdsynopsis>
    <cmdsynopsis id="synopsis-vboxmanage-cloudinstance-terminate" sepchar=" ">
      <command moreinfo="none">VBoxManage cloud</command>
      <arg choice="req">--provider=<replaceable>имя</replaceable></arg>
      <arg choice="req">--profile=<replaceable>имя</replaceable></arg>
      <arg choice="plain">instance</arg>
      <arg choice="plain">terminate</arg>
      <arg choice="req">--id=<replaceable>уникальный id</replaceable></arg>
    </cmdsynopsis>
    <cmdsynopsis id="synopsis-vboxmanage-cloudinstance-start" sepchar=" ">
      <command moreinfo="none">VBoxManage cloud</command>
      <arg choice="req">--provider=<replaceable>имя</replaceable></arg>
      <arg choice="req">--profile=<replaceable>имя</replaceable></arg>
      <arg choice="plain">instance</arg>
      <arg choice="plain">start</arg>
      <arg choice="req">--id=<replaceable>уникальный id</replaceable></arg>
    </cmdsynopsis>
    <cmdsynopsis id="synopsis-vboxmanage-cloudinstance-pause" sepchar=" ">
      <command moreinfo="none">VBoxManage cloud</command>
      <arg choice="req">--provider=<replaceable>имя</replaceable></arg>
      <arg choice="req">--profile=<replaceable>имя</replaceable></arg>
      <arg choice="plain">instance</arg>
      <arg choice="plain">pause</arg>
      <arg choice="req">--id=<replaceable>уникальный id</replaceable></arg>
    </cmdsynopsis>
  </refsynopsisdiv>

  <refsect1>
    <title>Описание</title>

    <refsect2 id="vboxmanage-cloudinstance-common-options">
      <title>Общие параметры</title>
      <remark role="help-scope" condition="GLOBAL"/>
      <para>Подкоманды <command>cloudinstance</command> реализуют стандартные операции над облачными экземплярами, как то
        start/pause/show/terminate. Следующие общие параметры должны быть помещены между "cloud" и последующими подкомандами:</para>
      <variablelist>
        <varlistentry>
          <term>--provider=<replaceable>имя</replaceable></term>
          <listitem><para>Короткое имя облачного провайдера.</para></listitem>
        </varlistentry>
        <varlistentry>
          <term>--profile=<replaceable>имя</replaceable></term>
          <listitem><para>Имя облачного профиля. </para></listitem>
        </varlistentry>
      </variablelist>
    </refsect2>

    <refsect2 id="vboxmanage-cloudinstance-create">
      <title>cloud instance create</title>
      <remark role="help-copy-synopsis"/>
      <para>
        Создает новый экземпляр в облаке.
        Существует два стандартных способа создать экземпляр в облаке:
         1. Создать экземпляр из существующего пользовательского образа.
         2. Создать экземпляр из существующего загрузочного тома. Этот загрузочный том не должен быть подключен
            к какому-либо экземпляру.
        Для первого способа требуются параметры: image-id, boot-disk-size.
        Для второго способа требуются параметры: boot-volume-id.
        Остальные параметры являются общими для обоих способов:
         display-name, launch-mode, subnet-id, publicIP, privateIP, shape, domain.
      </para>
      <variablelist>
        <varlistentry>
          <term><option>--domain-name</option></term><listitem><para>Облачный домен, где создается экземпляр.</para></listitem>
        </varlistentry>
        <varlistentry>
          <term><option>--image-id</option></term><listitem><para>Уникальный идентификатор, полностью идентифицирующий пользовательский образ в облаке.</para></listitem>
        </varlistentry>
        <varlistentry>
          <term><option>--boot-volume-id</option></term><listitem><para>Уникальный идентификатор, полностью идентифицирующий загрузочный том в облаке.</para></listitem>
        </varlistentry>
        <varlistentry>
          <term><option>--display-name</option></term><listitem><para>Имя для нового экземпляра в облаке.</para></listitem>
        </varlistentry>
        <varlistentry>
          <term><option>--shape</option></term><listitem><para>Форма экземпляра, определяющая количество ЦПУ и размер RAM памяти.</para></listitem>
        </varlistentry>
        <varlistentry>
          <term><option>--subnet</option></term><listitem><para>Уникальный идентификатор, полностью идентифицирующий существующую подсеть в облаке для использования экземпляром.</para></listitem>
        </varlistentry>
        <varlistentry>
          <term><option>--boot-disk-size</option></term><listitem><para>Размер загрузочного образа в ГБ. По умолчанию 50 ГБ.</para></listitem>
        </varlistentry>
        <varlistentry>
          <term><option>--publicip</option></term><listitem><para>У экземпляра публичный IP или нет.</para></listitem>
        </varlistentry>
        <varlistentry>
          <term><option>--privateip</option></term><listitem><para>Приватный IP адрес для созданного экземпляра.</para></listitem>
        </varlistentry>
        <varlistentry>
          <term><option>--public-ssh-key</option></term>
            <listitem>
              <para>Публичный ключ SSH, используемый для подключения к экземпляру через
                SSH. Этот параметр может быть указан несколько раз если нужно указать
                несколько ключей, например: "--public-ssh-key=firstSSHKey --public-ssh-key=secondSSHKey".
              </para>
            </listitem>
        </varlistentry>
        <varlistentry>
          <term><option>--launch-mode</option></term><listitem><para>Наиболее известные значения здесь могут быть EMULATED, NATIVE, PARAVIRTUALIZED.</para></listitem>
        </varlistentry>
      </variablelist>
    </refsect2>

    <refsect2 id="vboxmanage-cloudinstance-info">
      <title>cloud instance info</title>
      <para>
        Показывает информацию об облачном экземпляре с указанным id.
      </para>
      <variablelist>
        <varlistentry>
          <term><option>--id</option></term><listitem><para>Уникальный идентификатор, полностью идентифицирующий экземпляр в облаке.</para></listitem>
        </varlistentry>
      </variablelist>
    </refsect2>

    <refsect2 id="vboxmanage-cloudinstance-terminate">
      <title>cloud instance termination</title>
      <para>
        Удаляет облачный экземпляр с указанным id.
      </para>
      <variablelist>
        <varlistentry>
          <term><option>--id</option></term><listitem><para>Уникальный идентификатор, полностью идентифицирующий экземпляр в облаке.</para></listitem>
        </varlistentry>
      </variablelist>
    </refsect2>

    <refsect2 id="vboxmanage-cloudinstance-start">
      <title>cloud instance start</title>
      <para>
        Запускает облачный экземпляр с указанным id.
      </para>
      <variablelist>
        <varlistentry>
          <term><option>--id</option></term><listitem><para>Уникальный идентификатор, полностью идентифицирующий экземпляр в облаке.</para></listitem>
        </varlistentry>
      </variablelist>
    </refsect2>

    <refsect2 id="vboxmanage-cloudinstance-pause">
      <title>cloud instance pause</title>
      <para>
        Приостанавливает облачный экземпляр с указанным id.
      </para>
      <variablelist>
        <varlistentry>
          <term><option>--id</option></term><listitem><para>Уникальный идентификатор, полностью идентифицирующий экземпляр в облаке.</para></listitem>
        </varlistentry>
      </variablelist>
    </refsect2>
  </refsect1>
</refentry>
