Cisco Catalyst Center 3.x Upgrade
Upgrade scenarios
Review and complete the upgrade scenario that applies to your deployment.
Scenario 1: Upgrade a single or three-node Catalyst Center cluster
Summary
Catalyst Center 3.1.5 introduces a new architecture that provides
- improved network automation and monitoring
- optimized resource utilization, and
- increased security.
Workflow
To upgrade to this new architecture and migrate your existing network data, you need to complete the Catalyst Center 3.x upgrade workflow:
Catalyst Center 3.x upgrade prerequisites
Hardware
-
Ensure you are upgrading one of these Catalyst Center appliances:
To determine your appliance's part number, view the Product Name field in Cisco IMC's Summary page.Machine profile alias
Cisco part number Number of cores medium
Second-generation:
- DN2-HW-APL
- DN2-HW-APL-U (promotional)
44
Third-generation:
- DN3-HW-APL
- DN3-HW-APL-U (promotional)
32
large
Second-generation:
- DN2-HW-APL-L
- DN2-HW-APL-L-U (promotional)
56
Third-generation:
- DN3-HW-APL-L
- DN3-HW-APL-L-U (promotional)
extra large
Second-generation:
- DN2-HW-APL-XL
- DN2-HW-APL-XL-U (promotional)
112
Third-generation:
- DN3-HW-APL-XL
- DN3-HW-APL-XL-U (promotional)
80
-
Although Cisco IMC firmware versions 4.1 and later are supported, we recommend that you install these versions:
- DN2 appliances: 4.3(2.240077)
- DN3 appliances: 4.3(5.250030)
- Confirm that the Cisco IMC interface is properly configured for your appliances and is accessible.
- Review and resolve any critical hardware alerts detected by Cisco IMC.
- Enable the Cisco Redfish API on all cluster nodes to perform necessary hardware configuration. See Step 4 in Verify Cisco IMC settings.
Catalyst Center
-
Ensure that one of the following versions of Catalyst Center is installed on the appliance you'll be upgrading from:
- 2.3.7.7.70047
- 2.3.7.7-70047-CSCwn89323.SMU
- 2.3.7.9.70301
- 2.3.7.9.70301.10
- 2.3.7.10.70209
- Verify that all Catalyst Center services are operational and healthy.
- Ensure that at least 120 GB of disk space is available in the /data/maglev/srv/ndp and /data directories.
- Check that no critical operations (such as backups or upgrades) are currently running.
- Ensure that NTP is configured on your system.
- Confirm that your Catalyst Center appliances are healthy and do not have any services that are down.
- For three-node HA clusters, confirm that each cluster node is healthy and HA is active.
Back up and restore
- Confirm that Catalyst Center backups are configured correctly for both automation and Assurance.
-
Configure NFS for Assurance backups, even if you don't plan to take full backups for both automation and Assurance.
Note
Catalyst Center 3.1.5 requires NFS for automation backups.
- Verify that the settings for your NFS and remote servers, such as IP addresses and directory paths, are correct.
- Verify that the NFS shared directory has adequate space (at least twice the size of the latest backup) for data conversion during backup.
- Ensure that a backup taken within the past five days is available.
Required information
Have this information ready before completing the Catalyst Center 3.x upgrade wizard:
- Catalyst Center admin superuser login credentials (only users configured with the SUPER-ADMIN-ROLE can perform the upgrade)
- Cisco IMC login credentials
- Backup encryption passphrase
Unsupported Catalyst Center appliances and features
- DN1 (first-generation) Catalyst Center appliances
- IPv6
- Catalyst Center virtual appliances
Complete preupgrade tasks
Summary
You must complete these tasks before you upgrade to the new Catalyst Center architecture:
Workflow
Verify Cisco IMC settings
Step 1 | Log in to Cisco IMC. The Summary page opens. | ||||||||||||||||||
Step 2 | Confirm that the part number for your Catalyst Center appliance (listed in the Product Name field) matches one of part numbers listed in the Catalyst Center 3.x upgrade prerequisites' "Hardware" table. | ||||||||||||||||||
Step 3 | Confirm that a supported Cisco IMC version is installed:
| ||||||||||||||||||
Step 4 | Verify that the Redfish API is enabled:
| ||||||||||||||||||
Step 5 | Confirm that the your appliance's virtual drives are named correctly:
|
Back up your appliance
Complete these steps to back up your Catalyst Center appliance.
Any backup files you created before installing the Platform Upgrade package may be marked as incompatible after this package is installed.
Step 1 | From the main menu, choose and then click the Configure Settings tab. |
Step 2 | Confirm that both a remote host and NFS server are already configured for backup and restore operations.
|
Step 3 | Back up your appliance:
|
Install the Catalyst Center 3.x package
To upgrade to the new Catalyst Center architecture, first install the Catalyst Center 3.x package.
Step 1 | From the main menu, choose to open the Software Management page. |
Step 2 | Confirm that the Release 3.1.5-75246 is available heading is displayed at the top of page. |
Step 3 | Click Install now. You can click the More details link to open a slide-in pane that indicates the progress of the applications that are being installed. |
Step 4 | Confirm that the package installed successfully:
|
Complete the Catalyst Center 3.x Upgrade wizard
Catalyst Center facilitates the upgrade to its new architecture by providing the Catalyst Center 3.x upgrade wizard. Complete this wizard to convert your existing network data and adjust your current configurations to align with the new architecture.
The upgrade procedure is essentially the same for both single-node and three-node Catalyst Center clusters. The differences are minor and described where necessary.
Before you begin
- Review the Catalyst Center 3.x upgrade prerequisites and confirm that they have been met.
- Install the Catalyst Center 3.x package.
Step 1 | Start the Catalyst Center 3.x upgrade wizard:
| ||||||||||||||
Step 2 | Complete the Catalyst Center 3.x upgrade wizard:
| ||||||||||||||
Step 3 | Start the Catalyst Center 3.x upgrade.
|
Configuration examples
This topic provides examples of configurations you must make after upgrading to the new Catalyst Center platform.
Backup server configuration (Ubuntu)
$ rsync --version
rsync version 3.2.7 protocol version 31
$ localectl list-locales | grep -i c.utf
C.UTF-8
$ dpkg -s openssh-server
Package: openssh-server
Status: install ok installed
Create a user account
$ sudo useradd -m cc-backup
(-m option to add a home folder. The backup user account must have a home
folder for the migration to complete successfully.)
$ sudo passwd cc-backup
Create directory structure
$ sudo mkdir -p /data/automation/cluster1/
$ sudo mkdir -p /data/assurance/cluster1/
$ sudo chown -R cc-backup:cc-backup /data
$ sudo chown -R nobody:nogroup /data/assurance
Configure NFS
$ sudo apt-get update
$ sudo apt-get install -y nfs-kernel-server
$ sudo nano /etc/exports
Add the following line:
/data/assurance/cluster1 *(rw,sync,no_subtree_check, all_squash)
$ sudo exportfs -a
$ sudo systemctl start nfs-server
Allow Catalyst Center backup and restore operations through a firewall (Ubuntu)
sudo ufw status
$ sudo nano /etc/default/nfs-kernel-server
$ RPCMOUNTDOPTS="--manage-gids --port 32767"
$ sudo ufw allow 22
$ sudo ufw allow portmapper 111
$ sudo ufw allow nfs 2049
$ sudo ufw allow 32767
Relevant APIs
The APIs described in this topic provide telemetry information. Whenever you make these API calls, they return data for the period of time between this call and the previous time you made these calls:
- TOKEN=$(curl -s -X POST -H 'content-type: application/json' http://lauth.iam.svc.cluster.local:8001/api/system/v1/auth/token -u admin | jq -r .Token)
- jwt="x-auth-token:$TOKEN"
- curl -H $jwt http://launcher-app-service.sys-ops:8000/api/v1/launcher-app-service/telemetry/migration
- curl -H $jwt http://launcher-app-service.sys-ops:8000/api/v1/launcher-app-service/telemetry/execution
- curl -H $jwt http://launcher-app-service.sys-ops:8000/api/v1/launcher-app-service/telemetry/execution-task
Purpose | API call |
---|---|
View current migration ID |
|
View reconfiguration status |
curl http://launcher-app-service.sys-ops:8000/api/v1/launcher-app-service/migrations/$migrationId/reconfiguration/status |
View restoration status |
curl -H $jwt http://system-orchestrator.sys-ops.svc.cluster.local:8011/api/v1/system-orchestrator/backups/executions |
View collected configuration details |
curl http://launcher-app-service.maglev-system:8000/api/v1/launcher-app-service/migrations/$migrationId/configurations |
Fallback options
This topic describes the options that are available if you completed the Catalyst Center 3.x upgrade and find yourself in one of these situations:
- You need to delay your deployment's upgrade to Catalyst Center 3.x.
- You experienced a catastrophic failure that requires a reimage of your Catalyst Center appliance.
Option 1: Revert back to Catalyst Center 2.3.7.x
To revert to the Catalyst Center 2.3.7.x version that was installed on your appliance, which runs on the previous platform, complete these steps:
- Install the Catalyst Center 2.3.7.x version that was installed on your appliance previously, as well as its corresponding packages.
- If you performed a full backup previously, revert the transformed Assurance backup file to the earlier format.
- Configure the original backup location for the automation backup.
- Configure NFS for the Assurance backup.
- Restore the backup.
Option 2: Proceed with the Catalyst Center 3.x upgrade
To continue using the new platform, complete these steps:
- Install Catalyst Center 3.1.5.
- Restore the transformed backup file. Specify the NFS directory location in its NFS backup configuration.
Upgrade considerations
- Do not create a full backup after you have started the upgrade.
- Your current backup schedule is not migrated. You must configure the backup schedule after the upgrade completes.
- CLI-based tuning changes, such as disabling older ciphers and TLS versions, are not captured and carried forward.
- Complete the Catalyst Center upgrade in one sitting to prevent the loss of configuration changes that are not picked up in a backup.
Reference
Scenario 2: Upgrade an air-gapped deployment to Catalyst Center 3.x
In this scenario, you are upgrading an air-gapped deployment to Catalyst Center 3.x.
Step 1 | Raise a request with the Cisco TAC. A representative gives you access and instructions for downloading the binary image from a Cisco file server. The air gap binary image includes the Catalyst Center 3.x upgrade package and 3.1.5 ISO image. | ||||||
Step 2 | Enable the appropriate air gap mode.
| ||||||
Step 3 | Deploy the air gap binary image by entering the maglev catalog airgap install uber-dnac-x-airgap.bin command. The Catalyst Center 3.x upgrade package and 3.1.5 ISO image are installed. | ||||||
Step 4 |
Scenario 3: Upgrade a disaster recovery deployment to Catalyst Center 3.x
In this scenario, you are upgrading your disaster recovery deployment to Catalyst Center 3.x.
Before you begin
-
Ensure that your disaster recovery system's main site is the current active site.
Important
This requirement is critical for a successful upgrade
- When reenabling your disaster recovery system after the upgrade, ensure that you set the correct Catalyst Center cluster as the main site. Otherwise, you will lose all data.
Step 1 | Prepare your cluster for the Catalyst Center 3.x upgrade:
|
Step 2 | Complete the Catalyst Center 3.x Upgrade wizard.
|
Step 3 | Reenable disaster recovery:
|
Scenario 4: Upgrade from a physical appliance to a virtual appliance
In this scenario, you are migrating your existing network data from a physical Catalyst Center appliance to a virtual appliance running Catalyst Center 3.1.5 on ESXi.
Before you begin
- Configure a virtual appliance running Catalyst Center 3.1.5 on ESXi. See the Cisco Catalyst Center 3.1.x on ESXi Deployment Guide.
-
Confirm you are upgrading from a medium appliance that's running one of these Catalyst Center versions:
- 2.3.7.7.70047
- 2.3.7.7-70047-CSCwn89323.SMU
- 2.3.7.9.70301
- 2.3.7.9.70301.10
- 2.3.7.10.70209
- Ensure that a backup server is configured for automation data, and that an NFS server is configured for Assurance data. NFS is mandatory for the migration of backup files from physical Catalyst Center appliances.
Step 1 | Start the Catalyst Center 3.x upgrade wizard:
| ||||||||||||||
Step 2 | Complete the Catalyst Center 3.x upgrade wizard:
| ||||||||||||||
Step 3 | Start the Catalyst Center 3.x upgrade.
|
Scenario 5: Upgrade to Catalyst Center 3.1.5 on ESXi
In this scenario, you are upgrading your Catalyst Center 2.3.7.x on ESXi deployment to Catalyst Center 3.1.5 on ESXi.
Step 1 | Back up your Catalyst Center 2.3.7.x on ESXi deployment. In the Cisco Catalyst Center Administrator Guide, complete the steps described in the "Create a backup" topic. |
Step 2 | Shut down Catalyst Center 2.3.7.x on ESXi. |
Step 3 | Configure a new Catalyst Center 3.1.5 on ESXi virtual appliance with the same network settings as your previous virtual appliance. |
Step 4 | Configure the same NFS settings you used for Catalyst Center 2.3.7.x on ESXi. In the Cisco Catalyst Center Administrator Guide, complete the steps described in these topics:
|
Step 5 | Restore the backup you created in Step1. In the Cisco Catalyst Center Administrator Guide, complete the steps described in the "Restore data from backups" topic. |
Scenario 6: Restore Catalyst Center 3.1.3 data
In this scenario, you are migrating your Catalyst Center 3.1.3 data to an appliance that has Catalyst Center 3.1.5 installed.
Step 1 | Confirm that you have enough space to store your backups after upgrading to Catalyst Center 3.1.5. In the Cisco Catalyst Center Administrator Guide, see the "Backup storage requirements" topic. |
Step 2 | Back up your Catalyst Center 3.1.3 deployment. In the Cisco Catalyst Center Administrator Guide, complete the steps described in the "Create a backup" topic. |
Step 3 | Install Catalyst Center 3.1.5 on your appliance. |
Step 4 | Add the NFS server that Catalyst Center will use to store backups of your data. In the Cisco Catalyst Center Administrator Guide, complete the steps described in the "Add the NFS server" topic. |
Step 5 | Configure where you want Catalyst Center to store backups, using the same location that was configured for Catalyst Center 3.1.3. In the Cisco Catalyst Center Administrator Guide, complete the steps described in the "Configure the location to store backup files" topic. |
Step 6 | Restore the backup you created in Step 2. In the Cisco Catalyst Center Administrator Guide, complete the steps described in the "Restore data from backups" topic. |