Preparing Custom Images

Procedure


From the Dashboard select Tools ‣ Node and Image Definitions.

Select Image Definitions.

Click Manage.

Upload and select a VM image file.

Click on the field and locate a local VM image file to upload.

Click the Upload Image button.

Alternatively, upload an image to the CML server via scp.

New images are displayed under the Uploaded Images section. Click Refresh to update the list.

Click Create New Image Definition.

Enter values for the image definition’s fields.

ID

Each image on the system must have a unique ID.

Label

The label appears in the node’s image selection drop-down list in the Workbench and generally indicates the VM image’s OS name and version, such as IOSv 15.6(3).

Description

This optional field can provide a longer description of the image.

Disk Image

Select the image that you uploaded from the list.

Node Definition

Select the appropriate node definition to be associated with selected image.

Note

The fields below depend on the inheritance settings of the selected Node Definition. You only need to provide values for these properties if the new image requires different defaults than the values on the associated node definition. These properties will be used for the VM of any node that use this image unless the property is also set on the node itself.

Memory (MiB)

The amount of memory in megabytes that this image requires. Refer to your device’s installation and configuration documentation to choose the correct value.

CPUs

The number of virtual CPUs allocated to VMs created from this image. Refer to your device’s installation and configuration documentation to choose the correct value.

CPU Limit

The percentage of the allocated CPUs that VMs created from this image will be allowed to usee. You should normally use a value of 100% unless you need to adjust the launch sequencing to boot additional nodes. See also Setting CPU limit on node.

Data Disk Size (GiB)

The size of the data disk required by this image in gigabytes (if any). Refer to your device’s installation and configuration documentation to choose the correct value. The data disk is an additional disk that is added to the virtual device. Some devices need a second disk to store databases or other information. An example is the SD-WAN manager that stores it’s database on the second disk.

Boot Disk Size (GiB)

The size of the boot disk required by this image in gigabytes (if any). Refer to your device’s installation and configuration documentation to choose the correct value. The boot disk is typically the disk that holds the operating system and that is marked bootable.

Click Create Image Definition.


A new image is created with the image properties from the form. It is now available for use in your labs.