%all.entities; ]> $Date: 2022-03-03 11:54:06 +0000 (Thu, 03 Mar 2022) $ VBoxManage-cloud 1 &product-name; VBoxManage-cloud Manage the cloud entities &product-name; VBoxManage cloud --provider=name --profile=name list instances --state=string --compartment-id=string VBoxManage cloud --provider=name --profile=name list images --compartment-id=string --state=string 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 --cloud-init-script-path=path to a script 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 VBoxManage cloud --provider=name --profile=name image create --display-name=name --bucket-name=name --object-name=name --instance-id=unique id VBoxManage cloud --provider=name --profile=name image info --id=unique id VBoxManage cloud --provider=name --profile=name image delete --id=unique id VBoxManage cloud --provider=name --profile=name image import --id=unique id --bucket-name=name --object-name=name VBoxManage cloud --provider=name --profile=name image export --id=unique id --display-name=name --bucket-name=name --object-name=name VBoxManage cloud --provider=name --profile=name network setup --gateway-os-name=string --gateway-os-version=string --gateway-shape=string --tunnel-network-name=string --tunnel-network-range=string --proxy=string --compartment-id=string VBoxManage cloud --provider=name --profile=name network create --name=string --network-id=string --enable --disable VBoxManage cloud network update --name=string --network-id=string --enable --disable VBoxManage cloud network delete --name=string VBoxManage cloud network info --name=string The word "cloud" is an umbrella for all commands related to the interconnection with the Cloud. 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. Displays the list of the instances for a specified compartment. --state"running/paused/terminated" 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. --compartment-id 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. Displays the list of the images for a specified compartment. --state"available/disabled/deleted" 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. --compartment-id 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. 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, 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-nameCloud domain where new instance is created. --image-idUnique identifier which fully identifies a custom image in the Cloud. --boot-volume-idUnique identifier which fully identifies a boot volume in the Cloud. --display-nameName 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. --publicipWhether the instance will have a public IP or not. --privateipPrivate 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-modeThe most known values here may be EMULATED, NATIVE, PARAVIRTUALIZED. --cloud-init-script-pathAbsolute path to the user cloud-init script. Display information about a cloud instance with a specified id. --idUnique identifier which fully identify the instance in the Cloud. Delete a cloud instance with a specified id. --idUnique identifier which fully identify the instance in the Cloud. Start a cloud instance with a specified id. --idUnique identifier which fully identify the instance in the Cloud. Pause a cloud instance with a specified id. --idUnique identifier which fully identify the instance in the Cloud. Creates new image in the Cloud. There are two standard ways to create an image in the Cloud: 1. Create an image from an object in the Cloud Storage; 2. Create an image from an existing cloud instance. For the 1st approach next parameters are required: bucket-name - cloud bucket name where an object is located; object-name - name of object in the bucket; display-name - name for new image in the Cloud. For the 2d approach next parameters are required: instance-id - Id of instance in the Cloud; display-name - name for new image in the Cloud. --display-nameName for new image in the Cloud. --bucket-nameCloud bucket name where an object is located. --object-nameName of object in the bucket. --instance-idUnique identifier which fully identifies the instance in the Cloud. Display information about a cloud image with a specified id. --idUnique identifier which fully identifies the image in the Cloud. Delete an image with a specified id from the Cloud. --idUnique identifier which fully identifies the image in the Cloud. Import an image with a specified id from the Cloud to a local host. The result is an object in the local "temp" folder on the local host. Possible approach may have two general steps: 1. Create an object from an image in the Cloud Storage; 2. Download the object to the local host. So the next parameters may be required: bucket-name - cloud bucket name where the object will be created; object-name - name of object in the bucket. if parameter "object-name" is absent a displayed image name is used. If the first step isn't needed only the parameter "id" is required. --idUnique identifier which fully identifies the image in the Cloud. --bucket-nameCloud bucket name where an object will be created. --object-name Name of created object in the bucket. The downloaded object will have this name. Export an existing VBox image with a specified uuid from a local host to the Cloud. The result is new image in the Cloud. Possible approach may have two general steps: 1. Upload VBox image to the Cloud Storage; 2. Create an image from the uploaded object. So the next parameters may be required: bucket-name -cloud bucket name where the object will be uploaded; object-name - name of object in the bucket. If parameter "object-name" is absent the image id is used; display-name - name for new image in the Cloud. If the first step isn't needed the parameters "id" and "display-name" are required only. --idUnique identifier of the image in the VirtualBox. --display-nameName for new image in the Cloud. --bucket-nameCloud bucket name where the image (object) will be uploaded. --object-nameName of object in the bucket. Set up a cloud network environment for the specified cloud profile. --gateway-os-nameThe name of OS to use for a cloud gateway. --gateway-os-versionThe version of OS to use for a cloud gateway. --gateway-shapeThe instance shape to use for a cloud gateway. --tunnel-network-nameThe name of VCN/subnet to use for tunneling. --tunnel-network-rangeThe IP address range to use for tunneling. --proxyThe proxy URL to be used in local gateway installation. --compartment-idThe compartment to create the tunnel network in. Create a new cloud network descriptor associated with an existing cloud subnet. --nameThe name to assign to the cloud network descriptor. --network-idThe unique identifier of an existing subnet in the cloud. --enable, --disable Whether to enable the network descriptor or disable it. If not specified, the network will be enabled. Modify an existing cloud network descriptor. --nameThe name of an existing cloud network descriptor. --network-idThe unique identifier of an existing subnet in the cloud. --enable, --disable Whether to enable the network descriptor or disable it. Delete an existing cloud network descriptor. --nameThe name of an existing cloud network descriptor. Display information about a cloud network descriptor. --nameThe name of an existing cloud network descriptor.