| 1 | <?xml version="1.0" encoding="UTF-8"?>
|
|---|
| 2 | <!--
|
|---|
| 3 | manpage, user manual, usage: VBoxManage cloud image
|
|---|
| 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-cloudimage" lang="en">
|
|---|
| 32 | <refentryinfo>
|
|---|
| 33 | <pubdate>$Date: 2023-01-17 14:15:46 +0000 (Tue, 17 Jan 2023) $</pubdate>
|
|---|
| 34 | <title>VBoxManage cloud image</title>
|
|---|
| 35 | </refentryinfo>
|
|---|
| 36 |
|
|---|
| 37 | <refmeta>
|
|---|
| 38 | <refentrytitle>VBoxManage-cloudimage</refentrytitle>
|
|---|
| 39 | <manvolnum>1</manvolnum>
|
|---|
| 40 | </refmeta>
|
|---|
| 41 |
|
|---|
| 42 | <refnamediv>
|
|---|
| 43 | <refname>VBoxManage-cloudimage</refname>
|
|---|
| 44 | <refpurpose>Manage the cloud images</refpurpose>
|
|---|
| 45 | <refclass>Oracle VM VirtualBox</refclass>
|
|---|
| 46 | </refnamediv>
|
|---|
| 47 |
|
|---|
| 48 | <refsynopsisdiv>
|
|---|
| 49 | <cmdsynopsis id="synopsis-vboxmanage-cloudimage-create" sepchar=" "> <!-- The 'id' is mandatory and must start with 'synopsis-'. -->
|
|---|
| 50 | <command>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">image</arg>
|
|---|
| 54 | <arg choice="plain">create</arg>
|
|---|
| 55 | <arg choice="req">--display-name=<replaceable>name</replaceable></arg>
|
|---|
| 56 | <arg>--bucket-name=<replaceable>name</replaceable></arg>
|
|---|
| 57 | <arg>--object-name=<replaceable>name</replaceable></arg>
|
|---|
| 58 | <arg>--instance-id=<replaceable>unique id</replaceable></arg>
|
|---|
| 59 | </cmdsynopsis>
|
|---|
| 60 | <cmdsynopsis id="synopsis-vboxmanage-cloudimage-info" sepchar=" ">
|
|---|
| 61 | <command>VBoxManage cloud</command>
|
|---|
| 62 | <arg choice="req">--provider=<replaceable>name</replaceable></arg>
|
|---|
| 63 | <arg choice="req">--profile=<replaceable>name</replaceable></arg>
|
|---|
| 64 | <arg choice="plain">image</arg>
|
|---|
| 65 | <arg choice="plain">info</arg>
|
|---|
| 66 | <arg choice="req">--id=<replaceable>unique id</replaceable></arg>
|
|---|
| 67 | </cmdsynopsis>
|
|---|
| 68 | <cmdsynopsis id="synopsis-vboxmanage-cloudimage-delete" sepchar=" ">
|
|---|
| 69 | <command>VBoxManage cloud</command>
|
|---|
| 70 | <arg choice="req">--provider=<replaceable>name</replaceable></arg>
|
|---|
| 71 | <arg choice="req">--profile=<replaceable>name</replaceable></arg>
|
|---|
| 72 | <arg choice="plain">image</arg>
|
|---|
| 73 | <arg choice="plain">delete</arg>
|
|---|
| 74 | <arg choice="req">--id=<replaceable>unique id</replaceable></arg>
|
|---|
| 75 | </cmdsynopsis>
|
|---|
| 76 | <cmdsynopsis id="synopsis-vboxmanage-cloudimage-import" sepchar=" ">
|
|---|
| 77 | <command>VBoxManage cloud</command>
|
|---|
| 78 | <arg choice="req">--provider=<replaceable>name</replaceable></arg>
|
|---|
| 79 | <arg choice="req">--profile=<replaceable>name</replaceable></arg>
|
|---|
| 80 | <arg choice="plain">image</arg>
|
|---|
| 81 | <arg choice="plain">import</arg>
|
|---|
| 82 | <arg choice="req">--id=<replaceable>unique id</replaceable></arg>
|
|---|
| 83 | <arg>--bucket-name=<replaceable>name</replaceable></arg>
|
|---|
| 84 | <arg>--object-name=<replaceable>name</replaceable></arg>
|
|---|
| 85 | </cmdsynopsis>
|
|---|
| 86 | <cmdsynopsis id="synopsis-vboxmanage-cloudimage-export" sepchar=" ">
|
|---|
| 87 | <command>VBoxManage cloud</command>
|
|---|
| 88 | <arg choice="req">--provider=<replaceable>name</replaceable></arg>
|
|---|
| 89 | <arg choice="req">--profile=<replaceable>name</replaceable></arg>
|
|---|
| 90 | <arg choice="plain">image</arg>
|
|---|
| 91 | <arg choice="plain">export</arg>
|
|---|
| 92 | <arg choice="req">--id=<replaceable>unique id</replaceable></arg>
|
|---|
| 93 | <arg choice="req">--display-name=<replaceable>name</replaceable></arg>
|
|---|
| 94 | <arg>--bucket-name=<replaceable>name</replaceable></arg>
|
|---|
| 95 | <arg>--object-name=<replaceable>name</replaceable></arg>
|
|---|
| 96 | </cmdsynopsis>
|
|---|
| 97 | </refsynopsisdiv>
|
|---|
| 98 |
|
|---|
| 99 | <refsect1>
|
|---|
| 100 | <title>Description</title>
|
|---|
| 101 |
|
|---|
| 102 | <refsect2 id="vboxmanage-cloudimage-common-options">
|
|---|
| 103 | <title>Common options</title>
|
|---|
| 104 | <remark role="help-scope" condition="GLOBAL"/>
|
|---|
| 105 | <para>The subcommands of <command>cloudimage</command> implement the standard operations for a cloud image
|
|---|
| 106 | like create/delete/show/import/export. The next common options must be placed between the "cloud" and the following sub-commands:</para>
|
|---|
| 107 | <variablelist>
|
|---|
| 108 | <varlistentry>
|
|---|
| 109 | <term>--provider=<replaceable>name</replaceable></term>
|
|---|
| 110 | <listitem><para>Short cloud provider name.</para></listitem>
|
|---|
| 111 | </varlistentry>
|
|---|
| 112 | <varlistentry>
|
|---|
| 113 | <term>--profile=<replaceable>name</replaceable></term>
|
|---|
| 114 | <listitem><para>Cloud profile name. </para></listitem>
|
|---|
| 115 | </varlistentry>
|
|---|
| 116 | </variablelist>
|
|---|
| 117 | </refsect2>
|
|---|
| 118 |
|
|---|
| 119 | <refsect2 id="vboxmanage-cloudimage-create">
|
|---|
| 120 | <title>cloud image create</title>
|
|---|
| 121 | <remark role="help-copy-synopsis"/>
|
|---|
| 122 | <para>
|
|---|
| 123 | Creates new image in the Cloud.
|
|---|
| 124 | There are two standard ways to create an image in the Cloud:
|
|---|
| 125 | 1. Create an image from an object in the Cloud Storage;
|
|---|
| 126 | 2. Create an image from an existing cloud instance.
|
|---|
| 127 | For the 1st approach next parameters are required:
|
|---|
| 128 | bucket-name - cloud bucket name where an object is located;
|
|---|
| 129 | object-name - name of object in the bucket;
|
|---|
| 130 | display-name - name for new image in the Cloud.
|
|---|
| 131 | For the 2d approach next parameters are required:
|
|---|
| 132 | instance-id - Id of instance in the Cloud;
|
|---|
| 133 | display-name - name for new image in the Cloud.
|
|---|
| 134 | </para>
|
|---|
| 135 | <variablelist>
|
|---|
| 136 | <varlistentry>
|
|---|
| 137 | <term><option>--display-name</option></term><listitem><para>Name for new image in the Cloud.</para></listitem>
|
|---|
| 138 | </varlistentry>
|
|---|
| 139 | <varlistentry>
|
|---|
| 140 | <term><option>--bucket-name</option></term><listitem><para>Cloud bucket name where an object is located.</para></listitem>
|
|---|
| 141 | </varlistentry>
|
|---|
| 142 | <varlistentry>
|
|---|
| 143 | <term><option>--object-name</option></term><listitem><para>Name of object in the bucket.</para></listitem>
|
|---|
| 144 | </varlistentry>
|
|---|
| 145 | <varlistentry>
|
|---|
| 146 | <term><option>--instance-id</option></term><listitem><para>Unique identifier which fully identifies the instance in the Cloud.</para></listitem>
|
|---|
| 147 | </varlistentry>
|
|---|
| 148 | </variablelist>
|
|---|
| 149 | </refsect2>
|
|---|
| 150 |
|
|---|
| 151 | <refsect2 id="vboxmanage-cloudimage-info">
|
|---|
| 152 | <title>cloud image info</title>
|
|---|
| 153 | <remark role="help-copy-synopsis"/>
|
|---|
| 154 | <para>
|
|---|
| 155 | Display information about a cloud image with a specified id.
|
|---|
| 156 | </para>
|
|---|
| 157 | <variablelist>
|
|---|
| 158 | <varlistentry>
|
|---|
| 159 | <term><option>--id</option></term><listitem><para>Unique identifier which fully identifies the image in the Cloud.</para></listitem>
|
|---|
| 160 | </varlistentry>
|
|---|
| 161 | </variablelist>
|
|---|
| 162 | </refsect2>
|
|---|
| 163 |
|
|---|
| 164 | <refsect2 id="vboxmanage-cloudimage-delete">
|
|---|
| 165 | <title>cloud image delete</title>
|
|---|
| 166 | <remark role="help-copy-synopsis"/>
|
|---|
| 167 | <para>
|
|---|
| 168 | Delete an image with a specified id from the Cloud.
|
|---|
| 169 | </para>
|
|---|
| 170 | <variablelist>
|
|---|
| 171 | <varlistentry>
|
|---|
| 172 | <term><option>--id</option></term><listitem><para>Unique identifier which fully identifies the image in the Cloud.</para></listitem>
|
|---|
| 173 | </varlistentry>
|
|---|
| 174 | </variablelist>
|
|---|
| 175 | </refsect2>
|
|---|
| 176 |
|
|---|
| 177 | <refsect2 id="vboxmanage-cloudimage-import">
|
|---|
| 178 | <title>cloud image import</title>
|
|---|
| 179 | <remark role="help-copy-synopsis"/>
|
|---|
| 180 | <para>
|
|---|
| 181 | Import an image with a specified id from the Cloud to a local host.
|
|---|
| 182 | The result is an object in the local "temp" folder on the local host.
|
|---|
| 183 | Possible approach may have two general steps:
|
|---|
| 184 | 1. Create an object from an image in the Cloud Storage;
|
|---|
| 185 | 2. Download the object to the local host.
|
|---|
| 186 | So the next parameters may be required:
|
|---|
| 187 | bucket-name - cloud bucket name where the object will be created;
|
|---|
| 188 | object-name - name of object in the bucket. if parameter "object-name" is absent a displayed image name is used.
|
|---|
| 189 | If the first step isn't needed only the parameter "id" is required.
|
|---|
| 190 | </para>
|
|---|
| 191 | <variablelist>
|
|---|
| 192 | <varlistentry>
|
|---|
| 193 | <term><option>--id</option></term><listitem><para>Unique identifier which fully identifies the image in the Cloud.</para></listitem>
|
|---|
| 194 | </varlistentry>
|
|---|
| 195 | <varlistentry>
|
|---|
| 196 | <term><option>--bucket-name</option></term><listitem><para>Cloud bucket name where an object will be created.</para></listitem>
|
|---|
| 197 | </varlistentry>
|
|---|
| 198 | <varlistentry>
|
|---|
| 199 | <term><option>--object-name</option></term>
|
|---|
| 200 | <listitem>
|
|---|
| 201 | <para>
|
|---|
| 202 | Name of created object in the bucket. The downloaded object will have this name.
|
|---|
| 203 | </para>
|
|---|
| 204 | </listitem>
|
|---|
| 205 | </varlistentry>
|
|---|
| 206 | </variablelist>
|
|---|
| 207 | </refsect2>
|
|---|
| 208 |
|
|---|
| 209 | <refsect2 id="vboxmanage-cloudimage-export">
|
|---|
| 210 | <title>cloud image export</title>
|
|---|
| 211 | <remark role="help-copy-synopsis"/>
|
|---|
| 212 | <para>
|
|---|
| 213 | Export an existing VBox image with a specified uuid from a local host to the Cloud.
|
|---|
| 214 | The result is new image in the Cloud.
|
|---|
| 215 | Possible approach may have two general steps:
|
|---|
| 216 | 1. Upload VBox image to the Cloud Storage;
|
|---|
| 217 | 2. Create an image from the uploaded object.
|
|---|
| 218 | So the next parameters may be required:
|
|---|
| 219 | bucket-name -cloud bucket name where the object will be uploaded;
|
|---|
| 220 | object-name - name of object in the bucket. If parameter "object-name" is absent the image id is used;
|
|---|
| 221 | display-name - name for new image in the Cloud.
|
|---|
| 222 | If the first step isn't needed the parameters "id" and "display-name" are required only.
|
|---|
| 223 | </para>
|
|---|
| 224 | <variablelist>
|
|---|
| 225 | <varlistentry>
|
|---|
| 226 | <term><option>--id</option></term><listitem><para>Unique identifier of the image in the VirtualBox.</para></listitem>
|
|---|
| 227 | </varlistentry>
|
|---|
| 228 | <varlistentry>
|
|---|
| 229 | <term><option>--display-name</option></term><listitem><para>Name for new image in the Cloud.</para></listitem>
|
|---|
| 230 | </varlistentry>
|
|---|
| 231 | <varlistentry>
|
|---|
| 232 | <term><option>--bucket-name</option></term><listitem><para>Cloud bucket name where the image (object) will be uploaded.</para></listitem>
|
|---|
| 233 | </varlistentry>
|
|---|
| 234 | <varlistentry>
|
|---|
| 235 | <term><option>--object-name</option></term><listitem><para>Name of object in the bucket.</para></listitem>
|
|---|
| 236 | </varlistentry>
|
|---|
| 237 | </variablelist>
|
|---|
| 238 | </refsect2>
|
|---|
| 239 | </refsect1>
|
|---|
| 240 |
|
|---|
| 241 | </refentry>
|
|---|
| 242 |
|
|---|
