blob: ad70eaa615539b1999d394e2b60f94106565b1e1 (
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
|
<?xml version="1.0" encoding="UTF-8"?>
<!--
manpage, user manual, usage: VBoxManage cloudprofile
-->
<!--
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-cloudprofile" lang="en">
<refentryinfo>
<pubdate>$Date: 2023-01-17 15:15:46 +0100 (Tue, 17 Jan 2023) $</pubdate>
<title>VBoxManage cloudprofile</title>
</refentryinfo>
<refmeta>
<refentrytitle>VBoxManage-cloudprofile</refentrytitle>
<manvolnum>1</manvolnum>
</refmeta>
<refnamediv>
<refname>VBoxManage-cloudprofile</refname>
<refpurpose>Manage the cloud profiles</refpurpose>
<refclass>&product-name;</refclass>
</refnamediv>
<refsynopsisdiv>
<cmdsynopsis id="synopsis-vboxmanage-cloudprofile-add"> <!-- The 'id' is mandatory and must start with 'synopsis-'. -->
<command>VBoxManage cloudprofile</command>
<arg choice="req">--provider=<replaceable>name</replaceable></arg>
<arg choice="req">--profile=<replaceable>name</replaceable></arg>
<arg choice="plain">add</arg>
<arg>--clouduser=<replaceable>unique id</replaceable></arg>
<arg>--fingerprint=<replaceable>MD5 string</replaceable></arg>
<arg>--keyfile=<replaceable>path</replaceable></arg>
<arg>--passphrase=<replaceable>string</replaceable></arg>
<arg>--tenancy=<replaceable>unique id</replaceable></arg>
<arg>--compartment=<replaceable>unique id</replaceable></arg>
<arg>--region=<replaceable>string</replaceable></arg>
</cmdsynopsis>
<cmdsynopsis id="synopsis-vboxmanage-cloudprofile-update">
<command>VBoxManage cloudprofile</command>
<arg choice="req">--provider=<replaceable>name</replaceable></arg>
<arg choice="req">--profile=<replaceable>name</replaceable></arg>
<arg choice="plain">update</arg>
<arg>--clouduser=<replaceable>unique id</replaceable></arg>
<arg>--fingerprint=<replaceable>MD5 string</replaceable></arg>
<arg>--keyfile=<replaceable>path</replaceable></arg>
<arg>--passphrase=<replaceable>string</replaceable></arg>
<arg>--tenancy=<replaceable>unique id</replaceable></arg>
<arg>--compartment=<replaceable>unique id</replaceable></arg>
<arg>--region=<replaceable>string</replaceable></arg>
</cmdsynopsis>
<cmdsynopsis id="synopsis-vboxmanage-cloudprofile-delete">
<command>VBoxManage cloudprofile</command>
<arg choice="req">--provider=<replaceable>name</replaceable></arg>
<arg choice="req">--profile=<replaceable>name</replaceable></arg>
<arg choice="plain">delete</arg>
</cmdsynopsis>
<cmdsynopsis id="synopsis-vboxmanage-cloudprofile-show">
<command>VBoxManage cloudprofile</command>
<arg choice="req">--provider=<replaceable>name</replaceable></arg>
<arg choice="req">--profile=<replaceable>name</replaceable></arg>
<arg choice="plain">show</arg>
</cmdsynopsis>
</refsynopsisdiv>
<refsect1>
<title>Description</title>
<refsect2 id="vboxmanage-cloudprofile-common-options">
<title>Common options</title>
<remark role="help-scope" condition="GLOBAL"/>
<para>The subcommands of <command>cloudprofile</command> implement the standard CRUD operations for a cloud profile.
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-cloudprofile-add">
<title>cloudprofile add</title>
<remark role="help-copy-synopsis"/>
<para>
Add new cloud profile for a specified cloud provider.
</para>
<variablelist>
<varlistentry>
<term><option>--clouduser</option></term><listitem><para>The name which fully identifies the user in the specified cloud provider.</para></listitem>
</varlistentry>
<varlistentry>
<term><option>--fingerprint</option></term><listitem><para>Fingerprint for the key pair being used.</para></listitem>
</varlistentry>
<varlistentry>
<term><option>--keyfile</option></term><listitem><para>Full path and filename of the private key. </para></listitem>
</varlistentry>
<varlistentry>
<term><option>--passphrase</option></term><listitem><para>Passphrase used for the key, if it is encrypted.</para></listitem>
</varlistentry>
<varlistentry>
<term><option>--tenancy</option></term><listitem><para>ID of your tenancy. </para></listitem>
</varlistentry>
<varlistentry>
<term><option>--compartment</option></term><listitem><para>ID of your compartment.</para></listitem>
</varlistentry>
<varlistentry>
<term><option>--region</option></term><listitem><para>Region name. Region is where you plan to deploy an application.</para></listitem>
</varlistentry>
</variablelist>
</refsect2>
<refsect2 id="vboxmanage-cloudprofile-show">
<title>cloudprofile show</title>
<remark role="help-copy-synopsis"/>
<para>
Display information about a cloud profile for a specified cloud provider.
</para>
</refsect2>
<refsect2 id="vboxmanage-cloudprofile-update">
<title>cloudprofile update</title>
<remark role="help-copy-synopsis"/>
<para>
Modify a cloud profile for the specified cloud provider.
</para>
<variablelist>
<varlistentry>
<term><option>--clouduser</option></term><listitem><para>The name which fully identifies the user in the specified cloud provider.</para></listitem>
</varlistentry>
<varlistentry>
<term><option>--fingerprint</option></term><listitem><para>Fingerprint for the key pair being used.</para></listitem>
</varlistentry>
<varlistentry>
<term><option>--keyfile</option></term><listitem><para>Full path and filename of the private key. </para></listitem>
</varlistentry>
<varlistentry>
<term><option>--passphrase</option></term><listitem><para>Passphrase used for the key, if it is encrypted.</para></listitem>
</varlistentry>
<varlistentry>
<term><option>--tenancy</option></term><listitem><para>ID of your tenancy. </para></listitem>
</varlistentry>
<varlistentry>
<term><option>--compartment</option></term><listitem><para>ID of your compartment.</para></listitem>
</varlistentry>
<varlistentry>
<term><option>--region</option></term><listitem><para>Region name. Region is where you plan to deploy an application.</para></listitem>
</varlistentry>
</variablelist>
</refsect2>
<refsect2 id="vboxmanage-cloudprofile-delete">
<title>cloudprofile delete</title>
<remark role="help-copy-synopsis"/>
<para>
Delete a cloud profile for a specified cloud provider.
</para>
</refsect2>
</refsect1>
</refentry>
|
