- 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 New Version¶
Attention
If you have made modifications to the system (copying images to different places, manually changing configuration files, etc.), back up those changes prior to starting the upgrade. You will need to re-apply those changes after the upgrade has finished.
Before you start, download a copy of the CML controller RPM file to your local machine.
If you already have an installation of Cisco Modeling Labs 2.x, you may be able to upgrade your existing installation to the latest release using the RPM for the new release. Be sure to check the Release Notes for Cisco Modeling Labs to ensure that an in-place upgrade to this release is supported from your current release.
If an in-place upgrade is not supported from your current release, you must migrate to the new release by creating a new installation and migrating your data to the new installation. To create a new installation, follow the instructions for your selected deployment type:
To perform an in-place upgrade, use the following procedure. After the CML update completes, we also recommend upgrading the base OS packages unless you are running an offline or air-gapped CML-Enterprise installation.
Procedure
CML Controller Upgrade - CML UI steps
Log into the CML server UI.
On the Lab Manager page in your CML 2.0 instance, click .
Click the Browse button, and select the RPM that you downloaded to your local system, such as cml2_controller-2.1.0-17.el8.x86_64.rpm or similar.
Click the Upload Image button.
Click on the using Cockpit link to open the System Administration Cockpit.
CML Controller Upgrade - System Administration Cockpit steps
Log into the System Administration Cockpit as the system administrator account. See Logging into the System Administration Cockpit.
In the System Administration Cockpit, click CML2 in the navigation bar on the left side of the page and expand the Controller Software Upgrade item in the Maintenance section.
Offline CML Upgrade
Your CML server must be online and connected to the Internet for the Controller Software Upgrade button to upgrade to the new RPM. If you are using SLR licensing or on-prem licensing and cannot connect your system to the Internet while you perform the upgrade, you must install the RPM from the command line instead.
Click Terminal in the navigation bar on the left side of the page to open a console window to your
CML server and run this dnf command, replacing the <filename> with your RPM file:
sudo dnf install --disablerepo="*" /var/local/virl2/dropfolder/<filename> -y
For example, for the 2.1.0 release, you would replace <filename> with
cml2_controller-2.1.0-17.el8.x86_64.rpm.
Once that command completes, log out of the System Administration Cockpit. Then log into the System Administration Cockpit again and return to the CML2 page.
Skip the next step below and continue with the upgrade process.
In the System Administration Cockpit, click the Upgrade Controller button.
This step takes several minutes, depending on speed of your network connection.
If everything goes well, the log output at the very end should indicate that the upgrade process is done:
Upgrade Log Output¶
If the System Administration Cockpit disconnects during the upgrade, then click the Re-Connect button and check the log output by clicking the Show Log Output button in the Controller Software Upgrade area. The process might still be running in the background, and multiple button clicks/refreshes might be required since the output from the upgrade process will not refresh the browser content due to the previous disconnect.
Refresh the page in your web browser and expand the Controller Software Upgrade item again.
The Controller Software Upgrade area will now have a new message indicating that additional packages need to be installed to complete the upgrade.
In the System Administration Cockpit, click Finish Upgrade.
A confirmation dialog will pop up.
In the System Administration Cockpit, click Upgrade in the confirmation dialog to complete the upgrade and reboot your CML server.
The upgrade should complete with the following message in the log output:
Complete!
*** Turning CPU mitigations off
*** Upgrade complete, rebooting in 10 seconds
Once the upgrade is complete, it will reboot your CML server. Once the reboot is complete, your CML server will be running the new version of the CML software.
We recommend upgrading the base OS in the System Administration Cockpit once the controller upgrade is complete.
Attention
After the upgrade is complete, ensure that all users of the CML server clear their web browser cache before reconnecting to the CML server’s UI.
Upgrading the Base OS - Recommended (online upgrades only)
Log into the System Administration Cockpit as the system administrator account. See Logging into the System Administration Cockpit.
In the System Administration Cockpit, click Services in the navigation bar on the left side of the page.
On the Services page, click the Targets tab at the top of the page.
Scroll to the bottom of the pane in the System Administration Cockpit and click virl2.target.
The System Administration Cockpit will switch to the Services > virl2.target page.
Click on the services menu: the three vertical dots at the end of the CML2 Network Simulation System line.
A menu appears with actions related to the current service target.
Click Stop in the menu to stop the services for this target.
The Status will change to Not Running once the services stop. You can now safely run system updates.
In the System Administration Cockpit, click Software Updates in the navigation bar on the left side of the page.
Once the page refreshes the package list, click the Install All Updates button.
This step may take several minutes to several hours to complete, depending on the speed of your network and the selected CentOS mirror.
The system updates are complete, and your CML server is running the latest packages. If the system requires a reboot after the updates are complete, the page will provide a Restart Now button. If you do not have to reboot after the Software Updates are complete, then be sure to restart the virl2.target.
If a reboot is recommended, click the Restart Now button to restart your CML server.
Your system will reboot, and the virl2.target should start automatically.
Restarting virl2.target - skip these steps if a reboot was required
If a reboot was not required, navigate to in the System Administration Cockpit once the system updates are complete.
The System Administration Cockpit will switch to the Services > virl2.target page.
Click on the services menu: the three vertical dots at the end of the CML2 Network Simulation System line.
A menu appears with actions related to the current service target.
Click Start in the menu to start the services for this target.
The Status will change to Active or Running once the services start.
The upgrade is complete. Your CML server is now running the new release and is ready for use.