1 | <?xml version="1.0" encoding="utf-8"?>
|
---|
2 | <!--
|
---|
3 | manpage, user manual, usage: VBoxManage cloud instance
|
---|
4 | -->
|
---|
5 | <!--
|
---|
6 | Copyright (C) 2018-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-cloudinstance" lang="en">
|
---|
32 | <refentryinfo>
|
---|
33 | <pubdate>$Date: 2023-01-17 14:15:46 +0000 (Tue, 17 Jan 2023) $</pubdate>
|
---|
34 | <title>VBoxManage cloud instance</title>
|
---|
35 | </refentryinfo>
|
---|
36 |
|
---|
37 | <refmeta>
|
---|
38 | <refentrytitle>VBoxManage-cloudinstance</refentrytitle>
|
---|
39 | <manvolnum>1</manvolnum>
|
---|
40 | </refmeta>
|
---|
41 |
|
---|
42 | <refnamediv>
|
---|
43 | <refname>VBoxManage-cloudinstance</refname>
|
---|
44 | <refpurpose>Управление облачными экземплярами</refpurpose>
|
---|
45 | <refclass>&product-name;</refclass>
|
---|
46 | </refnamediv>
|
---|
47 |
|
---|
48 | <refsynopsisdiv>
|
---|
49 | <cmdsynopsis id="synopsis-vboxmanage-cloudinstance-create" sepchar=" ">
|
---|
50 | <command moreinfo="none">VBoxManage cloud</command>
|
---|
51 | <arg choice="req">--provider=<replaceable>имя</replaceable></arg>
|
---|
52 | <arg choice="req">--profile=<replaceable>имя</replaceable></arg>
|
---|
53 | <arg choice="plain">instance</arg>
|
---|
54 | <arg choice="plain">create</arg>
|
---|
55 | <arg choice="req">--domain-name=<replaceable>имя</replaceable></arg>
|
---|
56 | <group choice="req">
|
---|
57 | <arg choice="req">--image-id=<replaceable>id</replaceable></arg>
|
---|
58 | <arg choice="req">--boot-volume-id=<replaceable>id</replaceable></arg>
|
---|
59 | </group>
|
---|
60 | <arg choice="req">--display-name=<replaceable>имя</replaceable></arg>
|
---|
61 | <arg choice="req">--shape=<replaceable>тип</replaceable></arg>
|
---|
62 | <arg choice="req">--subnet=<replaceable>id</replaceable></arg>
|
---|
63 | <arg>--boot-disk-size=<replaceable>размер в ГБ</replaceable></arg>
|
---|
64 | <arg>--publicip=<replaceable>true/false</replaceable></arg>
|
---|
65 | <arg>--privateip=<replaceable>IP адрес</replaceable></arg>
|
---|
66 | <arg rep="repeat">--public-ssh-key=<replaceable>ключевая строка</replaceable></arg>
|
---|
67 | <arg>--launch-mode=<replaceable>NATIVE/EMULATED/PARAVIRTUALIZED</replaceable></arg>
|
---|
68 | </cmdsynopsis>
|
---|
69 | <cmdsynopsis id="synopsis-vboxmanage-cloudinstance-info" sepchar=" ">
|
---|
70 | <command moreinfo="none">VBoxManage cloud</command>
|
---|
71 | <arg choice="req">--provider=<replaceable>имя</replaceable></arg>
|
---|
72 | <arg choice="req">--profile=<replaceable>имя</replaceable></arg>
|
---|
73 | <arg choice="plain">instance</arg>
|
---|
74 | <arg choice="plain">info</arg>
|
---|
75 | <arg choice="req">--id=<replaceable>уникальный id</replaceable></arg>
|
---|
76 | </cmdsynopsis>
|
---|
77 | <cmdsynopsis id="synopsis-vboxmanage-cloudinstance-terminate" sepchar=" ">
|
---|
78 | <command moreinfo="none">VBoxManage cloud</command>
|
---|
79 | <arg choice="req">--provider=<replaceable>имя</replaceable></arg>
|
---|
80 | <arg choice="req">--profile=<replaceable>имя</replaceable></arg>
|
---|
81 | <arg choice="plain">instance</arg>
|
---|
82 | <arg choice="plain">terminate</arg>
|
---|
83 | <arg choice="req">--id=<replaceable>уникальный id</replaceable></arg>
|
---|
84 | </cmdsynopsis>
|
---|
85 | <cmdsynopsis id="synopsis-vboxmanage-cloudinstance-start" sepchar=" ">
|
---|
86 | <command moreinfo="none">VBoxManage cloud</command>
|
---|
87 | <arg choice="req">--provider=<replaceable>имя</replaceable></arg>
|
---|
88 | <arg choice="req">--profile=<replaceable>имя</replaceable></arg>
|
---|
89 | <arg choice="plain">instance</arg>
|
---|
90 | <arg choice="plain">start</arg>
|
---|
91 | <arg choice="req">--id=<replaceable>уникальный id</replaceable></arg>
|
---|
92 | </cmdsynopsis>
|
---|
93 | <cmdsynopsis id="synopsis-vboxmanage-cloudinstance-pause" sepchar=" ">
|
---|
94 | <command moreinfo="none">VBoxManage cloud</command>
|
---|
95 | <arg choice="req">--provider=<replaceable>имя</replaceable></arg>
|
---|
96 | <arg choice="req">--profile=<replaceable>имя</replaceable></arg>
|
---|
97 | <arg choice="plain">instance</arg>
|
---|
98 | <arg choice="plain">pause</arg>
|
---|
99 | <arg choice="req">--id=<replaceable>уникальный id</replaceable></arg>
|
---|
100 | </cmdsynopsis>
|
---|
101 | </refsynopsisdiv>
|
---|
102 |
|
---|
103 | <refsect1>
|
---|
104 | <title>Описание</title>
|
---|
105 |
|
---|
106 | <refsect2 id="vboxmanage-cloudinstance-common-options">
|
---|
107 | <title>Общие параметры</title>
|
---|
108 | <remark role="help-scope" condition="GLOBAL"/>
|
---|
109 | <para>Подкоманды <command>cloudinstance</command> реализуют стандартные операции над облачными экземплярами, как то
|
---|
110 | start/pause/show/terminate. Следующие общие параметры должны быть помещены между "cloud" и последующими подкомандами:</para>
|
---|
111 | <variablelist>
|
---|
112 | <varlistentry>
|
---|
113 | <term>--provider=<replaceable>имя</replaceable></term>
|
---|
114 | <listitem><para>Короткое имя облачного провайдера.</para></listitem>
|
---|
115 | </varlistentry>
|
---|
116 | <varlistentry>
|
---|
117 | <term>--profile=<replaceable>имя</replaceable></term>
|
---|
118 | <listitem><para>Имя облачного профиля. </para></listitem>
|
---|
119 | </varlistentry>
|
---|
120 | </variablelist>
|
---|
121 | </refsect2>
|
---|
122 |
|
---|
123 | <refsect2 id="vboxmanage-cloudinstance-create">
|
---|
124 | <title>cloud instance create</title>
|
---|
125 | <remark role="help-copy-synopsis"/>
|
---|
126 | <para>
|
---|
127 | Создает новый экземпляр в облаке.
|
---|
128 | Существует два стандартных способа создать экземпляр в облаке:
|
---|
129 | 1. Создать экземпляр из существующего пользовательского образа.
|
---|
130 | 2. Создать экземпляр из существующего загрузочного тома. Этот загрузочный том не должен быть подключен
|
---|
131 | к какому-либо экземпляру.
|
---|
132 | Для первого способа требуются параметры: image-id, boot-disk-size.
|
---|
133 | Для второго способа требуются параметры: boot-volume-id.
|
---|
134 | Остальные параметры являются общими для обоих способов:
|
---|
135 | display-name, launch-mode, subnet-id, publicIP, privateIP, shape, domain.
|
---|
136 | </para>
|
---|
137 | <variablelist>
|
---|
138 | <varlistentry>
|
---|
139 | <term><option>--domain-name</option></term><listitem><para>Облачный домен, где создается экземпляр.</para></listitem>
|
---|
140 | </varlistentry>
|
---|
141 | <varlistentry>
|
---|
142 | <term><option>--image-id</option></term><listitem><para>Уникальный идентификатор, полностью идентифицирующий пользовательский образ в облаке.</para></listitem>
|
---|
143 | </varlistentry>
|
---|
144 | <varlistentry>
|
---|
145 | <term><option>--boot-volume-id</option></term><listitem><para>Уникальный идентификатор, полностью идентифицирующий загрузочный том в облаке.</para></listitem>
|
---|
146 | </varlistentry>
|
---|
147 | <varlistentry>
|
---|
148 | <term><option>--display-name</option></term><listitem><para>Имя для нового экземпляра в облаке.</para></listitem>
|
---|
149 | </varlistentry>
|
---|
150 | <varlistentry>
|
---|
151 | <term><option>--shape</option></term><listitem><para>Форма экземпляра, определяющая количество ЦПУ и размер RAM памяти.</para></listitem>
|
---|
152 | </varlistentry>
|
---|
153 | <varlistentry>
|
---|
154 | <term><option>--subnet</option></term><listitem><para>Уникальный идентификатор, полностью идентифицирующий существующую подсеть в облаке для использования экземпляром.</para></listitem>
|
---|
155 | </varlistentry>
|
---|
156 | <varlistentry>
|
---|
157 | <term><option>--boot-disk-size</option></term><listitem><para>Размер загрузочного образа в ГБ. По умолчанию 50 ГБ.</para></listitem>
|
---|
158 | </varlistentry>
|
---|
159 | <varlistentry>
|
---|
160 | <term><option>--publicip</option></term><listitem><para>У экземпляра публичный IP или нет.</para></listitem>
|
---|
161 | </varlistentry>
|
---|
162 | <varlistentry>
|
---|
163 | <term><option>--privateip</option></term><listitem><para>Приватный IP адрес для созданного экземпляра.</para></listitem>
|
---|
164 | </varlistentry>
|
---|
165 | <varlistentry>
|
---|
166 | <term><option>--public-ssh-key</option></term>
|
---|
167 | <listitem>
|
---|
168 | <para>Публичный ключ SSH, используемый для подключения к экземпляру через
|
---|
169 | SSH. Этот параметр может быть указан несколько раз если нужно указать
|
---|
170 | несколько ключей, например: "--public-ssh-key=firstSSHKey --public-ssh-key=secondSSHKey".
|
---|
171 | </para>
|
---|
172 | </listitem>
|
---|
173 | </varlistentry>
|
---|
174 | <varlistentry>
|
---|
175 | <term><option>--launch-mode</option></term><listitem><para>Наиболее известные значения здесь могут быть EMULATED, NATIVE, PARAVIRTUALIZED.</para></listitem>
|
---|
176 | </varlistentry>
|
---|
177 | </variablelist>
|
---|
178 | </refsect2>
|
---|
179 |
|
---|
180 | <refsect2 id="vboxmanage-cloudinstance-info">
|
---|
181 | <title>cloud instance info</title>
|
---|
182 | <para>
|
---|
183 | Показывает информацию об облачном экземпляре с указанным id.
|
---|
184 | </para>
|
---|
185 | <variablelist>
|
---|
186 | <varlistentry>
|
---|
187 | <term><option>--id</option></term><listitem><para>Уникальный идентификатор, полностью идентифицирующий экземпляр в облаке.</para></listitem>
|
---|
188 | </varlistentry>
|
---|
189 | </variablelist>
|
---|
190 | </refsect2>
|
---|
191 |
|
---|
192 | <refsect2 id="vboxmanage-cloudinstance-terminate">
|
---|
193 | <title>cloud instance termination</title>
|
---|
194 | <para>
|
---|
195 | Удаляет облачный экземпляр с указанным id.
|
---|
196 | </para>
|
---|
197 | <variablelist>
|
---|
198 | <varlistentry>
|
---|
199 | <term><option>--id</option></term><listitem><para>Уникальный идентификатор, полностью идентифицирующий экземпляр в облаке.</para></listitem>
|
---|
200 | </varlistentry>
|
---|
201 | </variablelist>
|
---|
202 | </refsect2>
|
---|
203 |
|
---|
204 | <refsect2 id="vboxmanage-cloudinstance-start">
|
---|
205 | <title>cloud instance start</title>
|
---|
206 | <para>
|
---|
207 | Запускает облачный экземпляр с указанным id.
|
---|
208 | </para>
|
---|
209 | <variablelist>
|
---|
210 | <varlistentry>
|
---|
211 | <term><option>--id</option></term><listitem><para>Уникальный идентификатор, полностью идентифицирующий экземпляр в облаке.</para></listitem>
|
---|
212 | </varlistentry>
|
---|
213 | </variablelist>
|
---|
214 | </refsect2>
|
---|
215 |
|
---|
216 | <refsect2 id="vboxmanage-cloudinstance-pause">
|
---|
217 | <title>cloud instance pause</title>
|
---|
218 | <para>
|
---|
219 | Приостанавливает облачный экземпляр с указанным id.
|
---|
220 | </para>
|
---|
221 | <variablelist>
|
---|
222 | <varlistentry>
|
---|
223 | <term><option>--id</option></term><listitem><para>Уникальный идентификатор, полностью идентифицирующий экземпляр в облаке.</para></listitem>
|
---|
224 | </varlistentry>
|
---|
225 | </variablelist>
|
---|
226 | </refsect2>
|
---|
227 | </refsect1>
|
---|
228 | </refentry>
|
---|