Manage ISOs

OnApp allows uploading your custom bootable ISOs for recovery purposes. These could be different images for Windows/Linux/FreeBSD or any additional software. As a cloud administrator, you can limit user's ability to upload and manage ISOs by permissions and in buckets. You can boot virtual servers from your own ISOs or the ISOs that are uploaded and made publicly available by other users. The default maximum size for uploading ISOs from the file system is 1 GB, this value can be changed at Control Panel > Settings > Configuration > Max upload size in bytes. There are no space limitations for the ISOs uploaded form the URL (except for your disk space limitations).


  • OnApp supports rebooting existing virtual and smart servers from ISO. 
  • To build a new server from an ISO, create a server using the creation wizard and then reboot this VS from the appropriate ISO.
  • As soon as you boot a VS from the installation ISO, OnApp cannot control any VS components (backups, networks, disks).
  • Be aware that all the contents of the disk might be deleted if a VS is booted from the ISO that installs a new distributive.
  • If you boot a VS from an ISO with the RAM requirement larger than the VS's RAM, the transaction will fail.
  • If your cloud deployment is not a fresh installation, make sure that permissions on ISOs are enabled. For more info, refer to List of all OnApp Permissions.


You can upload your own ISOs and make them available to all users of the cloud (the way the templates work in OnApp). After the ISO is uploaded, it is possible to select the Boot from ISO option on VS management screen.

View ISOs


To view the ISOs available to you:

  1. Go to Control Panel and click Templates.
  2. Select ISO list from the menu that expands. 
  3. The page that loads, will show the list of ISOs available to you separated into four tabs:
    • All ISOs - the list of all ISOs available on your system
    • System ISOs - the list of the ISOs that are publicly available to all users
    • My ISOs - the list of custom ISOs uploaded by the user who is currently logged in
    • User ISOs - the list of  the ISOs uploaded by your users

For each ISO listed, you see the following details displayed:

  • log status - the status of the last log item of the ISO (complete/pending/failed). Click the status to view the log details for the ISO (available to the ISOs that were uploaded through an URL).

  • OS - the icon that indicates the operating system of the ISO
  • Label - the name of the ISO
  • Min memory size - the minimum RAM size required for the ISO
  • Operating systems - the operating system on the ISO
  • Virtualization - the virtualization type chosen for the ISO
  • Actions - click the Actions icon to perform the following procedures with the ISO:
    • Edit ISO
    • Delete ISO
    • Make Public - only for the images from the My ISOs and User ISOs tabs


Boot from ISO



Share Location Where ISOs are Stored

The default configuration is to upload ISOs on the Control Panel server. Then it is required to mount and share the location where the ISOs are stored at CP with all the compute resources. When the virtual servers are booted from the ISOs, the ISO is taken from the compute resource server. The location is preconfigured at on_app.yml config file which can be found in /onapp/interface/config/on_app.yml.

  • iso_path_on_cp - specifies the location where ISOs are stored on the Control Panel server. By default the location is /data. You can change it to any other suitable location. Make sure that this location is shared with the specified iso_path_on_hv location.
  • iso_path_on_hv - specifies the location where ISOs are located on the compute resource servers. By default the location is /data.  You can change it to any other suitable location with the onapp owner and read/write access. Make sure that this location is mounted to the specified iso_path_on_cplocation.

CloudBoot compute resources mount the /data location automatically at boot to the /onapp/tools/recovery on HV. ISOs can be hosted on a dedicated server at any desired location with an arbitrary name if you wish. In this case it is necessary to mount the ISOs' location on this server to the Control Panel iso_path_on_cp directory and all the compute resources' iso_path_on_hv locations. This can be a backup server to avoid the excess usage of the Control Panel's space.

Enable ISO Permissions

