From 16f504a9dca3fe3b70568f67b7d41241ae485288 Mon Sep 17 00:00:00 2001 From: Daniel Baumann Date: Sun, 7 Apr 2024 18:49:04 +0200 Subject: Adding upstream version 7.0.6-dfsg. Signed-off-by: Daniel Baumann --- doc/manual/en_US/man_VBoxManage-import.xml | 461 +++++++++++++++++++++++++++++ 1 file changed, 461 insertions(+) create mode 100644 doc/manual/en_US/man_VBoxManage-import.xml (limited to 'doc/manual/en_US/man_VBoxManage-import.xml') diff --git a/doc/manual/en_US/man_VBoxManage-import.xml b/doc/manual/en_US/man_VBoxManage-import.xml new file mode 100644 index 00000000..b64f4769 --- /dev/null +++ b/doc/manual/en_US/man_VBoxManage-import.xml @@ -0,0 +1,461 @@ + + + + +%all.entities; +]> + + + $Date: 2022-08-22 19:43:14 +0200 (Mon, 22 Aug 2022) $ + VBoxManage import + + + + VBoxManage-import + 1 + + + + VBoxManage-import + import a virtual appliance in OVF format or from a cloud service and create virtual machines + &product-name; + + + + + + VBoxManage import + + ovfname + ovaname + + --dry-run + --options= + keepallmacs + keepnatmacs + importtovdi + + --vsys=n + --ostype=ostype + --vmname=name + --settingsfile=file + --basefolder=folder + --group=group + --memory=MB + --cpus=n + --description=text + --eula= + show + accept + + --unit=n + --ignore + --scsitype= + BusLogic + LsiLogic + + + --disk=path + --controller=index + --port=n + + + + + VBoxManage import + OCI:// + --cloud + --ostype=ostype + --vmname=name + --basefolder=folder + --memory=MB + --cpus=n + --description=text + --cloudprofile=profile + --cloudinstanceid=id + --cloudbucket=bucket + + + + + Description + + The VBoxManage import command imports a virtual + appliance either in OVF format or from a cloud service such as &oci;. + The import is performed by copying virtual disk images (by default using + the VMDK image format) and by creating virtual machines (VMs) in + &product-name;. See . + + + You must specify the path name of an OVF file or OVA archive to + use as input, or a placeholder for the cloud case. For OVF appliances + ensure that any disk images are in the same directory as the OVF file. + + + Note that any options you specify to control the imported virtual + appliance or to modify the import parameters rely on the contents + of the OVF file or the information from the cloud service. + + + Before you use the import operation to create the VM, perform a + dry run to verify the correctness of your configuration. This is more + useful with an OVF or OVA appliance, because with a cloud service even + a dry run needs to perform most of the time consuming steps. + + + The import from a cloud service downloads a temporary file containing + both the boot image and some metadata describing the details of the + VM instance. The temporary file is deleted after successful import. + + + Common Options + + + ovfname | ovaname + + Specifies the name of the OVF file or OVA archive that + describes the appliance. In the cloud case this is usually + a fixed string such as OCI://. + + + + + + + Performs a dry run of the VBoxManage + import command before you perform the actual + import operation. A dry run operation does the following: + + + Outputs a description of the appliance's contents + based on the specified OVF or OVA file. + + + Shows how the appliance would be imported into + &product-name;. In addition, the output shows any + options that you can use to change the import + behavior. + + + The shortened form of this option is . + + + + + + + Enables you to fine tune the import operation. + + Valid arguments are as follows: + + + keepallmacs: Specifies that the MAC + addresses of every virtual network card are left + unchanged. + + + keepnatmacs: Specifies that the MAC + addresses of every virtual network card are left + unchanged if the network type is NAT. + + + importtovdi: Specifies that all new + disk images are in VDI file format. + + + + + + + Specifies the guest operating system (OS) information for + the VM. Use the VBoxManage list ostypes + command to view the OS type identifiers. + + + + + + Specifies the name of the VM to be used by &product-name;. + + + + + + + Specifies the folder where the files of the imported VM + are stored. + + + + + + Specifies the memory size in Megabytes for the imported VM. + + + + + + Specifies the number of CPUs for the imported VM. + + + + + + Specifies the description text visible in the GUI and + CLI when checking the VM details. + + + + + + + OVF / OVA Import Options + + The following options are specific for importing a virtual appliance + in OVF or OVA format. Such an appliance can contain one or more VMs, + which requires specifying which VM configuration should be adjusted + in case you want to change it. See . + + + + + + + Specifies the index selecting a specific VM within the + appliance. Affects the following options. + + + + + + Specifies the index selecting a specific unit of a VM + within the appliance. Affects the following options. + + + + + + Specifies the name (with or without path) of the VM config + file which will be created as part of the import. Usually + the preferred way is overriding the VM name with + and if necessary specify the + folder in which to create the VM with + . + + + + + + Specifies the primary group of the imported VM. + + + + + + Enables you to show or accept the license conditions of a + VM within the appliance, + + Valid arguments are as follows: + + + show: Shows the EULA of a VM. + + + accepts: Accepts the EULA of a VM. + Any VMs in an appliance which have an EULA require + accepting it, otherwise the import will fail. + + + + + + + Ignores the current unit of an imported VM, effectively + removing the associated hardware. + + + + + + Enables you to select the type of the SCSI controller for + the current unit of an imported VM. + + Valid arguments are as follows: + + + BusLogic: Uses the (very old) BusLogic + SCSI controller type. + + + LsiLogic: Uses the (more modern) + LsiLogic SCSI controller type. + + + + + + + + Cloud Import Options + + The following options are specific for importing a VM instance + from a cloud service provider. It always deals with a single VM. + See . + + + + + + + Specifies that the import should be from the cloud. + + + + + + Specifies the cloud profile which is used to connect to the + cloud service provider. The cloud profile contains your &oci; + account details, such as your user OCID and the fingerprint + for your public key. To use a cloud profile, you must have + the required permissions on &oci;. + + + + + + Specifies the ID of an existing instance in the cloud. + + + + + + Specifies the bucket name in which to store the object created + from the instance. In &oci;, a bucket is a logical container + for storing objects. By default the first bucket available with + the cloud profile is used. + + + + + + + + Examples + + + The following example performs the dry run of an OVF import operation + for a sample appliance that contains a Windows 10 guest: + +$ VBoxManage import Windows10.ovf --dry-run +Interpreting Windows10.ovf... +OK. +Virtual system 0: + 0: Suggested OS type: "Windows10_64" + (change with "--vsys 0 --ostype <type>"; use "list ostypes" to list all) + 1: Suggested VM name "win10-appliance" + (change with "--vsys 0 --vmname <name>") + 2: Suggested VM group "/" + (change with "--vsys 0 --group <group>") + 3: Suggested VM settings file name "/home/user1/VirtualBox VMs/win10-appliance/win10-appliance.vbox" + (change with "--vsys 0 --settingsfile <filename>") + 4: Suggested VM base folder "/home/user1/VirtualBox VMs" + (change with "--vsys 0 --basefolder <path>") + 5: End-user license agreement + (display with "--vsys 0 --eula show"; + accept with "--vsys 0 --eula accept") + 6: Number of CPUs: 1 + (change with "--vsys 0 --cpus <n>") + 7: Guest memory: 2048 MB (change with "--vsys 0 --memory <MB>") + 8: Sound card (appliance expects "ensoniq1371", can change on import) + (disable with "--vsys 0 --unit 8 --ignore") + 9: USB controller + (disable with "--vsys 0 --unit 9 --ignore") +10: Network adapter: orig bridged, config 2, extra type=bridged +11: Floppy + (disable with "--vsys 0 --unit 11 --ignore") +12: SCSI controller, type BusLogic + (change with "--vsys 0 --unit 12 --scsitype {BusLogic|LsiLogic}"; + disable with "--vsys 0 --unit 12 --ignore") +13: IDE controller, type PIIX4 + (disable with "--vsys 0 --unit 13 --ignore") +14: Hard disk image: source image=Windows10.vmdk, + target path=/home/user1/disks/Windows10.vmdk, controller=12;channel=0 + (change target path with "--vsys 0 --unit 14 --disk <path>"; + change controller with "--vsys 0 --unit 14 --controller <index>"; + change controller port with "--vsys 0 --unit 14 --port <n>"; + disable with "--vsys 0 --unit 14 --ignore") + + The dry run output lists and numbers the individual configuration + items that are described in the Windows10.ovf + file. Some of the items include information about how to disable + or change the configuration of the item. + + + You can disable many of the items by using the options. X is the + number of the virtual system. The value is 0 + unless the appliance includes several virtual system descriptions. + Y is the configuration item number. + + + Item 1 in the example command output specifies the name of the + target machine. Items 12 and 13 specify the IDE and SCSI hard disk + controllers, respectively. + + + Item 14 indicates the hard disk image and the + option specifies the target path where the + image will be stored, the option specifies + which controller the disk will be attached to, and the + option specifies which port on the controller the + disk will be attached to. The default values are specified in the OVF file. + + + You can combine several items for the same virtual system by + specifying the same value for the option. + For example use the following command to import a machine as + described in the OVF, exclude the sound card and USB controller + and specify that the disk image is stored with a different name. + +$ VBoxManage import Windows10.ovf --vsys 0 --unit 8 --ignore \ + --unit 9 --ignore --unit 14 --disk Windows10_disk0.vmdk + + The following example illustrates how to import a VM from &oci;. To find + the &oci; VM instances and its ID you can list all available instances + with: + +$ VBoxManage cloud --provider=OCI --profile=cloud-profile-name list instances + + Once you know the ID the following command imports the instance from + &oci;: + +$ VBoxManage import OCI:// --cloud --vmname OCI_FreeBSD_VM --memory 4000 \ + --cpus 3 --ostype FreeBSD_64 --cloudprofile "standard user" \ + --cloudinstanceid ocid1.instance.oc1.iad.abuwc... --cloudbucket myBucket + + -- cgit v1.2.3