source: vbox/trunk/doc/manual/en_US/man_VBoxManage-cloudinstance.xml@ 79877

<?xml version="1.0" encoding="utf-8"?>
<!--
    manpage, user manual, usage: VBoxManage cloud instance

    Copyright (C) 2018 Oracle Corporation

    This file is part of VirtualBox Open Source Edition (OSE), as
    available from http://www.virtualbox.org. This file is free software;
    you can redistribute it and/or modify it under the terms of the GNU
    General Public License (GPL) as published by the Free Software
    Foundation, in version 2 as it comes in the "COPYING" file of the
    VirtualBox OSE distribution. VirtualBox OSE is distributed in the
    hope that it will be useful, but WITHOUT ANY WARRANTY of any kind.
 -->
<refentry id="vboxmanage-cloudinstance" lang="en">

  <refentryinfo>
    <pubdate>$Date: 2019-07-19 09:26:18 +0000 (Fri, 19 Jul 2019) $</pubdate>
    <title>VBoxManage cloud instance</title>
  </refentryinfo>

  <refmeta>
    <refentrytitle>VBoxManage-cloudinstance</refentrytitle>
    <manvolnum>1</manvolnum>
  </refmeta>

  <refnamediv>
    <refname>VBoxManage-cloudinstance</refname>
    <refpurpose>Manage the cloud instances</refpurpose>
    <refclass>Oracle VM VirtualBox</refclass>
  </refnamediv>

  <refsynopsisdiv>
    <cmdsynopsis id="synopsis-vboxmanage-cloudinstance-info" sepchar=" ">
      <command moreinfo="none">VBoxManage cloud</command>
      <arg choice="req" rep="norepeat">--provider=<replaceable>name</replaceable></arg>
      <arg choice="req" rep="norepeat">--profile=<replaceable>name</replaceable></arg>
      <arg choice="plain" rep="norepeat">instance</arg>
      <arg choice="plain" rep="norepeat">info</arg>
      <arg choice="req" rep="norepeat">--id=<replaceable>unique id</replaceable></arg>
    </cmdsynopsis>
    <cmdsynopsis id="synopsis-vboxmanage-cloudinstance-terminate" sepchar=" ">
      <command moreinfo="none">VBoxManage cloud</command>
      <arg choice="req" rep="norepeat">--provider=<replaceable>name</replaceable></arg>
      <arg choice="req" rep="norepeat">--profile=<replaceable>name</replaceable></arg>
      <arg choice="plain" rep="norepeat">instance</arg>
      <arg choice="plain" rep="norepeat">terminate</arg>
      <arg choice="req" rep="norepeat">--id=<replaceable>unique id</replaceable></arg>
    </cmdsynopsis>
    <cmdsynopsis id="synopsis-vboxmanage-cloudinstance-start" sepchar=" ">
      <command moreinfo="none">VBoxManage cloud</command>
      <arg choice="req" rep="norepeat">--provider=<replaceable>name</replaceable></arg>
      <arg choice="req" rep="norepeat">--profile=<replaceable>name</replaceable></arg>
      <arg choice="plain" rep="norepeat">instance</arg>
      <arg choice="plain" rep="norepeat">start</arg>
      <arg choice="req" rep="norepeat">--id=<replaceable>unique id</replaceable></arg>
    </cmdsynopsis>
    <cmdsynopsis id="synopsis-vboxmanage-cloudinstance-pause" sepchar=" ">
      <command moreinfo="none">VBoxManage cloud</command>
      <arg choice="req" rep="norepeat">--provider=<replaceable>name</replaceable></arg>
      <arg choice="req" rep="norepeat">--profile=<replaceable>name</replaceable></arg>
      <arg choice="plain" rep="norepeat">instance</arg>
      <arg choice="plain" rep="norepeat">pause</arg>
      <arg choice="req" rep="norepeat">--id=<replaceable>unique id</replaceable></arg>
    </cmdsynopsis>
  </refsynopsisdiv>

  <refsect1>
    <title>Description</title>

    <refsect2 id="vboxmanage-cloudinstance-common-options">
      <title>Common options</title>
      <remark role="help-scope" condition="GLOBAL"/>
      <para>The subcommands of <command>cloudinstance</command> implement the standard operations for a cloud instance
        like start/pause/show/terminate. 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-cloudinstance-info">
      <title>cloud instance info</title>
      <para>
        Display information about a cloud instance with a specified id.
      </para>
      <variablelist>
        <varlistentry>
          <term><option>--id</option></term><listitem><para>Unique identifier which fully identify the instance in the Cloud.</para></listitem>
        </varlistentry>
      </variablelist>
    </refsect2>

    <refsect2 id="vboxmanage-cloudinstance-terminate">
      <title>cloud instance termination</title>
      <para>
        Delete a cloud instance with a specified id.
      </para>
      <variablelist>
        <varlistentry>
          <term><option>--id</option></term><listitem><para>Unique identifier which fully identify the instance in the Cloud.</para></listitem>
        </varlistentry>
      </variablelist>
    </refsect2>

    <refsect2 id="vboxmanage-cloudinstance-start">
      <title>cloud instance start</title>
      <para>
        Start a cloud instance with a specified id.
      </para>
      <variablelist>
        <varlistentry>
          <term><option>--id</option></term><listitem><para>Unique identifier which fully identify the instance in the Cloud.</para></listitem>
        </varlistentry>
      </variablelist>
    </refsect2>

    <refsect2 id="vboxmanage-cloudinstance-pause">
      <title>cloud instance pause</title>
      <para>
        Pause a cloud instance with a specified id.
      </para>
      <variablelist>
        <varlistentry>
          <term><option>--id</option></term><listitem><para>Unique identifier which fully identify the instance in the Cloud.</para></listitem>
        </varlistentry>
      </variablelist>
    </refsect2>
  </refsect1>
</refentry>