Description

This article describes how to edit various aspects of an existing Client Image, or Long-Term Retention Snapshot Image.


Note: The process is common for the following functions between Client Images and Long-Term Retention Images. Just be sure you select the appropriate Image Type in the Image Filter.

  • Reconfigure a Client Image
  • Manage Client Image Tags

Note: The Name of a Client or Long-Term Retention Snapshot Image cannot be changed/modified once it's deployed.

Prerequisites:

  1. Only the Primary Administrator or a User with the Create Image role can manage an existing Client Image.
  2. You must have created a Client Image in order to modify it. See: How to Clone a Cloud Server to Create a Client Image
  3. If setting the IOPS value for a disk with Provisioned IOPS Disk Speed, the IOPS value must fall within the rules for the disk speed in the data center location. See How do I Identify Hardware Specifications and Capabilities Available in a Data Center Location
  4. It is important to note that when reconfiguring an Image's Advanced Virtualization Settings, you may not be able to deploy a Server from an image if the target Cluster does not support the Advanced Virtualization Settings
  5. As of March 31, 2020, you can set an expiration date on Client Images and Long-Term Retention Snapshot Images. If an expiration date is set, the Image will expire on the scheduled date, and be purged from the system. For more information on Long-Term Retention Snapshot Images, see Introduction to Cloud Server Snapshot Long-Term Retention Images

Content / Solution:

How to Edit a Client Image

  1. Click on the Compute button and select Images and Applications from the drop-down menu:


  2. The Images and Applications page will be displayed. Click on the Client Images box under Image Type:


  3. The Client Images page will be displayed. Click on the Image you want to manage from the populated list. Click on the Actions button and select Edit Image from the drop-down menu:


  4. The Edit Image dialog will be displayed:


  5. You can edit various aspects of the Client Image:

    • Expiry Time - Optionally, you can set an expiration date for the Image
      • Image never expires: If this box is checked, the Image will never expire. This is the default setting. You can manually delete the Image. See How to Delete Client and Long-Term Retention Images
        • Note: If the Image is set to never expire, the expiration section will not be displayed
      • Image expires on: You can check this box to set an expiration date for an Image. The system will delete the Image after it expires, or you can manually delete the Image at any time. See How to Delete Client and Long-Term Retention Images
        • Note: Please use the date format of DD-MM-YYYY. The image will expire at 11:59 pm UTC on the specified date
    • Description - Optional description. Must be 255 characters or less
    • CPU Speed - Select a CPU Speed from the drop-down menu
    • Operating System - Select a different Operating System to apply to the Client Image from the drop-down menu. 
      Note: When selecting a new Operating System, it is important to note that the desired OS must be within the same Family (UNIX/WINDOWS)
      and that the desired OS must be within the same OS Units Group. For more information on OS Units, see Introduction to OS Units

      Edit Only Updates CloudControl Metadata

      Note that editing the Operating System of a Client Image will update the CloudControl record of the OS type, which is used by the system in doing Guest OS Customization Deployment. However, edits to this information do NOT make changes to the image record in vCenter, so these changes will not be reflected if the image is exported. 

    • Storage Speed and Disk IOPS - Click on the drop-down icon  next to the SCSI Controller where the disk whose Speed or IOPS you want to manage is located. Select a Disk speed, or new IOPS value from the drop-down menu of the desired disk:

      Note: Available Disk Speeds are: Standard, High Performance, or Economy. See Introduction to Cloud Server Local Storage ("Disks") and Disk Speeds
      Note: You can not set the Disk Speed for ISO/Floppy files. They will always be "Standard" speed. See Introduction to Cloud Server Local Storage ("Disks") and Disk Speeds

  6. Once the desired edits have been made, click the Save button:

    Note: When editing Disk Speed, you can select 'Apply All' from the manage gear to set the speed for all disks on a SCSI controller to the same Speed:

    Note: If you select Apply All for the Provisioned IOPS Disk Speed, you will have to set the IOPS of each disk.

  7. The system will display a success message:


  8. The edits will be applied to the Client Image. Click on the Image again to view change:
     

