| 1 | <?xml version="1.0" encoding="utf-8"?>
|
|---|
| 2 | <!--
|
|---|
| 3 | manpage, user manual, usage: VBoxManage cloud instance
|
|---|
| 4 | -->
|
|---|
| 5 | <!--
|
|---|
| 6 | Copyright (C) 2018-2022 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: 2022-12-27 12:18:46 +0000 (Tue, 27 Dec 2022) $</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>Manage the cloud instances</refpurpose>
|
|---|
| 45 | <refclass>Oracle VM VirtualBox</refclass>
|
|---|
| 46 | </refnamediv>
|
|---|
| 47 |
|
|---|
| 48 | <refsynopsisdiv>
|
|---|
| 49 | <cmdsynopsis id="synopsis-vboxmanage-create-cloudinstance" sepchar=" ">
|
|---|
| 50 | <command moreinfo="none">VBoxManage cloud</command>
|
|---|
| 51 | <arg choice="req">--provider=<replaceable>name</replaceable></arg>
|
|---|
| 52 | <arg choice="req">--profile=<replaceable>name</replaceable></arg>
|
|---|
| 53 | <arg choice="plain">instance</arg>
|
|---|
| 54 | <arg choice="plain">create</arg>
|
|---|
| 55 | <arg choice="req">--domain-name=<replaceable>name</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>name</replaceable></arg>
|
|---|
| 61 | <arg choice="req">--shape=<replaceable>type</replaceable></arg>
|
|---|
| 62 | <arg choice="req">--subnet=<replaceable>id</replaceable></arg>
|
|---|
| 63 | <arg>--boot-disk-size=<replaceable>size in GB</replaceable></arg>
|
|---|
| 64 | <arg>--publicip=<replaceable>true/false</replaceable></arg>
|
|---|
| 65 | <arg>--privateip=<replaceable>IP address</replaceable></arg>
|
|---|
| 66 | <arg rep="repeat">--public-ssh-key=<replaceable>key string</replaceable></arg>
|
|---|
| 67 | <arg>--launch-mode=<replaceable>NATIVE/EMULATED/PARAVIRTUALIZED</replaceable></arg>
|
|---|
| 68 | </cmdsynopsis>
|
|---|
| 69 | <cmdsynopsis id="synopsis-vboxmanage-info-cloudinstance" sepchar=" ">
|
|---|
| 70 | <command moreinfo="none">VBoxManage cloud</command>
|
|---|
| 71 | <arg choice="req">--provider=<replaceable>name</replaceable></arg>
|
|---|
| 72 | <arg choice="req">--profile=<replaceable>name</replaceable></arg>
|
|---|
| 73 | <arg choice="plain">instance</arg>
|
|---|
| 74 | <arg choice="plain">info</arg>
|
|---|
| 75 | <arg choice="req">--id=<replaceable>unique id</replaceable></arg>
|
|---|
| 76 | </cmdsynopsis>
|
|---|
| 77 | <cmdsynopsis id="synopsis-vboxmanage-terminate-cloudinstance" sepchar=" ">
|
|---|
| 78 | <command moreinfo="none">VBoxManage cloud</command>
|
|---|
| 79 | <arg choice="req">--provider=<replaceable>name</replaceable></arg>
|
|---|
| 80 | <arg choice="req">--profile=<replaceable>name</replaceable></arg>
|
|---|
| 81 | <arg choice="plain">instance</arg>
|
|---|
| 82 | <arg choice="plain">terminate</arg>
|
|---|
| 83 | <arg choice="req">--id=<replaceable>unique id</replaceable></arg>
|
|---|
| 84 | </cmdsynopsis>
|
|---|
| 85 | <cmdsynopsis id="synopsis-vboxmanage-start-cloudinstance" sepchar=" ">
|
|---|
| 86 | <command moreinfo="none">VBoxManage cloud</command>
|
|---|
| 87 | <arg choice="req">--provider=<replaceable>name</replaceable></arg>
|
|---|
| 88 | <arg choice="req">--profile=<replaceable>name</replaceable></arg>
|
|---|
| 89 | <arg choice="plain">instance</arg>
|
|---|
| 90 | <arg choice="plain">start</arg>
|
|---|
| 91 | <arg choice="req">--id=<replaceable>unique id</replaceable></arg>
|
|---|
| 92 | </cmdsynopsis>
|
|---|
| 93 | <cmdsynopsis id="synopsis-vboxmanage-pause-cloudinstance" sepchar=" ">
|
|---|
| 94 | <command moreinfo="none">VBoxManage cloud</command>
|
|---|
| 95 | <arg choice="req">--provider=<replaceable>name</replaceable></arg>
|
|---|
| 96 | <arg choice="req">--profile=<replaceable>name</replaceable></arg>
|
|---|
| 97 | <arg choice="plain">instance</arg>
|
|---|
| 98 | <arg choice="plain">pause</arg>
|
|---|
| 99 | <arg choice="req">--id=<replaceable>unique id</replaceable></arg>
|
|---|
| 100 | </cmdsynopsis>
|
|---|
| 101 | </refsynopsisdiv>
|
|---|
| 102 |
|
|---|
| 103 | <refsect1>
|
|---|
| 104 | <title>Description</title>
|
|---|
| 105 |
|
|---|
| 106 | <refsect2 id="vboxmanage-cloudinstance-common-options">
|
|---|
| 107 | <title>Common options</title>
|
|---|
| 108 | <remark role="help-scope" condition="GLOBAL"/>
|
|---|
| 109 | <para>The subcommands of <command>cloudinstance</command> implement the standard operations for a cloud instance
|
|---|
| 110 | like start/pause/show/terminate. The next common options must be placed between the "cloud" and the following sub-commands:</para>
|
|---|
| 111 | <variablelist>
|
|---|
| 112 | <varlistentry>
|
|---|
| 113 | <term>--provider=<replaceable>name</replaceable></term>
|
|---|
| 114 | <listitem><para>Short cloud provider name.</para></listitem>
|
|---|
| 115 | </varlistentry>
|
|---|
| 116 | <varlistentry>
|
|---|
| 117 | <term>--profile=<replaceable>name</replaceable></term>
|
|---|
| 118 | <listitem><para>Cloud profile name. </para></listitem>
|
|---|
| 119 | </varlistentry>
|
|---|
| 120 | </variablelist>
|
|---|
| 121 | </refsect2>
|
|---|
| 122 |
|
|---|
| 123 | <refsect2 id="vboxmanage-create-cloudinstance">
|
|---|
| 124 | <title>cloud instance create</title>
|
|---|
| 125 | <remark role="help-copy-synopsis"/>
|
|---|
| 126 | <para>
|
|---|
| 127 | Creates new instance in the Cloud.
|
|---|
| 128 | There are two standard ways to create an instance in the Cloud:
|
|---|
| 129 | 1. Create an instance from an existing custom image.
|
|---|
| 130 | 2. Create an instance from an existing bootable volume. This bootable volume shouldn't be attached to any instance.
|
|---|
| 131 | For the 1st approach next parameters are required: image-id and boot-disk-size.
|
|---|
| 132 | For the 2nd approach next parameters are required: boot-volume-id;
|
|---|
| 133 | The rest parameters are common for both cases:
|
|---|
| 134 | display-name, launch-mode, subnet-id, publicIP, privateIP, shape, domain.
|
|---|
| 135 | </para>
|
|---|
| 136 | <variablelist>
|
|---|
| 137 | <varlistentry>
|
|---|
| 138 | <term><option>--domain-name</option></term><listitem><para>Cloud domain where new instance is created.</para></listitem>
|
|---|
| 139 | </varlistentry>
|
|---|
| 140 | <varlistentry>
|
|---|
| 141 | <term><option>--image-id</option></term><listitem><para>Unique identifier which fully identifies a custom image in the Cloud.</para></listitem>
|
|---|
| 142 | </varlistentry>
|
|---|
| 143 | <varlistentry>
|
|---|
| 144 | <term><option>--boot-volume-id</option></term><listitem><para>Unique identifier which fully identifies a boot volume in the Cloud.</para></listitem>
|
|---|
| 145 | </varlistentry>
|
|---|
| 146 | <varlistentry>
|
|---|
| 147 | <term><option>--display-name</option></term><listitem><para>Name for new instance in the Cloud.</para></listitem>
|
|---|
| 148 | </varlistentry>
|
|---|
| 149 | <varlistentry>
|
|---|
| 150 | <term><option>--shape</option></term><listitem><para> The shape of instance, defines the number of CPUs and RAM memory.</para></listitem>
|
|---|
| 151 | </varlistentry>
|
|---|
| 152 | <varlistentry>
|
|---|
| 153 | <term><option>--subnet</option></term><listitem><para> Unique identifier which fully identifies an existing subnet in the Cloud which will be used by the instance.</para></listitem>
|
|---|
| 154 | </varlistentry>
|
|---|
| 155 | <varlistentry>
|
|---|
| 156 | <term><option>--boot-disk-size</option></term><listitem><para> The size of bootable image in GB. Default is 50GB.</para></listitem>
|
|---|
| 157 | </varlistentry>
|
|---|
| 158 | <varlistentry>
|
|---|
| 159 | <term><option>--publicip</option></term><listitem><para>Whether the instance will have a public IP or not.</para></listitem>
|
|---|
| 160 | </varlistentry>
|
|---|
| 161 | <varlistentry>
|
|---|
| 162 | <term><option>--privateip</option></term><listitem><para>Private IP address for the created instance.</para></listitem>
|
|---|
| 163 | </varlistentry>
|
|---|
| 164 | <varlistentry>
|
|---|
| 165 | <term><option>--public-ssh-key</option></term>
|
|---|
| 166 | <listitem>
|
|---|
| 167 | <para>Public SSH key used to connect to the instance via SSH.
|
|---|
| 168 | This parameter may be repeated if you plan to use more than one key as:
|
|---|
| 169 | "--public-ssh-key=firstSSHKey --public-ssh-key=secondSSHKey".
|
|---|
| 170 | </para>
|
|---|
| 171 | </listitem>
|
|---|
| 172 | </varlistentry>
|
|---|
| 173 | <varlistentry>
|
|---|
| 174 | <term><option>--launch-mode</option></term><listitem><para>The most known values here may be EMULATED, NATIVE, PARAVIRTUALIZED. </para></listitem>
|
|---|
| 175 | </varlistentry>
|
|---|
| 176 | </variablelist>
|
|---|
| 177 | </refsect2>
|
|---|
| 178 |
|
|---|
| 179 | <refsect2 id="vboxmanage-info-cloudinstance">
|
|---|
| 180 | <title>cloud instance info</title>
|
|---|
| 181 | <para>
|
|---|
| 182 | Display information about a cloud instance with a specified id.
|
|---|
| 183 | </para>
|
|---|
| 184 | <variablelist>
|
|---|
| 185 | <varlistentry>
|
|---|
| 186 | <term><option>--id</option></term><listitem><para>Unique identifier which fully identify the instance in the Cloud.</para></listitem>
|
|---|
| 187 | </varlistentry>
|
|---|
| 188 | </variablelist>
|
|---|
| 189 | </refsect2>
|
|---|
| 190 |
|
|---|
| 191 | <refsect2 id="vboxmanage-terminate-cloudinstance">
|
|---|
| 192 | <title>cloud instance termination</title>
|
|---|
| 193 | <para>
|
|---|
| 194 | Delete a cloud instance with a specified id.
|
|---|
| 195 | </para>
|
|---|
| 196 | <variablelist>
|
|---|
| 197 | <varlistentry>
|
|---|
| 198 | <term><option>--id</option></term><listitem><para>Unique identifier which fully identify the instance in the Cloud.</para></listitem>
|
|---|
| 199 | </varlistentry>
|
|---|
| 200 | </variablelist>
|
|---|
| 201 | </refsect2>
|
|---|
| 202 |
|
|---|
| 203 | <refsect2 id="vboxmanage-start-cloudinstance">
|
|---|
| 204 | <title>cloud instance start</title>
|
|---|
| 205 | <para>
|
|---|
| 206 | Start a cloud instance with a specified id.
|
|---|
| 207 | </para>
|
|---|
| 208 | <variablelist>
|
|---|
| 209 | <varlistentry>
|
|---|
| 210 | <term><option>--id</option></term><listitem><para>Unique identifier which fully identify the instance in the Cloud.</para></listitem>
|
|---|
| 211 | </varlistentry>
|
|---|
| 212 | </variablelist>
|
|---|
| 213 | </refsect2>
|
|---|
| 214 |
|
|---|
| 215 | <refsect2 id="vboxmanage-pause-cloudinstance">
|
|---|
| 216 | <title>cloud instance pause</title>
|
|---|
| 217 | <para>
|
|---|
| 218 | Pause a cloud instance with a specified id.
|
|---|
| 219 | </para>
|
|---|
| 220 | <variablelist>
|
|---|
| 221 | <varlistentry>
|
|---|
| 222 | <term><option>--id</option></term><listitem><para>Unique identifier which fully identify the instance in the Cloud.</para></listitem>
|
|---|
| 223 | </varlistentry>
|
|---|
| 224 | </variablelist>
|
|---|
| 225 | </refsect2>
|
|---|
| 226 | </refsect1>
|
|---|
| 227 | </refentry>
|
|---|