If your cloud deployment is not a fresh installation, make sure to enable the following permissions for your Admin and other roles as appropriate:

  • Any action on ISOs - the user can take any action on ISOs
  • Create a new ISO - the user can create a new ISO
  • Destroy any ISO - the user can delete any ISO (own, user, and public)
  • Destroy own ISO - the user can only delete own ISO 
  • Destroy user ISO - the user can delete ISOs created by any user, but not public ISOs 
  • Make any ISO public - the user can make public any ISO available to all users
  • Make own ISO public - the user can make public own ISOs only
  • Make user ISO public - the user can make public ISOs created by any user 
  • Create and manage own ISOs - the user can create and edit/delete/view own ISOs
  • Manage all ISOs - the user can manage own/user/public ISOs
  • Create and manage user ISOs - the user can view/create/edit/delete ISOs created by any user
  • See all ISOs - the user can view all ISOs in the cloud
  • See own ISOs - the user can only view the ISOs created by themselves
  • See all public ISOs - the user can view all public ISOs
  • See user ISOs - the user can view the ISOs created by any user in the cloud
  • Update any ISO - the user can edit any ISO in the cloud
  • Update own ISO - the user can only edit own ISO
  • Update user ISO - the user can edit  the ISOs created by any user in the cloud

For more info refer to List of all OnApp Permissions.

Upload ISO(s) into the Cloud

Once you've configured the locations for storing ISOs, you can add a new ISO to the system. You can upload files only in the .iso extension.

To upload an ISO file, follow the next steps:

  1. Go to your Control Panel and click the Templates menu from the left navigation pane.
  2. Select ISO list from the menu that expands. 
  3. On the page that loads, click the Upload ISO button at the bottom of the screen.
  4. Choose the ISO to upload and fill its details:
    • Make public - move the slider to the right if you want to make the ISO publicly available
    • Allowed hot migrate - move the slider to the right if you want to be able to hot-migrate VS created from this ISO
    • Label - choose a name for the ISO
    • Version - fill in the version of the ISO
    • Min disk size - specify the minimum required disk size for the ISO (1 GB by default)
    • Min memory size - specify the minimum required RAM for the ISO (128 MB by default)
    • Operating system - choose the operating system of the ISO
    • Operating system distro - fill in the operating system distribution of the ISO in free form
    • Virtualization - tick the required virtualization type(s): XEN, KVM or KVM+Virtio
  5. Click Next. On the page that appears, click File or File Url tab depending on the upload method:
    • File - click Choose File to select the required ISO file from your file system. The yellow infobox will show the maximum file size for ISOs. The max upload size is pre-configured at Settings > Configuration (the Max upload size in bytes). Click the Upload ISO button.
    • File URL - select this tab if you want to upload the ISO from URL and specify the link from which the ISO will be uploaded. 
  6. Click Save to upload the ISO. 

After you upload an ISO to the cloud, it can be found at Templates > ISO List > My ISOs tab. The ISOs uploaded by your users are under the User ISOs tab.

Make ISO(s) Public

By default ISOs are available only to those users who uploaded them. These ISO images are available in the My ISOs tab. To make your ISO public and accessible for all users:

  1. Go to your Control Panel's Templates > ISO List menu.
  2. Click My ISOs tab.
  3. Click the Actions button next to the ISO you want to make public, then select Make public.
  4. Confirm the window that pops up.

When you make a user ISO public, it is moved to the System ISOs tab.

  • Make sure that you have enabled the Any power action on own virtual servers and Allow own virtual servers to boot from ISO permissions for the user to be able to boot servers from ISO.

  • Note that you should track the Operating System Type option of the compute resource where the current VS lives.  

    • If the compute resource is set to Any, any ISO that has other suitable requirements is available to boot from.

    • If the compute resource has Windows only option enabled, the ISO that has Windows operating system is available for selection.

    • If the compute resource has the Non-Windows option enabled, the ISOs with OSs LInux and FreeBSD are available for selection.

Boot Virtual or Smart Server from ISO

