19.5. The ISO Uploader Tool

19.5.1. The ISO Uploader Tool

Note

The ISO Uploader tool has been deprecated. Red Hat recommends uploading ISO images to the data domain with the Administration Portal or with the REST API. See Section 8.8.1, “Uploading Images to a Data Storage Domain” for details.

The ISO uploader is a tool for uploading ISO images to the ISO storage domain. It is installed as part of the Red Hat Virtualization Manager.

The ISO uploader command is engine-iso-uploader. You must log in as the root user and provide the administration credentials for the Red Hat Virtualization environment to use this command. The engine-iso-uploader -h command displays usage information, including a list of all valid options for the engine-iso-uploader command.

19.5.2. Syntax for the engine-iso-uploader Command

The basic syntax for the ISO uploader command is:

# engine-iso-uploader options list
# engine-iso-uploader options upload file file file

The ISO uploader command supports two actions - list, and upload.

  • The list action lists the ISO storage domains to which ISO files can be uploaded. The Red Hat Virtualization Manager creates this list on the machine on which the Manager is installed during the installation process.
  • The upload action uploads a single ISO file or multiple ISO files separated by spaces to the specified ISO storage domain. NFS is used by default, but SSH is also available.

    Note

    If you use SSH, you are prompted multiple times to enter the SSH user password. You can avoid these prompts by uploading the public SSH key to the iso domain server before uploading an ISO file, and then using the --key-file=KEYFILE option. One way to upload the public SSH key is to use the ssh-copy-id -i ~/.ssh/mykey user@host command.

You must specify one of the above actions when you use the ISO uploader command. Moreover, you must specify at least one local file to use the upload action.

There are several parameters to further refine the engine-iso-uploader command.

General Options

--version
Displays the version of the ISO uploader command.
-h, --help
Displays information on how to use the ISO uploader command.
--conf-file=PATH
Sets PATH as the configuration file the command will to use. The default is /etc/ovirt-engine/isouploader.conf.
--log-file=PATH
Sets PATH as the specific file name the command will use to write log output. The default is /var/log/ovirt-engine/ovirt-iso-uploader/ovirt-iso-uploader_date.log.
--cert-file=PATH
Sets PATH as the certificate for validating the engine. The default is /etc/pki/ovirt-engine/ca.pem.
--insecure
Specifies that no attempt will be made to verify the engine.
--nossl
Specifies that SSL will not be used to connect to the engine.
--quiet
Sets quiet mode, reducing console output to a minimum.
-v, --verbose
Sets verbose mode, providing more console output.
-f, --force
Force mode is necessary when the source file being uploaded has the same file name as an existing file in the destination ISO domain. This option forces the existing file to be overwritten.

Red Hat Virtualization Manager Options

-u USER, --user=USER
Specifies the user whose credentials will be used to execute the command. The USER is specified in the format username@domain. The user must exist in the specified domain and be known to the Red Hat Virtualization Manager.
-r FQDN, --engine=FQDN
Specifies the IP address or fully qualified domain name of the Red Hat Virtualization Manager from which the images will be uploaded. It is assumed that the image uploader is being run from the same machine on which the Red Hat Virtualization Manager is installed. The default value is localhost:443.

ISO Storage Domain Options

The following options specify the ISO domain to which the images will be uploaded. These options cannot be used together; you must used either the -i option or the -n option.

-i, --iso-domain=ISODOMAIN
Sets the storage domain ISODOMAIN as the destination for uploads.
-n, --nfs-server=NFSSERVER
Sets the NFS path NFSSERVER as the destination for uploads.

Connection Options

The ISO uploader uses NFS as default to upload files. These options specify SSH file transfer instead.

--ssh-user=USER
Sets USER as the SSH user name to use for the upload. The default is root.
--ssh-port=PORT
Sets PORT as the port to use when connecting to SSH.
-k KEYFILE, --key-file=KEYFILE
Sets KEYFILE as the private key to use for SSH authentication. If you don’t set a key, you are prompted to enter the password of the user specified by --ssh-user=USER. You must upload the public SSH key to the ISO domain server before uploading an ISO file. One way to do this is to use the ssh-copy-id -i ~/.ssh/mykey user@host command.

19.5.3. Specifying an NFS Server

Example 19.3. Uploading to an NFS Server

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

19.5.4. Basic ISO Uploader Usage

The example below demonstrates the ISO uploader and the list parameter. The first command lists the available ISO storage domains; the admin@internal user is used because no user was specified in the command. The second command uploads an ISO file over NFS to the specified ISO domain.

Example 19.4. List Domains and Upload Image

# engine-iso-uploader list
Please provide the REST API password for the admin@internal oVirt Engine user (CTRL+D to abort):
ISO Storage Domain Name   | Datacenter          | ISO Domain Status
ISODomain                 | Default             | active
# engine-iso-uploader --iso-domain=[ISODomain] upload [RHEL6.iso]
Please provide the REST API password for the admin@internal oVirt Engine user (CTRL+D to abort):

19.5.5. Uploading the VirtIO and Guest Tool Image Files to an ISO Storage Domain

Note

The ISO domain is a deprecated storage domain type. The ISO Uploader tool has been deprecated. Red Hat recommends uploading ISO images to the data domain with the Administration Portal or with the REST API. See Section 8.8.1, “Uploading Images to a Data Storage Domain” for details.

The virtio-win.iso image and Virtual Floppy Drive (VFD) images contain the VirtIO drivers for Windows virtual machines, and RHV-toolsSetup_version.iso contains the Red Hat Virtualization Guest Tools for Windows virtual machines. These image files provide software that you can install on virtual machines to improve performance and usability.

To install and upload the most recent versions of virtio-win and RHV-toolsSetup_version.iso files:

  1. Install the image files on the Manager machine:

    # yum -y install virtio-win rhv-guest-tools-iso*

    After you install them on the Manager machine, these image files are:

    • /usr/share/virtio-win/virtio-win_amd64.vfd (symbolic link)
    • /usr/share/virtio-win/virtio-win_servers_amd64.vfd (symbolic link)
    • /usr/share/virtio-win/virtio-win_servers_x86.vfd (symbolic link)
    • /usr/share/virtio-win/virtio-win_x86.vfd (symbolic link)
    • /usr/share/virtio-win/virtio-win.iso (symbolic link)
    • /usr/share/rhv-guest-tools-iso/RHV-toolsSetup_version.iso

      Note

      The above symbolic links refer to files with versions in their names. When copying them or using a tool like rsync, make sure to copy the target of the symbolic link.

  2. Upload the image files to an ISO storage domain that was not created locally during installation:

    # yum -y install virtio-win rhv-guest-tools-iso*
    # engine-iso-uploader --iso-domain=ISODomain upload  \
        /usr/share/virtio-win/virtio-win_amd64.vfd \
        /usr/share/virtio-win/virtio-win_servers_amd64.vfd \
        /usr/share/virtio-win/virtio-win_servers_x86.vfd \
        /usr/share/virtio-win/virtio-win_x86.vfd \
        /usr/share/virtio-win/virtio-win.iso \
        /usr/share/rhv-guest-tools-iso/RHV-toolsSetup_version.iso
  3. Attach the image files to virtual machines.

The virtual machines can now use the virtio drivers and guest tools.

For information on attaching the image files to a virtual machine, see Installing the Guest Agents, Tools, and Drivers on Windows in the Virtual Machine Management Guide.