From f215e02bf85f68d3a6106c2a1f4f7f063f819064 Mon Sep 17 00:00:00 2001 From: Daniel Baumann Date: Thu, 11 Apr 2024 10:17:27 +0200 Subject: Adding upstream version 7.0.14-dfsg. Signed-off-by: Daniel Baumann --- doc/manual/en_US/man_VBoxManage-cloud.xml | 708 ++++++++++++++++++++++++++++++ 1 file changed, 708 insertions(+) create mode 100644 doc/manual/en_US/man_VBoxManage-cloud.xml (limited to 'doc/manual/en_US/man_VBoxManage-cloud.xml') diff --git a/doc/manual/en_US/man_VBoxManage-cloud.xml b/doc/manual/en_US/man_VBoxManage-cloud.xml new file mode 100644 index 00000000..897f9118 --- /dev/null +++ b/doc/manual/en_US/man_VBoxManage-cloud.xml @@ -0,0 +1,708 @@ + + + + +%all.entities; +]> + + + $Date: 2023-05-16 18:12:21 +0200 (Tue, 16 May 2023) $ + VBoxManage cloud + + + + 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 + + list + vnicattachments + --compartment-id=string + --filter=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 + + instance + reset + --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 + + + + + Description + + + + Common options + + 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. + + + + + + + cloud list instances + + + 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. + + + + + + + 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. + + + + + + + + cloud list images + + + 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. + + + + + + + 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. + + + + + + + + cloud list vnic attachments + + + Displays the list of the vnic attachments for a specified compartment. + + + + --filter"instanceId/vnicId/domainName=string" + + Filters are used to narrow down the set of Vnic attachments of interest. + This parameter is repeatible. + The possible filters are "instanceId" or "vnicId" or "availabilityDomain" at moment. + The form is "instanceId/vnicId/domainName=[string value]" and can be repeated. + In instance, "--filter instanceId=ocid1.instance.oc1.iad.anuwcl...js6 + --filter vnicId=ocid1.vnic.oc1.iad.abuwcl...jsm + --filter domainName=ergw:US-ASHBURN-AD-2". + But in most cases, this is redundant and one filter is enough. + If the filter isn't provided the whole list of vnic attachments for a specified compartment is returned. + + + + + + + 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. + + + + + + + + + cloud instance create + + + 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. + + + + Cloud domain where new instance is created. + + + Unique identifier which fully identifies a custom image in the Cloud. + + + Unique identifier which fully identifies a boot volume in the Cloud. + + + Name for new instance in the Cloud. + + + The shape of instance, defines the number of CPUs and RAM memory. + + + Unique identifier which fully identifies an existing subnet in the Cloud which will be used by the instance. + + + The size of bootable image in GB. Default is 50GB. + + + Whether the instance will have a public IP or not. + + + Private IP address for the created instance. + + + + + 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". + + + + + The most known values here may be EMULATED, NATIVE, PARAVIRTUALIZED. + + + Absolute path to the user cloud-init script. + + + + + + cloud instance info + + Display information about a cloud instance with a specified id. + + + + Unique identifier which fully identify the instance in the Cloud. + + + + + + cloud instance termination + + Delete a cloud instance with a specified id. + + + + Unique identifier which fully identify the instance in the Cloud. + + + + + + cloud instance start + + Start a cloud instance with a specified id. + + + + Unique identifier which fully identify the instance in the Cloud. + + + + + + cloud instance pause + + Pause a cloud instance with a specified id. + + + + Unique identifier which fully identify the instance in the Cloud. + + + + + + cloud instance reset + + Force reset a cloud instance with a specified id. + + + + Unique identifier which fully identify the instance in the Cloud. + + + + + + + cloud image create + + + 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. + + + + Name for new image in the Cloud. + + + Cloud bucket name where an object is located. + + + Name of object in the bucket. + + + Unique identifier which fully identifies the instance in the Cloud. + + + + + + cloud image info + + + Display information about a cloud image with a specified id. + + + + Unique identifier which fully identifies the image in the Cloud. + + + + + + cloud image delete + + + Delete an image with a specified id from the Cloud. + + + + Unique identifier which fully identifies the image in the Cloud. + + + + + + cloud image import + + + 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. + + + + Unique identifier which fully identifies the image in the Cloud. + + + Cloud bucket name where an object will be created. + + + + + + Name of created object in the bucket. The downloaded object will have this name. + + + + + + + + cloud image export + + + 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. + + + + Unique identifier of the image in the VirtualBox. + + + Name for new image in the Cloud. + + + Cloud bucket name where the image (object) will be uploaded. + + + Name of object in the bucket. + + + + + + + + cloud network setup + + + Set up a cloud network environment for the specified cloud profile. + + + + The name of OS to use for a cloud gateway. + + + The version of OS to use for a cloud gateway. + + + The instance shape to use for a cloud gateway. + + + The name of VCN/subnet to use for tunneling. + + + The IP address range to use for tunneling. + + + The proxy URL to be used in local gateway installation. + + + The compartment to create the tunnel network in. + + + + + + cloud network create + + + Create a new cloud network descriptor associated with an existing cloud subnet. + + + + The name to assign to the cloud network descriptor. + + + The unique identifier of an existing subnet in the cloud. + + + , --disable + Whether to enable the network descriptor or disable it. If not specified, + the network will be enabled. + + + + + + cloud network update + + + Modify an existing cloud network descriptor. + + + + The name of an existing cloud network descriptor. + + + The unique identifier of an existing subnet in the cloud. + + + , --disable + Whether to enable the network descriptor or disable it. + + + + + + cloud network delete + + + Delete an existing cloud network descriptor. + + + + The name of an existing cloud network descriptor. + + + + + + cloud network info + + + Display information about a cloud network descriptor. + + + + The name of an existing cloud network descriptor. + + + + + + + + -- cgit v1.2.3