C.3. ISO Uploader

The Red Hat Enterprise Virtualization Manager installation includes a tool for uploading ISO images to the ISO storage domain. This tool is referred to as the ISO uploader. It provides for the listing of storage domains and uploading of ISO files to them.

The ISO uploader command is rhevm-iso-uploader. You must be logged in as the root user to run it successfully. You must provide the administration credentials for the Red Hat Enterprise Virtualization environment on the command line. Full usage information, including a list of all valid options for the command, is available by running the rhevm-iso-uploader -h command.

C.3.1. Syntax

The basic syntax is of the form:

Usage: rhevm-iso-uploader [options] list
       rhevm-iso-uploader [options] upload [file].[file]...[file]

The two supported modes of operation are list, and upload.

The list parameter lists the available ISO storage domains. These storage domains are the valid targets for ISO uploads. By default the list is obtained from the Red Hat Enterprise Virtualization Manager installation on the local machine.
The upload parameter uploads the selected ISO file(s) to the specified ISO storage domain. By default the transfer is performed using NFS however SSH is also available.

Basic ISO uploader usage requires that, at a minimum, the either the list or upload parameter is provided. Where upload is selected then the name of at least one local file to upload must also be provided.

The rhevm-iso-uploader command has a large number of options.

General Options

--version: Displays the version number of the command in use, and exits immediately.
-h, --help: Displays command usage information, and exits immediately.
--quiet: Sets quiet mode, reducing console output to a minimum. This is off by default.
--log-file=PATH: Sets PATH as the log file the command should use for its own log output.
--conf-file=PATH: Sets PATH as the configuration file the command should use.
-v, --verbose: Sets verbose mode, providing more console output. This is off by default.
-f, --force: Where the source file being uploaded has the same file name as an existing file at the destination, force the existing file to be overwritten automatically. This is off by default.

Red Hat Enterprise Virtualization Manager Options

The options in the Red Hat Enterprise Virtualization Manager configuration group are used to specify the manager authentication details and, filter log collection from one or more virtualization hosts. If no options in this group are specified, data is not collected from any virtualization host.

-u USER, --user=USER: Sets the user as USER. This must be a user that exists in directory services, and is known to the Red Hat Enterprise Virtualization Manager. The user must be specified in the format user@domain, where user replaced by the username, and domain is replaced by the directory services domain in use.
-r FQDN, --rhevm=FQDN: Sets the Red Hat Enterprise Virtualization Manager to connect to as FQDN. FQDN must be replaced by the fully qualified domain name of the manager. By default it is assumed that the ISO uploader is being run on the same machine as the manager. Therefore the default value for this parameter is localhost.

ISO Storage Domain Options

The options in this configuration group are used to specify the ISO domain to which files must be uploaded

-i, --iso-domain=ISODOMAIN

Sets the storage domain named ISODOMAIN as the destination for uploads.

-n, --nfs-server=NFSSERVER

Sets the NFS path NFSSERVER as the destination for uploads. This option is an alternative to --iso-domain, the two must not be used at the same time.

Example C.8. Specifying an NFS Server

# rhevm-iso-uploader --nfs-server=storage.demo.redhat.com:/iso/path upload RHEL6.0.iso

Connection Options

By default the ISO uploader uses NFS to upload files. Use options within this configuration group to use SSH file transfer instead.

--ssh-user=USER: Sets USER as the SSH username to use for the upload.
--ssh-port=PORT: Sets PORT as the port to use when connecting to SSH.
-k KEYFILE, --key-file=KEYFILE: Sets KEYFILE as the public key to use for SSH authentication. If no key is set the program will prompt you to enter the password of the user specified instead.