In this post, I will show how you can update your existing CML2 Personal installation between versions.

Guide Version: 1.0
Last Updated: 2 January 2021
Github Documentation Link: [docx] [pdf]

Important Disclaimer: This document is an unofficial resource that has been created to detail how Cisco Modeling Labs 2 (“CML2”) can be updated to the latest version within a non-production environment. The author recommends planning your production upgrade of CML2 by consulting official Cisco documentation and resources (e.g. Cisco TAC).

By continuing with this document, you automatically acknowledge that ether-net and its author(s) are not responsible for any damages that may arise within your technical environment which may result from the indirect or direct usage of this guide. You also acknowledge that no support or warranties are extended by ether-net should you utilise this document.

 

Table of Contents

  1. Pre-Requisites
  2. Downloading and Verifying CML2 Upgrade Software
  3. Performing an In-place Upgrade for CML2

 

Pre-Requisites

The following pre-requisites must be met before commencing with this guide:

  • An installed and licensed copy of Cisco Modeling Labs 2 (“CML2”)
  • Familiarity with the administration of CML2 and a hypervisor tool (e.g.: VMware, KVM)

 

Downloading and Verifying CML2 Upgrade Software

Section Purpose
Outlines how to download and verify the CML2 upgrade software

Notes

This section can be skipped if you already possess the latest upgrade RPM file.

 

Step 1: In your web browser navigate and log in to the Cisco Learning Network Store and click on the “My Account” link. In your purchase history, locate “Cisco Modeling Labs – Personal” and then click “Download”. You will be taken to the “Software Download” web page for CML2.


Step 2: In the “Software Download” page on the left-hand pane, find the desired version that you wish to upgrade to and then click on it. On the right-hand side of the page scroll down until you find “Cisco Modeling Labs X.X Server – Personal (Upgrade)”. Note that the file size is substantially smaller in comparison to others.


Step 3: Click the download icon to download the file. A new window titled “Cisco’s End User Software License Agreement” will appear. Click “Accept License Agreement” to download the file.


Step 4: Using your mouse, hover over the upgrade that you just downloaded. A details window will appear. Click the clipboard icon to copy the “MD5 Checksum” of the file.

Step 5: Verify the MD5 checksum of the downloaded file against the one copied in Step 4 by executing the below commands in terminal/PowerShell respectively:

  • Linux / MAC: md5 <file_name>
  • Windows: get-filehash -Algorithm MD5 <file_name>

You are now ready to perform an in-place upgrade for CML2, please proceed to the next section.

 

Performing an In-Place Upgrade for CML2

Section Purpose
Details how to complete the upgrade procedure for CML2

Section Pre-Requisites
Completion of the previous section; OR
You must have a valid “Cisco Modeling Labs X.X Server – Personal (Upgrade)” RPM file

IMPORTANT NOTES

  1. Always read the release notes and security advisories associated Cisco software products prior to downloading.
  2. Consider deregistering your product licence in CML2 prior to performing a major release upgrade. This will simplify the process of performing a clean install and relicensing the product should the upgrade catastrophically fail.

 

Step 1: Start your CML2 virtual machine and then log in to the web interface


Step 2: In the top right-hand corner of the web page, hover over the “Tools” menu item and then click on “System Upgrade”.


Step 3: Click on the “Browse” button to select the previously downloaded RPM file.


Step 4: Click on the “Upload Image” button to upload the RPM file to CML2. Once this has completed then click on the “using Cockpit” hyperlink to open Cockpit.

 

Step 5: Log in to Cockpit (aka CentOS) with your CML2 sysadmin credentials. Be sure to check the box “Reuse my password for privileged tasks”.


Step 6: On the main page expand the “Controller Software Upgrade” section and click “Upgrade Controller”. A popup will appear – once you have stopped ALL running labs click the “Upgrade” button to proceed. I recommend clicking the “Show Log Output” so that you can monitor the upgrade procedure.


Step 7: Once the log output states that the upgrade process is completed – refresh the Cockpit page. If a system restart is required post-upgrade you will be notified. Else proceed to Step 8.


Step 8: Access and log into the CML2 web interface – ensure that the version number on this page matches the version number you intended to upgrade to.

 

Step 9: Verify that all CML2 labs are present and recommence labbing!