190 lines
8.1 KiB
XML
190 lines
8.1 KiB
XML
<?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>
|
|
|