B.3.2. Syntax for the engine-image-uploader Command

⁠B.3.2. Syntax for the engine-image-uploader Command

The basic syntax for the image uploader command is:

engine-image-uploader [options] list
engine-image-uploader [options] upload [file].[file]...[file]

The two supported modes of operation are list and upload.

The list parameter lists the valid export storage domains available for image uploads.
The upload parameter uploads selected image file(s) to the specified image storage domain.

The image uploader command requires either the list or upload parameter be included for basic usage. The upload parameter requires a minimum of one local file name to upload.

There are numerous parameters to further refine the engine-image-uploader command. You can set defaults for any of these in the /etc/ovirt-engine/imageuploader.conf file.

General Options

-h, --help: Displays command usage information and returns to prompt.
--conf-file=PATH: Sets PATH as the configuration file the tool is to use. The default is etc/ovirt-engine/imageuploader.conf.
--log-file=PATH: Sets PATH as the specific file name the command should use for the log output.
--quiet: Sets quiet mode, reducing console output to a minimum. Quiet mode is off by default.
-v, --verbose: Sets verbose mode, providing more console output. Verbose mode is off by default.
-f, --force: Force mode is necessary when the source file being uploaded has an identical file name as an existing file at the destination; it forces the existing file to be overwritten. Force mode is off by default.

Red Hat Enterprise Virtualization Manager Options

-u USER, --user=USER: Sets the user associated with the file to be uploaded. The USER is specified in the format user@domain, where user is the user name and domain is the directory services domain in use. The user must exist in directory services and be known to the Red Hat Enterprise Virtualization Manager.
-r FQDN, --rhevm=FQDN: Sets the fully qualified domain name of the Red Hat Enterprise Virtualization Manager server from which to upload images, where FQDN is replaced by the fully qualified domain name of the Manager. It is assumed that the image uploader is being run on the same client machine as the Red Hat Enterprise Virtualization Manager; the default value is localhost:443.

Export Storage Domain Options

These options specify the export domain to which files are uploaded. They are alternatives; do not use these parameters together.

-e, --export-domain=EXPORT_DOMAIN: Sets the storage domain EXPORT_DOMAIN as the destination for uploads.
-n, --nfs-server=NFSSERVER: Sets the NFS path NFSSERVER as the destination for uploads.
-i, --ovf-id: Use this option if you do not want to update the UUID of the image. By default, the tool will generate a new UUID for the image. This ensures that there is no conflict between the id of the incoming image and those already in the environment.
-d, -disk-instance-id: Use this option if you do not want to rename the instance ID for each disk (i.e. InstanceId) in the image. By default, this tool will generate new UUIDs for disks within the image to be imported. This ensures that there are no conflicts between the disks on the imported image and those within the environment.
-m, --mac-address: Use this option if you do not want to remove the network components from the image that will be imported. By default, this tool will remove any network interface cards from the image to prevent conflicts with network cards on other virtual machines within the environment. Once the image has been imported, use the Administration Portal to add network interface cards back and the Manager will ensure that there are no MAC address conflicts.
-N NEW_IMAGE_NAME, --name=NEW_IMAGE_NAME: Supply this option if you want to rename the image.

See Also:

Report a bug