diff options
Diffstat (limited to 'doc/manual/en_US/man_VBoxManage-cloudlist.xml')
-rw-r--r-- | doc/manual/en_US/man_VBoxManage-cloudlist.xml | 142 |
1 files changed, 142 insertions, 0 deletions
diff --git a/doc/manual/en_US/man_VBoxManage-cloudlist.xml b/doc/manual/en_US/man_VBoxManage-cloudlist.xml new file mode 100644 index 00000000..91eb8b70 --- /dev/null +++ b/doc/manual/en_US/man_VBoxManage-cloudlist.xml @@ -0,0 +1,142 @@ +<?xml version="1.0" encoding="UTF-8"?> +<!-- + manpage, user manual, usage: VBoxManage cloud list +--> +<!-- + 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-cloudlist" lang="en"> + <refentryinfo> + <pubdate>$Date: 2023-01-17 15:15:46 +0100 (Tue, 17 Jan 2023) $</pubdate> + <title>VBoxManage cloud list</title> + </refentryinfo> + + <refmeta> + <refentrytitle>VBoxManage-cloudlist</refentrytitle> + <manvolnum>1</manvolnum> + </refmeta> + + <refnamediv> + <refname>VBoxManage-cloudlist</refname> + <refpurpose>The cloud list command gives information about some standard entities in the every Cloud + and which can be represented by the list like the list of instances/disk images/networks and etc</refpurpose> + <refclass>Oracle VM VirtualBox</refclass> + </refnamediv> + + <refsynopsisdiv> + <cmdsynopsis id="synopsis-vboxmanage-cloudlist-instances"> <!-- The 'id' is mandatory and must start with 'synopsis-'. --> + <command>VBoxManage cloud</command> + <arg choice="req">--provider=<replaceable>name</replaceable></arg> + <arg choice="req">--profile=<replaceable>name</replaceable></arg> + <arg choice="plain">list</arg> + <arg choice="plain">instances</arg> + <arg>--state=<replaceable>string</replaceable></arg> + <arg>--compartment-id=<replaceable>string</replaceable></arg> + </cmdsynopsis> + <cmdsynopsis id="synopsis-vboxmanage-cloudlist-images"> + <command>VBoxManage cloud</command> + <arg choice="req">--provider=<replaceable>name</replaceable></arg> + <arg choice="req">--profile=<replaceable>name</replaceable></arg> + <arg choice="plain">list</arg> + <arg choice="plain">images</arg> + <arg choice="req">--compartment-id=<replaceable>string</replaceable></arg> + <arg>--state=<replaceable>string</replaceable></arg> + </cmdsynopsis> + </refsynopsisdiv> + + <refsect1> + <title>Description</title> + <refsect2 id="vboxmanage-cloud-common-options"> + <title>Common options</title> + <remark role="help-scope" condition="GLOBAL"/> + <para>The word "cloud" is an umbrella for all commands related to the interconnection with the Cloud. + The following common options must be placed between the "cloud" and the following command, in our case "list":</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-cloudlist-instances"> + <title>cloud list instances</title> + <remark role="help-copy-synopsis"/> + <para> + Displays the list of the instances for a specified compartment. + </para> + <variablelist> + <varlistentry> + <term>--state<replaceable>"running/paused/terminated"</replaceable></term> + <listitem> + <para>The state of cloud instance. The possible states are "running/paused/terminated" at moment. + If the state isn't provided the list of instances with all possible states is returned. + </para> + </listitem> + </varlistentry> + <varlistentry> + <term><option>--compartment-id</option></term> + <listitem> + <para>A compartment is the logical container used to organize and isolate cloud resources. + The different cloud providers can have the different names for this entity. + </para> + </listitem> + </varlistentry> + </variablelist> + </refsect2> + + <refsect2 id="vboxmanage-cloudlist-images"> + <title>cloud list images</title> + <remark role="help-copy-synopsis"/> + <para> + Displays the list of the images for a specified compartment. + </para> + <variablelist> + <varlistentry> + <term>--state<replaceable>"available/disabled/deleted"</replaceable></term> + <listitem> + <para>The state of cloud image. The possible states are "available/disabled/deleted" at moment. + If the state isn't provided the list of images with all possible states is returned. + </para> + </listitem> + </varlistentry> + <varlistentry> + <term><option>--compartment-id</option></term> + <listitem> + <para>A compartment is the logical container used to organize and isolate cloud resources. + The different cloud providers can have the different names for this entity. + </para> + </listitem> + </varlistentry> + </variablelist> + </refsect2> + </refsect1> +</refentry> + |