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