.. _Images: Manage Floppy, ISOs and OVA/OVF Images ====================================== ISO --- Installing a guest operating system is a very common task upon VM creation, and in order to reduce deployment time, we have included the ability of mounting an ISO image right after a VM has been created. With this users can power on the VM and start installing the desired OS without remotely mounting the ISO image, which depending of user's bandwidth, could take longer because it has to transmit the ISO file contents to the VM. Public and personal ISO images can be managed with the ``vss-cli compute iso`` command: .. code-block:: bash Usage: vss-cli compute iso [OPTIONS] COMMAND [ARGS]... Available ISO images in both the VSS central store and your personal VSKEY-STOR space. Options: --help Show this message and exit. Commands: personal Browse current user images public Browse public images Public ~~~~~~ Our ISO image catalog is composed by more than 220 ISO images (and growing) stored within our virtual environment to make a faster VM-ISO interaction, where users can pick and choose the most common Linux distributions, Windows, etc. or any other Software like SQL Server. Currently, users can only list and use public ISO images with ``vss-cli compute iso public ls`` and those can be filtered and sorted with including the proper options: .. code-block:: bash Usage: vss-cli compute iso public ls [OPTIONS] List available ISO images in the VSS central store. Filter by name and sort desc. For example: vss-cli compute iso public ls -f name=like,Cent% -s path asc Options: -f, --filter-by ... filter list by , -s, --sort ... sort by -a, --show-all show all results [default: False] -p, --page page results in a less-like format --help Show this message and exit. For instance, to look for a publicly available **Ubuntu 18** image, the command could be something like: .. code-block:: bash vss-cli compute iso public ls -f name=like,ubu%-18% -s path asc path name ---------------------------------------------------------- ---------------------------------- [vss-ISOs] Linux/Ubuntu/ubuntu-18.04.1-desktop-amd64.iso ubuntu-18.04.1-desktop-amd64.iso [vss-ISOs] Linux/Ubuntu/ubuntu-18.04-desktop-amd64.iso ubuntu-18.04-desktop-amd64.iso [vss-ISOs] Linux/Ubuntu/ubuntu-18.04-live-server-amd64.iso ubuntu-18.04-live-server-amd64.iso .. note:: To successfully mount a public ISO to a VM, **Path**, **Name** or **ID** must be added to the VM command. Now that we are familiar with the `iso` command in the **VSS CLI**, we can get the ISO file to mount into a virtual machine. First, we should obtain the VM's UUID: .. note:: This version of the VSS CLI supports managing virtual machines not only using the UUID, but using names. In case of multiple results, the CLI prompts to select the right instance. .. code-block:: bash vss-cli compute vm ls -f name=%ubuntu% uuid name ------------------------------------ ------------------------------ 501257e0-81f5-9c2a-84e5-e900212fef76 1811D-ubuntu 503081c3-6935-8086-683c-0a2b705d9efb 1811D-ubuntu-2 Finally, to submit the change request to mount the ISO, execute ``vss-cli compute vm set cd up -b `` as follows: .. code-block:: bash vss-cli compute vm set ubuntu cd up 1 -b ubuntu-18.04-live-server-amd64.iso Found 2 matches. Please select one: => 501257e0-81f5-9c2a-84e5-e900212fef76 (1811D-ubuntu) 503081c3-6935-8086-683c-0a2b705d9efb (1811D-ubuntu-2) Personal ~~~~~~~~ User provided ISOs can be managed with the ``vss-cli compute iso personal`` command: .. code-block:: bash Usage: vss-cli compute iso personal [OPTIONS] COMMAND [ARGS]... Available ISO images in your personal VSKEY-STOR space. Options: --help Show this message and exit. Commands: ls list personal ISO images sync Sync personal ISO images In order to list or load a user ISO into a VM, users should **upload** the file to `VSKEY-STOR`_ and then execute a ``sync`` command to make the image file available in the ITS Private Cloud. .. note:: Assuming you have already uploaded a file, the command ``vss-cli compute iso personal sync`` should be executed. Once you get a confirmation notification (email or message) ISO images should be visible through the CLI. To list just execute ``vss-cli compute iso personal ls`` and the output should look as follows: .. code-block:: bash vss-cli compute iso personal ls path name --------------------------------------------------------------------------------- --------------------------------------------------------- [vssUser-xfers] jm/isos/CentOS-7-x86_64-NetInstall-1804.iso CentOS-7-x86_64-NetInstall-1804.iso [vssUser-xfers] jm/isos/CentOS-7-x86_64-Minimal-1804.iso CentOS-7-x86_64-Minimal-1804.iso The process of mounting the image to a VM is the same: first get the VM UUID and then execute ``vss-cli compute vm set cd up -b `` as shown below: .. code-block:: bash vss-cli compute vm set 501257e0-81f5-9c2a-84e5-e900212fef76 cd up 1 -b CentOS-7-x86_64-NetInstall-1804.iso # or with name search vss-cli compute vm set ubuntu cd up 1 -b CentOS-7 Found 2 matches. Please select one: => 501257e0-81f5-9c2a-84e5-e900212fef76 (1811D-ubuntu) 503081c3-6935-8086-683c-0a2b705d9efb (1811D-ubuntu-2) Found 2 matches. Please select one: CentOS-7-x86_64-NetInstall-1804.iso => CentOS-7-x86_64-Minimal-1804.iso .. note:: Every time a new ISO image file has been added or removed from your `VSKEY-STOR`_ account, please run ``vss-cli compute iso personal sync`` to update your account records. Virtual Machine --------------- The ITS Private Cloud API has the ability to deploy OVA or OVF virtual machines from either our public repository or an Open Virtualization Format file provided by a user and uploaded to `VSKEY-STOR`_, either for a single or multiple deployments. Public and personal VM images can be managed with the ``vss-cli compute image`` command: .. code-block:: bash Usage: vss-cli compute image [OPTIONS] COMMAND [ARGS]... Available OVA/OVF images in both the VSS central store and your personal VSKEY-STOR space. Options: --help Show this message and exit. Commands: personal Browse current user images public Browse public images Public ~~~~~~ The public repository holds an OVA catalog of common linux distributions such as Ubuntu, VMware PhotonOS and CoreOS optimized for cloud deployment. Currently, users can only list and use public VM images with ``vss-cli compute image public ls`` and those can be filtered and sorted with including the proper options: .. code-block:: bash Usage: vss-cli compute image public ls [OPTIONS] List available OVA/OVF VM images in the VSS central store. Filter by name and sort desc. For example: vss-cli compute image public ls -f name=like,Cent% -s path asc Options: -f, --filter-by ... filter list by , -s, --sort ... sort by -a, --show-all show all results [default: False] -p, --page page results in a less-like format --help Show this message and exit. For instance, to look for a publicly available **Photon OS** image, the command could be something like: .. code-block:: bash vss-cli compute image public ls -f name=like,%photon% -s path asc path name ---------------------------------------------------------------- ---------------------------------- [vss-ISOs] VmImages/photon-os/photon-custom-hw11-2.0-304b817.ova photon-custom-hw11-2.0-304b817.ova [vss-ISOs] VmImages/photon-os/photon-custom-hw13-2.0-304b817.ova photon-custom-hw13-2.0-304b817.ova .. note:: To successfully deploy a VM from a public VM image, **Path** should be added to the VM command. For further instructions on how to deploy a virtual machine from image, please refer to :doc:`Deploy Instance from Image `. Personal ~~~~~~~~ User provided VM images can be managed with the ``vss-cli compute image personal`` command: .. code-block:: bash Usage: vss-cli compute image personal [OPTIONS] COMMAND [ARGS]... Available OVA/OVF VM images in your personal VSKEY-STOR space. Options: --help Show this message and exit. Commands: ls list personal OVA/OVF VM images sync Sync personal OVA/OVF VM images In order to deploy a VM from a provided VM image, users should **upload** the file to `VSKEY-STOR`_ and then execute a ``sync`` command to make the image file available in the ITS Private Cloud. .. note:: Assuming you have already uploaded the OVA file or OVF+Disks (VMDKs), the command ``vss-cli compute image personal sync`` should be executed. Once you get a confirmation notification (email or message) VM images should be visible through the CLI. To list just execute ``vss-cli compute image personal ls`` and the output should look as follows: .. code-block:: bash vss-cli compute image personal ls path name --------------------------------------------------------------------------------------- --------------------------------------- [vssUser-xfers] jm/images/photon-custom-hw10-1.0-13c08b6-GA.ova photon-custom-hw10-1.0-13c08b6-GA.ova [vssUser-xfers] jm/images/CentOS_64-bit_vmx10.ova CentOS_64-bit_vmx10.ova [vssUser-xfers] jm/images/graylog-2.1.2-1.ova graylog-2.1.2-1.ova [vssUser-xfers] jm/images/wily-server-cloudimg-amd64.ova wily-server-cloudimg-amd64.ova [vssUser-xfers] jm/images/photon-custom-hw10-1.0-13c08b6.ova photon-custom-hw10-1.0-13c08b6.ova For further instructions on how to deploy a virtual machine from image, please refer to :doc:`Deploy Instance from Image `. Floppy ------ In some operating systems, such as the most recent versions of Windows, you need to provide the device drivers to properly recognize basic devices like the **VMXNET3** network adapter or **Paravirtual SCSi controllers**. These drivers are provided by VMware and now, they are available for you to use on demand by the ``floppy`` command ``vss-cli compute floppy``. .. code-block:: bash Usage: vss-cli compute floppy [OPTIONS] COMMAND [ARGS]... Available floppy images in both the VSS central store and your personal VSKEY-STOR space. Options: --help Show this message and exit. Commands: personal Browse current user images public Browse public images Public ~~~~~~ Currently, users can only list and use public Floppy images with ``vss-cli compute floppy public ls`` and those can be filtered and sorted with including the proper options: .. code-block:: bash Usage: vss-cli compute floppy public ls [OPTIONS] List available Floppy images in the VSS central store. Filter by path or name path= or name=. For example: vss-cli compute floppy ls -f name=like,pv% -s path asc Options: -f, --filter-by ... filter list by , -s, --sort ... sort by -a, --show-all show all results [default: False] -p, --page page results in a less-like format --help Show this message and exit. For instance, to look for a **Windows** drivers image, the command should be something like: .. code-block:: bash vss-cli compute floppy public ls -f name=like,%Windows% path name -------------------------------------------- ---------------------- [] /vmimages/floppies/pvscsi-Windows2008.flp pvscsi-Windows2008.flp [] /vmimages/floppies/pvscsi-Windows2003.flp pvscsi-Windows2003.flp [] /vmimages/floppies/pvscsi-WindowsXP.flp pvscsi-WindowsXP.flp The process of mounting the image to a VM is the same: first get the VM UUID and then execute ``vss-cli compute vm set floppy --image `` as shown below: .. code-block:: bash vss-cli compute vm set 501257e0-81f5-9c2a-84e5-e900212fef76 floppy 1 --image "[] /vmimages/floppies/pvscsi-Windows2008.flp" Personal ~~~~~~~~ The ``floppy`` command resource also provides available ``.flp`` images from your `VSKEY-STOR`_ space, so you are free to upload any custom floppy image and mount it to a Virtual Machine. User provided VM images can be managed with the ``vss-cli compute floppy personal`` command: .. code-block:: bash Usage: vss-cli compute floppy personal [OPTIONS] COMMAND [ARGS]... Available Floppy images in your personal VSKEY-STOR space. Options: --help Show this message and exit. Commands: ls list personal Floppy images sync Sync personal Floppy images In order to list or load a user Floppy into a VM, users should **upload** the file to `VSKEY-STOR`_and then execute a ``sync`` command to make the image file available in the ITS Private Cloud. .. note:: Assuming you have already uploaded a file, the command ``vss-cli compute floppy personal sync`` should be executed. Once you get a confirmation notification (email or message) Floppy images should be visible through the CLI. To list just execute ``vss-cli compute floppy personal ls`` and the output should look as follows: .. code-block:: bash vss-cli compute floppy personal ls path name -------------------------------------- ---------- [vssUser-xfers] jm/floppies/pvscsi.flp pvscsi.flp The process of mounting the image to a VM is the same: first get the VM UUID and then execute ``vss-cli compute vm set floppy --image `` as shown below: .. code-block:: bash vss-cli compute vm set 501257e0-81f5-9c2a-84e5-e900212fef76 floppy 1 --image "[vssUser-xfers] jm/floppies/pvscsi.flp" .. note:: Every time a new floppy image file has been added or removed from your `VSKEY-STOR`_ account, please run ``vss-cli compute floppy personal sync`` to update your account records. .. _`VSKEY-STOR`: https://vskey-stor.eis.utoronto.ca