VirtualBox

source: vbox/trunk/doc/manual/en_US/man_VBoxManage-cloudprofile.xml@ 93707

Last change on this file since 93707 was 93707, checked in by vboxsync, 3 years ago

doc/manual: Some metadata cleanup and a bit of consistency.

  • Property svn:eol-style set to native
  • Property svn:keywords set to Author Date Id Revision
File size: 7.7 KB
Line 
1<?xml version="1.0" encoding="UTF-8"?>
2<!--
3 manpage, user manual, usage: VBoxManage cloudprofile
4
5 Copyright (C) 2018-2020 Oracle Corporation
6
7 This file is part of VirtualBox Open Source Edition (OSE), as
8 available from http://www.virtualbox.org. This file is free software;
9 you can redistribute it and/or modify it under the terms of the GNU
10 General Public License (GPL) as published by the Free Software
11 Foundation, in version 2 as it comes in the "COPYING" file of the
12 VirtualBox OSE distribution. VirtualBox OSE is distributed in the
13 hope that it will be useful, but WITHOUT ANY WARRANTY of any kind.
14 -->
15<!DOCTYPE refentry PUBLIC "-//OASIS//DTD DocBook XML V4.5//EN" "http://www.oasis-open.org/docbook/xml/4.5/docbookx.dtd">
16<refentry id="vboxmanage-cloudprofile" lang="en">
17
18 <refentryinfo>
19 <pubdate>$Date: 2022-02-11 20:10:19 +0000 (Fri, 11 Feb 2022) $</pubdate>
20 <title>VBoxManage cloudprofile</title>
21 </refentryinfo>
22
23 <refmeta>
24 <refentrytitle>VBoxManage-cloudprofile</refentrytitle>
25 <manvolnum>1</manvolnum>
26 </refmeta>
27
28 <refnamediv>
29 <refname>VBoxManage-cloudprofile</refname>
30 <refpurpose>Manage the cloud profiles</refpurpose>
31 <refclass>&product-name;</refclass>
32 </refnamediv>
33
34 <refsynopsisdiv>
35 <cmdsynopsis id="synopsis-vboxmanage-cloudprofile-add"> <!-- The 'id' is mandatory and must start with 'synopsis-'. -->
36 <command>VBoxManage cloudprofile</command>
37 <arg choice="req">--provider=<replaceable>name</replaceable></arg>
38 <arg choice="req">--profile=<replaceable>name</replaceable></arg>
39 <arg choice="plain">add</arg>
40 <arg>--clouduser=<replaceable>unique id</replaceable></arg>
41 <arg>--fingerprint=<replaceable>MD5 string</replaceable></arg>
42 <arg>--keyfile=<replaceable>path</replaceable></arg>
43 <arg>--passphrase=<replaceable>string</replaceable></arg>
44 <arg>--tenancy=<replaceable>unique id</replaceable></arg>
45 <arg>--compartment=<replaceable>unique id</replaceable></arg>
46 <arg>--region=<replaceable>string</replaceable></arg>
47 </cmdsynopsis>
48 <cmdsynopsis id="synopsis-vboxmanage-cloudprofile-update">
49 <command>VBoxManage cloudprofile</command>
50 <arg choice="req">--provider=<replaceable>name</replaceable></arg>
51 <arg choice="req">--profile=<replaceable>name</replaceable></arg>
52 <arg choice="plain">update</arg>
53 <arg>--clouduser=<replaceable>unique id</replaceable></arg>
54 <arg>--fingerprint=<replaceable>MD5 string</replaceable></arg>
55 <arg>--keyfile=<replaceable>path</replaceable></arg>
56 <arg>--passphrase=<replaceable>string</replaceable></arg>
57 <arg>--tenancy=<replaceable>unique id</replaceable></arg>
58 <arg>--compartment=<replaceable>unique id</replaceable></arg>
59 <arg>--region=<replaceable>string</replaceable></arg>
60 </cmdsynopsis>
61 <cmdsynopsis id="synopsis-vboxmanage-cloudprofile-delete">
62 <command>VBoxManage cloudprofile</command>
63 <arg choice="req">--provider=<replaceable>name</replaceable></arg>
64 <arg choice="req">--profile=<replaceable>name</replaceable></arg>
65 <arg choice="plain">delete</arg>
66 </cmdsynopsis>
67 <cmdsynopsis id="synopsis-vboxmanage-cloudprofile-show">
68 <command>VBoxManage cloudprofile</command>
69 <arg choice="req">--provider=<replaceable>name</replaceable></arg>
70 <arg choice="req">--profile=<replaceable>name</replaceable></arg>
71 <arg choice="plain">show</arg>
72 </cmdsynopsis>
73 </refsynopsisdiv>
74
75 <refsect1>
76 <title>Description</title>
77
78 <refsect2 id="vboxmanage-cloudprofile-common-options">
79 <title>Common options</title>
80 <remark role="help-scope" condition="GLOBAL"/>
81 <para>The subcommands of <command>cloudprofile</command> implement the standard CRUD operations for a cloud profile.
82 The next common options must be placed between the "cloud" and the following sub-commands:</para>
83 <variablelist>
84 <varlistentry>
85 <term>--provider=<replaceable>name</replaceable></term>
86 <listitem><para>Short cloud provider name.</para></listitem>
87 </varlistentry>
88 <varlistentry>
89 <term>--profile=<replaceable>name</replaceable></term>
90 <listitem><para>Cloud profile name. </para></listitem>
91 </varlistentry>
92 </variablelist>
93 </refsect2>
94
95 <refsect2 id="vboxmanage-cloudprofile-add">
96 <title>cloudprofile add</title>
97 <remark role="help-copy-synopsis"/>
98 <para>
99 Add new cloud profile for a specified cloud provider.
100 </para>
101 <variablelist>
102 <varlistentry>
103 <term><option>--clouduser</option></term><listitem><para>The name which fully identifies the user in the specified cloud provider.</para></listitem>
104 </varlistentry>
105 <varlistentry>
106 <term><option>--fingerprint</option></term><listitem><para>Fingerprint for the key pair being used.</para></listitem>
107 </varlistentry>
108 <varlistentry>
109 <term><option>--keyfile</option></term><listitem><para>Full path and filename of the private key. </para></listitem>
110 </varlistentry>
111 <varlistentry>
112 <term><option>--passphrase</option></term><listitem><para>Passphrase used for the key, if it is encrypted.</para></listitem>
113 </varlistentry>
114 <varlistentry>
115 <term><option>--tenancy</option></term><listitem><para>ID of your tenancy. </para></listitem>
116 </varlistentry>
117 <varlistentry>
118 <term><option>--compartment</option></term><listitem><para>ID of your compartment.</para></listitem>
119 </varlistentry>
120 <varlistentry>
121 <term><option>--region</option></term><listitem><para>Region name. Region is where you plan to deploy an application.</para></listitem>
122 </varlistentry>
123 </variablelist>
124 </refsect2>
125
126 <refsect2 id="vboxmanage-cloudprofile-show">
127 <title>cloudprofile show</title>
128 <remark role="help-copy-synopsis"/>
129 <para>
130 Display information about a cloud profile for a specified cloud provider.
131 </para>
132 </refsect2>
133
134 <refsect2 id="vboxmanage-cloudprofile-update">
135 <title>cloudprofile update</title>
136 <remark role="help-copy-synopsis"/>
137 <para>
138 Modify a cloud profile for the specified cloud provider.
139 </para>
140 <variablelist>
141 <varlistentry>
142 <term><option>--clouduser</option></term><listitem><para>The name which fully identifies the user in the specified cloud provider.</para></listitem>
143 </varlistentry>
144 <varlistentry>
145 <term><option>--fingerprint</option></term><listitem><para>Fingerprint for the key pair being used.</para></listitem>
146 </varlistentry>
147 <varlistentry>
148 <term><option>--keyfile</option></term><listitem><para>Full path and filename of the private key. </para></listitem>
149 </varlistentry>
150 <varlistentry>
151 <term><option>--passphrase</option></term><listitem><para>Passphrase used for the key, if it is encrypted.</para></listitem>
152 </varlistentry>
153 <varlistentry>
154 <term><option>--tenancy</option></term><listitem><para>ID of your tenancy. </para></listitem>
155 </varlistentry>
156 <varlistentry>
157 <term><option>--compartment</option></term><listitem><para>ID of your compartment.</para></listitem>
158 </varlistentry>
159 <varlistentry>
160 <term><option>--region</option></term><listitem><para>Region name. Region is where you plan to deploy an application.</para></listitem>
161 </varlistentry>
162 </variablelist>
163 </refsect2>
164
165 <refsect2 id="vboxmanage-cloudprofile-delete">
166 <title>cloudprofile delete</title>
167 <remark role="help-copy-synopsis"/>
168 <para>
169 Delete a cloud profile for a specified cloud provider.
170 </para>
171 </refsect2>
172
173 </refsect1>
174
175</refentry>
176
Note: See TracBrowser for help on using the repository browser.

© 2024 Oracle Support Privacy / Do Not Sell My Info Terms of Use Trademark Policy Automated Access Etiquette