Once you have shared the location where ISOs are stored and uploaded ISOs into the system, you can boot virtual or smart servers from them using the server's power options menu. To boot a virtual/smart server from ISO:

  1. Go to your Control Panel's Virtual Servers/Smart Servers menu.
  2. Click the label of the required server.
  3. Click the Tools button on the server's screen to expand the Tools menu.
  4. Select Boot from ISO. You can boot virtual/smart servers from your own ISOs or the ISOs that are uploaded and made publicly available by other users. If you boot a server from an ISO with the RAM requirement larger than the server's RAM, the transaction will fail.


Upload ISOs



Once you've configured the locations for storing ISOs and enabled the necessary permissions, you can add new ISOs to the system. You can also make your ISOs  public so that other users can boot their virtual servers from the ISOs you have uploaded.

Upload ISO(s) into the Cloud

To upload a file in the .iso extension to your cloud, follow this procedure:

  1. Go to your Control Panel and click the Templates menu from the left navigation pane.
  2. Select ISO list from the menu that expands. 
  3. On the page that loads, click the Upload ISO button at the bottom of the screen.
  4. Choose the ISO to upload and fill its details:
    • Make public - move the slider to the right if you want to make the ISO publicly available
    • Allowed hot migrate - move the slider to the right if you want to be able to hot-migrate VS created from this ISO
    • Label - choose a name for the ISO
    • Version - fill in the version of the ISO
    • Min disk size - specify the minimum required disk size for the ISO (1 GB by default)
    • Min memory size - specify the minimum required RAM for the ISO (128 MB by default)
    • Operating system - choose the operating system of the ISO
    • Operating system distro - fill in the operating system distribution of the ISO in free form
    • Virtualization - tick the required virtualization type(s): XEN, KVM or KVM+Virtio
  5. Click Next. On the page that appears, click File or File Url tab depending on the upload method:
    • File - click Choose File to select the required ISO file from your file system. The yellow infobox will show the maximum file size for ISOs. The max upload size is pre-configured at Settings > Configuration (the Max upload size in bytes). Click the Upload ISO button.
    • File URL - select this tab if you want to upload the ISO from URL and specify the link from which the ISO will be uploaded. 
  6. Click Save to upload the ISO. 

After you upload an ISO to the cloud, it can be found at Templates > ISO List > My ISOs tab. The ISOs uploaded by your users are under the User ISOs tab.

Make ISO(s) Public

By default ISOs are available only to those users who uploaded them. These ISO images are available in the My ISOs tab. To make your ISO public and accessible for all users:

  1. Go to your Control Panel's Templates > ISO List menu.
  2. Click My ISOs tab.
  3. Click the Actions button next to the ISO you want to make public, then select Make public.
  4. Confirm the window that pops up.

When you make a user ISO public, it is moved to the System ISOs tab.


Edit ISOs



To edit the ISOs available to you:

  1. Go to Control Panel and click Templates.
  2. Select ISO list from the menu that expands. The page that loads shows the list of ISOs available to you.
  3. Click the Actions button next to the required ISO and choose Edit ISO.
  4. On the page that loads you can edit the following ISO details:
    • Allowed hot migrate - move the slider to the right if you want to be able to hot-migrate VS created from this ISO
    • label - choose the name for the ISO
    • version - fill in the version of the ISO
    • min disk size - specify the minimum required disk size  for the ISO
    • min memory size - specify the minimum required RAM for the ISO
    • operating system - choose the operating system of the ISO
    • operating system distro - fill in the operating system distribution of the ISO in free form
    • virtualization - tick the required virtualization type(s): XEN, KVM or KVM+Virtio
  5. Click Save.


Delete ISOs



To delete an ISO:

  1. Go to Control Panel and click Templates.
  2. Select ISO list from the menu that expands. The page that loads shows the list of ISOs available to you.
  3. Click the Actions button next to the required ISO and choose Delete ISO.