- Overview
- Product Documentation
- CML Release Notes
- Getting Started
- CML 2.1 User Guide
- CML User's Guide
- Overview of CML 2.x
- Using CML and the HTML5 UI
- Dashboard
- Workbench
- Adding Nodes to a Lab
- Starting, Stopping, and Wiping Nodes
- Deleting Nodes
- Creating Links
- Rules for Creating Links and Interface Overprovisioning
- Adding Interfaces and Overprovisioning
- Overprovisioning Interfaces with Link Creation
- Starting Simulations
- Connecting to a Node's Console
- Setting CPU limit on node
- Launch sequencing and CPU limiting
- Stopping Simulations
- External Connectivity for Simulations
- Link Packet Capture
- Breakout Tool
- Custom VM Images
- Creating a New Node Definition
- CML 2.1 Admin Guide
- Resources
Upgrading to CML 2.1¶
Upgrading from Previous Releases¶
You may use the CML 2.1 RPM file to upgrade a CML 2.0.x installation to CML 2.1. In-place upgrades from older releases, such as 1.6, to the 2.1 release are not supported. If you have an existing 1.x installation of CML or Cisco VIRL Personal Edition, you will have to migrate to a new installation of CML 2.1.
Users and Labs¶
Existing users on your CML 2.0 installation will be preserved by the RPM upgrade. Existing labs will also be preserved, but keep in mind that CML 2.x saves the state of each node in a lab when you stop the lab. The state of a node is associated with a particular node definition and image definition. We refer to the virtualized versions of Cisco network operating systems, such as IOSv, as reference platforms.
Reference Platforms¶
The reference platform ISO file provides the node definitions and image definitions available on your CML server. Since a lab’s saved state refers to specific versions of the reference platform images, you should not remove an image from your CML server if any lab is using that VM image. The easiest way to ensure that existing labs continue to run after upgrade is to continue using the old reference platform ISO from your existing installation even after upgrading to CML 2.1. With CML 2.0, you were mounting the refplat-20200409-fcs.iso file on your CML VM as a CD/DVD drive. After upgrading to the 2.1 release, continue to use that same reference platform ISO file to ensure that all nodes across all labs still have the associated reference platform image available.
Caution
Changing the reference platform ISO on an existing or upgraded CML instance may cause a loss of data. Nodes in existing labs may fail to start or may end up in an inconsistent state that cannot be fixed unless you wipe the entire lab.