| 1 | <?xml version="1.0" encoding="UTF-8"?>
|
|---|
| 2 | <!--
|
|---|
| 3 | manpage, user manual, usage: VBoxManage cloudprofile
|
|---|
| 4 | -->
|
|---|
| 5 | <!--
|
|---|
| 6 | Copyright (C) 2018-2024 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-cloudprofile" lang="en">
|
|---|
| 32 | <refentryinfo>
|
|---|
| 33 | <pubdate>$Date: 2024-09-16 14:03:52 +0000 (Mon, 16 Sep 2024) $</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>
|
|---|
| 44 | <refpurpose>Manage the cloud profiles</refpurpose>
|
|---|
| 45 | <refclass>&product-name;</refclass>
|
|---|
| 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>
|
|---|
| 54 | <arg>--clouduser=<replaceable>unique id</replaceable></arg>
|
|---|
| 55 | <arg>--fingerprint=<replaceable>MD5 string</replaceable></arg>
|
|---|
| 56 | <arg>--keyfile=<replaceable>path</replaceable></arg>
|
|---|
| 57 | <arg>--passphrase=<replaceable>string</replaceable></arg>
|
|---|
| 58 | <arg>--tenancy=<replaceable>unique id</replaceable></arg>
|
|---|
| 59 | <arg>--compartment=<replaceable>unique id</replaceable></arg>
|
|---|
| 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>
|
|---|
| 67 | <arg>--clouduser=<replaceable>unique id</replaceable></arg>
|
|---|
| 68 | <arg>--fingerprint=<replaceable>MD5 string</replaceable></arg>
|
|---|
| 69 | <arg>--keyfile=<replaceable>path</replaceable></arg>
|
|---|
| 70 | <arg>--passphrase=<replaceable>string</replaceable></arg>
|
|---|
| 71 | <arg>--tenancy=<replaceable>unique id</replaceable></arg>
|
|---|
| 72 | <arg>--compartment=<replaceable>unique id</replaceable></arg>
|
|---|
| 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 |
|
|---|
| 89 | <refsect1 id="vboxmanage-cloudprofile-description">
|
|---|
| 90 | <title>Description</title>
|
|---|
| 91 |
|
|---|
| 92 | <refsect2 id="vboxmanage-cloudprofile-common-options">
|
|---|
| 93 | <title>Common options</title>
|
|---|
| 94 | <remark role="help-scope" condition="GLOBAL"/>
|
|---|
| 95 | <para>The subcommands of <command>cloudprofile</command> implement the standard Create, Read,
|
|---|
| 96 | Update, and Delete (CRUD) operations for a cloud profile.
|
|---|
| 97 | The following common options must be placed after the <command>cloudprofile</command> argument and
|
|---|
| 98 | before the following sub-commands:</para>
|
|---|
| 99 | <variablelist>
|
|---|
| 100 | <varlistentry>
|
|---|
| 101 | <term>--provider=<replaceable>name</replaceable></term>
|
|---|
| 102 | <listitem><para>Short cloud provider name.</para></listitem>
|
|---|
| 103 | </varlistentry>
|
|---|
| 104 | <varlistentry>
|
|---|
| 105 | <term>--profile=<replaceable>name</replaceable></term>
|
|---|
| 106 | <listitem><para>Cloud profile name.</para></listitem>
|
|---|
| 107 | </varlistentry>
|
|---|
| 108 | </variablelist>
|
|---|
| 109 | </refsect2>
|
|---|
| 110 |
|
|---|
| 111 | <refsect2 id="vboxmanage-cloudprofile-add">
|
|---|
| 112 | <title>cloudprofile add</title>
|
|---|
| 113 | <remark role="help-copy-synopsis"/>
|
|---|
| 114 | <para>
|
|---|
| 115 | Add a new cloud profile for the specified cloud provider.
|
|---|
| 116 | </para>
|
|---|
| 117 | <variablelist>
|
|---|
| 118 | <varlistentry>
|
|---|
| 119 | <term><option>--clouduser=<replaceable>unique id</replaceable></option></term>
|
|---|
| 120 | <listitem><para>The name which fully identifies the user in the specified cloud provider.</para></listitem>
|
|---|
| 121 | </varlistentry>
|
|---|
| 122 | <varlistentry>
|
|---|
| 123 | <term><option>--fingerprint=<replaceable>MD5 string</replaceable></option></term>
|
|---|
| 124 | <listitem><para>Fingerprint of the key pair being used.</para></listitem>
|
|---|
| 125 | </varlistentry>
|
|---|
| 126 | <varlistentry>
|
|---|
| 127 | <term><option>--keyfile=<replaceable>path</replaceable></option></term>
|
|---|
| 128 | <listitem><para>Full path and filename of the private key.</para></listitem>
|
|---|
| 129 | </varlistentry>
|
|---|
| 130 | <varlistentry>
|
|---|
| 131 | <term><option>--passphrase=<replaceable>string</replaceable></option></term>
|
|---|
| 132 | <listitem><para>Passphrase used for the key if it is encrypted.</para></listitem>
|
|---|
| 133 | </varlistentry>
|
|---|
| 134 | <varlistentry>
|
|---|
| 135 | <term><option>--tenancy=<replaceable>unique id</replaceable></option></term>
|
|---|
| 136 | <listitem><para>ID of your tenancy.</para></listitem>
|
|---|
| 137 | </varlistentry>
|
|---|
| 138 | <varlistentry>
|
|---|
| 139 | <term><option>--compartment=<replaceable>unique id</replaceable></option></term>
|
|---|
| 140 | <listitem><para>ID of your compartment.</para></listitem>
|
|---|
| 141 | </varlistentry>
|
|---|
| 142 | <varlistentry>
|
|---|
| 143 | <term><option>--region=<replaceable>string</replaceable></option></term>
|
|---|
| 144 | <listitem><para>Region name. Region is where you plan to deploy an application.</para></listitem>
|
|---|
| 145 | </varlistentry>
|
|---|
| 146 | </variablelist>
|
|---|
| 147 | </refsect2>
|
|---|
| 148 |
|
|---|
| 149 | <refsect2 id="vboxmanage-cloudprofile-show">
|
|---|
| 150 | <title>cloudprofile show</title>
|
|---|
| 151 | <remark role="help-copy-synopsis"/>
|
|---|
| 152 | <para>
|
|---|
| 153 | Display information about a cloud profile for the specified cloud provider.
|
|---|
| 154 | </para>
|
|---|
| 155 | </refsect2>
|
|---|
| 156 |
|
|---|
| 157 | <refsect2 id="vboxmanage-cloudprofile-update">
|
|---|
| 158 | <title>cloudprofile update</title>
|
|---|
| 159 | <remark role="help-copy-synopsis"/>
|
|---|
| 160 | <para>
|
|---|
| 161 | Modify a cloud profile for the specified cloud provider.
|
|---|
| 162 | </para>
|
|---|
| 163 | <variablelist>
|
|---|
| 164 | <varlistentry>
|
|---|
| 165 | <term><option>--clouduser=<replaceable>unique id</replaceable></option></term>
|
|---|
| 166 | <listitem><para>The name which fully identifies the user in the specified cloud provider.</para></listitem>
|
|---|
| 167 | </varlistentry>
|
|---|
| 168 | <varlistentry>
|
|---|
| 169 | <term><option>--fingerprint=<replaceable>MD5 string</replaceable></option></term>
|
|---|
| 170 | <listitem><para>Fingerprint for the key pair being used.</para></listitem>
|
|---|
| 171 | </varlistentry>
|
|---|
| 172 | <varlistentry>
|
|---|
| 173 | <term><option>--keyfile=<replaceable>path</replaceable></option></term>
|
|---|
| 174 | <listitem><para>Full path and filename of the private key.</para></listitem>
|
|---|
| 175 | </varlistentry>
|
|---|
| 176 | <varlistentry>
|
|---|
| 177 | <term><option>--passphrase=<replaceable>string</replaceable></option></term>
|
|---|
| 178 | <listitem><para>Passphrase used for the key if it is encrypted.</para></listitem>
|
|---|
| 179 | </varlistentry>
|
|---|
| 180 | <varlistentry>
|
|---|
| 181 | <term><option>--tenancy=<replaceable>unique id</replaceable></option></term>
|
|---|
| 182 | <listitem><para>ID of the tenancy.</para></listitem>
|
|---|
| 183 | </varlistentry>
|
|---|
| 184 | <varlistentry>
|
|---|
| 185 | <term><option>--compartment=<replaceable>unique id</replaceable></option></term>
|
|---|
| 186 | <listitem><para>ID of the compartment.</para></listitem>
|
|---|
| 187 | </varlistentry>
|
|---|
| 188 | <varlistentry>
|
|---|
| 189 | <term><option>--region=<replaceable>string</replaceable></option></term>
|
|---|
| 190 | <listitem><para>Region name. Region is where you plan to deploy an application.</para></listitem>
|
|---|
| 191 | </varlistentry>
|
|---|
| 192 | </variablelist>
|
|---|
| 193 | </refsect2>
|
|---|
| 194 |
|
|---|
| 195 | <refsect2 id="vboxmanage-cloudprofile-delete">
|
|---|
| 196 | <title>cloudprofile delete</title>
|
|---|
| 197 | <remark role="help-copy-synopsis"/>
|
|---|
| 198 | <para>
|
|---|
| 199 | Delete a cloud profile for a specified cloud provider.
|
|---|
| 200 | </para>
|
|---|
| 201 | </refsect2>
|
|---|
| 202 |
|
|---|
| 203 | </refsect1>
|
|---|
| 204 |
|
|---|
| 205 | </refentry>
|
|---|
| 206 |
|
|---|
