[77777] | 1 | <?xml version="1.0" encoding="UTF-8"?>
|
---|
| 2 | <!--
|
---|
| 3 | manpage, user manual, usage: VBoxManage cloudprofile
|
---|
[96300] | 4 | -->
|
---|
| 5 | <!--
|
---|
[98103] | 6 | Copyright (C) 2018-2023 Oracle and/or its affiliates.
|
---|
[77777] | 7 |
|
---|
[96407] | 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
|
---|
[96300] | 25 | -->
|
---|
[93803] | 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 | ]>
|
---|
[77777] | 31 | <refentry id="vboxmanage-cloudprofile" lang="en">
|
---|
| 32 | <refentryinfo>
|
---|
| 33 | <pubdate>$Date: 2023-04-21 21:59:02 +0000 (Fri, 21 Apr 2023) $</pubdate>
|
---|
| 34 | <title>VBoxManage cloudprofile</title>
|
---|
| 35 | </refentryinfo>
|
---|
| 36 |
|
---|
| 37 | <refmeta>
|
---|
| 38 | <refentrytitle>VBoxManage-cloudprofile</refentrytitle>
|
---|
| 39 | <manvolnum>1</manvolnum>
|
---|
| 40 | </refmeta>
|
---|
| 41 |
|
---|
| 42 | <refnamediv>
|
---|
| 43 | <refname>VBoxManage-cloudprofile</refname>
|
---|
[79877] | 44 | <refpurpose>Manage the cloud profiles</refpurpose>
|
---|
[93707] | 45 | <refclass>&product-name;</refclass>
|
---|
[77777] | 46 | </refnamediv>
|
---|
| 47 |
|
---|
| 48 | <refsynopsisdiv>
|
---|
| 49 | <cmdsynopsis id="synopsis-vboxmanage-cloudprofile-add"> <!-- The 'id' is mandatory and must start with 'synopsis-'. -->
|
---|
| 50 | <command>VBoxManage cloudprofile</command>
|
---|
| 51 | <arg choice="req">--provider=<replaceable>name</replaceable></arg>
|
---|
| 52 | <arg choice="req">--profile=<replaceable>name</replaceable></arg>
|
---|
| 53 | <arg choice="plain">add</arg>
|
---|
[79877] | 54 | <arg>--clouduser=<replaceable>unique id</replaceable></arg>
|
---|
[77777] | 55 | <arg>--fingerprint=<replaceable>MD5 string</replaceable></arg>
|
---|
| 56 | <arg>--keyfile=<replaceable>path</replaceable></arg>
|
---|
| 57 | <arg>--passphrase=<replaceable>string</replaceable></arg>
|
---|
[79877] | 58 | <arg>--tenancy=<replaceable>unique id</replaceable></arg>
|
---|
| 59 | <arg>--compartment=<replaceable>unique id</replaceable></arg>
|
---|
[77777] | 60 | <arg>--region=<replaceable>string</replaceable></arg>
|
---|
| 61 | </cmdsynopsis>
|
---|
| 62 | <cmdsynopsis id="synopsis-vboxmanage-cloudprofile-update">
|
---|
| 63 | <command>VBoxManage cloudprofile</command>
|
---|
| 64 | <arg choice="req">--provider=<replaceable>name</replaceable></arg>
|
---|
| 65 | <arg choice="req">--profile=<replaceable>name</replaceable></arg>
|
---|
| 66 | <arg choice="plain">update</arg>
|
---|
[79877] | 67 | <arg>--clouduser=<replaceable>unique id</replaceable></arg>
|
---|
[77777] | 68 | <arg>--fingerprint=<replaceable>MD5 string</replaceable></arg>
|
---|
| 69 | <arg>--keyfile=<replaceable>path</replaceable></arg>
|
---|
| 70 | <arg>--passphrase=<replaceable>string</replaceable></arg>
|
---|
[79877] | 71 | <arg>--tenancy=<replaceable>unique id</replaceable></arg>
|
---|
| 72 | <arg>--compartment=<replaceable>unique id</replaceable></arg>
|
---|
[77777] | 73 | <arg>--region=<replaceable>string</replaceable></arg>
|
---|
| 74 | </cmdsynopsis>
|
---|
| 75 | <cmdsynopsis id="synopsis-vboxmanage-cloudprofile-delete">
|
---|
| 76 | <command>VBoxManage cloudprofile</command>
|
---|
| 77 | <arg choice="req">--provider=<replaceable>name</replaceable></arg>
|
---|
| 78 | <arg choice="req">--profile=<replaceable>name</replaceable></arg>
|
---|
| 79 | <arg choice="plain">delete</arg>
|
---|
| 80 | </cmdsynopsis>
|
---|
| 81 | <cmdsynopsis id="synopsis-vboxmanage-cloudprofile-show">
|
---|
| 82 | <command>VBoxManage cloudprofile</command>
|
---|
| 83 | <arg choice="req">--provider=<replaceable>name</replaceable></arg>
|
---|
| 84 | <arg choice="req">--profile=<replaceable>name</replaceable></arg>
|
---|
| 85 | <arg choice="plain">show</arg>
|
---|
| 86 | </cmdsynopsis>
|
---|
| 87 | </refsynopsisdiv>
|
---|
| 88 |
|
---|
[99513] | 89 | <refsect1 id="vboxmanage-cloudprofile-description">
|
---|
[77777] | 90 | <title>Description</title>
|
---|
| 91 |
|
---|
| 92 | <refsect2 id="vboxmanage-cloudprofile-common-options">
|
---|
| 93 | <title>Common options</title>
|
---|
| 94 | <remark role="help-scope" condition="GLOBAL"/>
|
---|
[79877] | 95 | <para>The subcommands of <command>cloudprofile</command> implement the standard CRUD operations for a cloud profile.
|
---|
| 96 | The next common options must be placed between the "cloud" and the following sub-commands:</para>
|
---|
[77777] | 97 | <variablelist>
|
---|
| 98 | <varlistentry>
|
---|
| 99 | <term>--provider=<replaceable>name</replaceable></term>
|
---|
| 100 | <listitem><para>Short cloud provider name.</para></listitem>
|
---|
| 101 | </varlistentry>
|
---|
| 102 | <varlistentry>
|
---|
| 103 | <term>--profile=<replaceable>name</replaceable></term>
|
---|
| 104 | <listitem><para>Cloud profile name. </para></listitem>
|
---|
| 105 | </varlistentry>
|
---|
| 106 | </variablelist>
|
---|
| 107 | </refsect2>
|
---|
| 108 |
|
---|
| 109 | <refsect2 id="vboxmanage-cloudprofile-add">
|
---|
| 110 | <title>cloudprofile add</title>
|
---|
| 111 | <remark role="help-copy-synopsis"/>
|
---|
| 112 | <para>
|
---|
| 113 | Add new cloud profile for a specified cloud provider.
|
---|
| 114 | </para>
|
---|
| 115 | <variablelist>
|
---|
| 116 | <varlistentry>
|
---|
[99161] | 117 | <term><option>--clouduser=<replaceable>unique id</replaceable></option></term>
|
---|
| 118 | <listitem><para>The name which fully identifies the user in the specified cloud provider.</para></listitem>
|
---|
[77777] | 119 | </varlistentry>
|
---|
| 120 | <varlistentry>
|
---|
[99161] | 121 | <term><option>--fingerprint=<replaceable>MD5 string</replaceable></option></term>
|
---|
| 122 | <listitem><para>Fingerprint for the key pair being used.</para></listitem>
|
---|
[77777] | 123 | </varlistentry>
|
---|
| 124 | <varlistentry>
|
---|
[99161] | 125 | <term><option>--keyfile=<replaceable>path</replaceable></option></term>
|
---|
| 126 | <listitem><para>Full path and filename of the private key. </para></listitem>
|
---|
[77777] | 127 | </varlistentry>
|
---|
| 128 | <varlistentry>
|
---|
[99161] | 129 | <term><option>--passphrase=<replaceable>string</replaceable></option></term>
|
---|
| 130 | <listitem><para>Passphrase used for the key, if it is encrypted.</para></listitem>
|
---|
[77777] | 131 | </varlistentry>
|
---|
| 132 | <varlistentry>
|
---|
[99161] | 133 | <term><option>--tenancy=<replaceable>unique id</replaceable></option></term>
|
---|
| 134 | <listitem><para>ID of your tenancy. </para></listitem>
|
---|
[77777] | 135 | </varlistentry>
|
---|
| 136 | <varlistentry>
|
---|
[99161] | 137 | <term><option>--compartment=<replaceable>unique id</replaceable></option></term>
|
---|
| 138 | <listitem><para>ID of your compartment.</para></listitem>
|
---|
[77777] | 139 | </varlistentry>
|
---|
| 140 | <varlistentry>
|
---|
[99161] | 141 | <term><option>--region=<replaceable>string</replaceable></option></term>
|
---|
| 142 | <listitem><para>Region name. Region is where you plan to deploy an application.</para></listitem>
|
---|
[77777] | 143 | </varlistentry>
|
---|
| 144 | </variablelist>
|
---|
| 145 | </refsect2>
|
---|
| 146 |
|
---|
| 147 | <refsect2 id="vboxmanage-cloudprofile-show">
|
---|
| 148 | <title>cloudprofile show</title>
|
---|
| 149 | <remark role="help-copy-synopsis"/>
|
---|
| 150 | <para>
|
---|
| 151 | Display information about a cloud profile for a specified cloud provider.
|
---|
| 152 | </para>
|
---|
| 153 | </refsect2>
|
---|
| 154 |
|
---|
| 155 | <refsect2 id="vboxmanage-cloudprofile-update">
|
---|
| 156 | <title>cloudprofile update</title>
|
---|
| 157 | <remark role="help-copy-synopsis"/>
|
---|
| 158 | <para>
|
---|
| 159 | Modify a cloud profile for the specified cloud provider.
|
---|
| 160 | </para>
|
---|
| 161 | <variablelist>
|
---|
| 162 | <varlistentry>
|
---|
[99161] | 163 | <term><option>--clouduser=<replaceable>unique id</replaceable></option></term>
|
---|
| 164 | <listitem><para>The name which fully identifies the user in the specified cloud provider.</para></listitem>
|
---|
[77777] | 165 | </varlistentry>
|
---|
| 166 | <varlistentry>
|
---|
[99161] | 167 | <term><option>--fingerprint=<replaceable>MD5 string</replaceable></option></term>
|
---|
| 168 | <listitem><para>Fingerprint for the key pair being used.</para></listitem>
|
---|
[77777] | 169 | </varlistentry>
|
---|
| 170 | <varlistentry>
|
---|
[99161] | 171 | <term><option>--keyfile=<replaceable>path</replaceable></option></term>
|
---|
| 172 | <listitem><para>Full path and filename of the private key. </para></listitem>
|
---|
[77777] | 173 | </varlistentry>
|
---|
| 174 | <varlistentry>
|
---|
[99161] | 175 | <term><option>--passphrase=<replaceable>string</replaceable></option></term>
|
---|
| 176 | <listitem><para>Passphrase used for the key, if it is encrypted.</para></listitem>
|
---|
[77777] | 177 | </varlistentry>
|
---|
| 178 | <varlistentry>
|
---|
[99161] | 179 | <term><option>--tenancy=<replaceable>unique id</replaceable></option></term>
|
---|
| 180 | <listitem><para>ID of your tenancy. </para></listitem>
|
---|
[77777] | 181 | </varlistentry>
|
---|
| 182 | <varlistentry>
|
---|
[99161] | 183 | <term><option>--compartment=<replaceable>unique id</replaceable></option></term>
|
---|
| 184 | <listitem><para>ID of your compartment.</para></listitem>
|
---|
[77777] | 185 | </varlistentry>
|
---|
| 186 | <varlistentry>
|
---|
[99161] | 187 | <term><option>--region=<replaceable>string</replaceable></option></term>
|
---|
| 188 | <listitem><para>Region name. Region is where you plan to deploy an application.</para></listitem>
|
---|
[77777] | 189 | </varlistentry>
|
---|
| 190 | </variablelist>
|
---|
| 191 | </refsect2>
|
---|
| 192 |
|
---|
| 193 | <refsect2 id="vboxmanage-cloudprofile-delete">
|
---|
| 194 | <title>cloudprofile delete</title>
|
---|
| 195 | <remark role="help-copy-synopsis"/>
|
---|
| 196 | <para>
|
---|
| 197 | Delete a cloud profile for a specified cloud provider.
|
---|
| 198 | </para>
|
---|
| 199 | </refsect2>
|
---|
| 200 |
|
---|
| 201 | </refsect1>
|
---|
| 202 |
|
---|
| 203 | </refentry>
|
---|
| 204 |
|
---|