How to Edit a Long-Term Retention Snapshot Image

  1. Click on the Compute button and select Images and Applications from the drop-down menu:


  2. The Images and Applications page will be displayed. Click on the Long-Term Retention Snapshot Images box under Image Type:


  3. The Long-Term Retention Snapshot Images page will be displayed. Click on the Image you want to manage from the populated list. Click on the Actions button and select Edit Image from the drop-down menu:


  4. The Edit Image dialog will be displayed:


  5. You can edit various aspects of the Client Image:

    • Expiry Time - Optionally, you can set an expiration date for the Image
      • Image never expires: If this box is checked, the Image will never expire. This is the default setting. You can manually delete the Image. See How to Delete Client and Long-Term Retention Images
        • Note: If the Image is set to never expire, the expiration section will not be displayed
      • Image expires on: You can check this box to set an expiration date for an Image. The system will delete the Image after it expires, or you can manually delete the Image at any time. See How to Delete Client and Long-Term Retention Images
        • Note: Please use the date format of DD-MM-YYYY. The image will expire at 11:59 pm UTC on the specified date
    • Description - Optional description. Must be 255 characters or less
    • CPU Speed - Select a CPU Speed from the drop-down menu
    • Operating System- Select a different Operating System to apply to the Client Image from the drop-down menu. 
    • Note: When selecting a new Operating System, it is important to note that the desired OS must be within the same Family (UNIX/WINDOWS)
      and that the desired OS must be within the same OS Units Group. For more information on OS Units, see Introduction to OS Units

      Edit Only Updates CloudControl Metadata

      Note that editing the Operating System of a Client Image will update the CloudControl record of the OS type, which is used by the system in doing Guest OS Customization Deployment. However, edits to this information do NOT make changes to the image record in vCenter, so these changes will not be reflected if the image is exported. 

    • Storage Speed and Disk IOPS - Click on the drop-down icon  next to the SCSI Controller where the disk whose Speed or IOPS you want to manage is located. Select a Disk speed, or new IOPS value from the drop-down menu of the desired disk:

      Note:
       Available Disk Speeds are: Standard, High Performance, or Economy. See Introduction to Cloud Server Local Storage ("Disks") and Disk Speeds
      Note: You can not set the Disk Speed for ISO/Floppy files. They will always be "Standard" speed. See Introduction to Cloud Server Local Storage ("Disks") and Disk Speeds

  6. Once the desired edits have been made, click the Save button:

    Note: When editing Disk Speed, you can select 'Apply All' from the manage gear to set the speed for all disks on a SCSI controller to the same Speed:

    Note: If you select Apply All for the Provisioned IOPS Disk Speed, you will have to set the IOPS of each disk.

  7. The system will display a success message:


  8. The edits will be applied to the Long-Term Retention Snapshot Image. Click on the Image again to view change:

How to Reconfigure a Client Image

  1. Click on the Image you want to reconfigure. Click on the Actions button and select Reconfigure Image from the drop-down menu:


  2. The system will display the Reconfigure Client Image dialog:

    Note: "–No change–" indicates an Advanced Virtualization Setting that is not currently present on the Client Image. If you make a change, the Setting will become available on the Image. If you leave it as "–No Change–", the setting will not be applied to the Client Image

  3. You can reconfigure Advanced Virtualization Settings of the Client Image:

    • Nested Hardware Virtualization - Can be set to True or False
    • CPU Latency Sensitivity - Can be set to Normal or High
    • NUMA Autosize - Can be set to True or False
    • Enable Host Info to VM Tools - Can be set to True or False
  4. Make the desired changes to the Advanced Virtualization Settings, then click Save:


  5. The system will display a message indicating that the operation is in progress:


  6. The system will indicate that the operation is in progress:


  7. Once complete, the system will display a success message:


  8. The Image will be reconfigured:

How to Manage Client Image Tags

  1. Click on the Image whose Tags you want to manage from the populated list. Click on the Actions button and select Manage Client Image Tags from the drop-down menu:
     
     

  2. The system will display the Manage Client Image Tags dialog:


  3. Add the desired Tag Key(s) to the Image:

    Note: For more information on Tagging, see Introduction to Tagging, Tag Keys and Tag Values

  4.  Once you have added the desired Tag Key (and Value if required), click the Add button to apply the Tag to the Image:


  5. Once you have applied the desired Tags to the Image, click the Save button to commit the changes:


  6. The system will display a success message:


  7. The Tag(s) will be applied to the Image. Click on the image to view the Tag:
     

    Note: To remove a Tag from a Client Image, see How to Remove Tags From your Cloud Assets