7.46. VBoxManage cloud instance

Manage the cloud instances.

7.46.1. Synopsis

VBoxManage cloud {--provider=name} {--profile=name} instance create {--domain-name=name} {{--image-id=id} | {--boot-volume-id=id}} {--display-name=name} {--shape=type} {--subnet=id} [--boot-disk-size=size in GB] [--publicip=true/false] [--privateip=IP address] [--public-ssh-key=key string...] [--launch-mode=NATIVE/EMULATED/PARAVIRTUALIZED]

VBoxManage cloud {--provider=name} {--profile=name} instance info {--id=unique id}

VBoxManage cloud {--provider=name} {--profile=name} instance terminate {--id=unique id}

VBoxManage cloud {--provider=name} {--profile=name} instance start {--id=unique id}

VBoxManage cloud {--provider=name} {--profile=name} instance pause {--id=unique id}

7.46.2. Description

7.46.2.1. Common options

The subcommands of cloudinstance 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:

--provider=name

Short cloud provider name.

--profile=name

Cloud profile name.

7.46.2.2. cloud instance create

VBoxManage cloud {--provider=name} {--profile=name} instance create {--domain-name=name} {{--image-id=id} | {--boot-volume-id=id}} {--display-name=name} {--shape=type} {--subnet=id} [--boot-disk-size=size in GB] [--publicip=true/false] [--privateip=IP address] [--public-ssh-key=key string...] [--launch-mode=NATIVE/EMULATED/PARAVIRTUALIZED]

Creates new instance in the Cloud. There are two standard ways to create an instance in the Cloud: 1. Create an instance from an existing custom image. 2. Create an instance from an existing bootable volume. This bootable volume shouldn't be attached to any instance. For the 1st approach next parameters are required: image-id and boot-disk-size. For the 2nd approach next parameters are required: boot-volume-id; The rest parameters are common for both cases: display-name, launch-mode, subnet-id, publicIP, privateIP, shape, domain.

--domain-name

Cloud domain where new instance is created.

--image-id

Unique identifier which fully identifies a custom image in the Cloud.

--boot-volume-id

Unique identifier which fully identifies a boot volume in the Cloud.

--display-name

Name for new instance in the Cloud.

--shape

The shape of instance, defines the number of CPUs and RAM memory.

--subnet

Unique identifier which fully identifies an existing subnet in the Cloud which will be used by the instance.

--boot-disk-size

The size of bootable image in GB. Default is 50GB.

--publicip

Whether the instance will have a public IP or not.

--privateip

Private IP address for the created instance.

--public-ssh-key

Public SSH key used to connect to the instance via SSH. This parameter may be repeated if you plan to use more than one key as: "--public-ssh-key=firstSSHKey --public-ssh-key=secondSSHKey".

--launch-mode

The most known values here may be EMULATED, NATIVE, PARAVIRTUALIZED.

7.46.2.3. cloud instance info

Display information about a cloud instance with a specified id.

--id

Unique identifier which fully identify the instance in the Cloud.

7.46.2.4. cloud instance termination

Delete a cloud instance with a specified id.

--id

Unique identifier which fully identify the instance in the Cloud.

7.46.2.5. cloud instance start

Start a cloud instance with a specified id.

--id

Unique identifier which fully identify the instance in the Cloud.

7.46.2.6. cloud instance pause

Pause a cloud instance with a specified id.

--id

Unique identifier which fully identify the instance in the Cloud.