The documentation set for this product strives to use bias-free language. For the purposes of this documentation set, bias-free is defined as language that does not imply discrimination based on age, disability, gender, racial identity, ethnic identity, sexual orientation, socioeconomic status, and intersectionality. Exceptions may be present in the documentation due to language that is hardcoded in the user interfaces of the product software, language used based on RFP documentation, or language that is used by a referenced third-party product. Learn more about how Cisco is using Inclusive Language.
Cisco EPN Manager 2.1 can only be installed on top of Cisco EPN Manager 2.0.4 or Cisco EPN Manager 2.0.4.2. See Valid Upgrade Paths for valid upgrade paths.
There are two upgrade methods:
The following topics provide prerequisites and procedures for upgrading in standard and high availability deployments:
Note Before starting the upgrade procedure, please review the release notes for important information or issues relating to the installation/upgrade.
Cisco EPN Manager 2.0.4 or Cisco EPN Manager 2.0.4.2 (point patch 2) must be installed before you can upgrade to Cisco EPN Manager 2.1. For information on how to install Cisco EPN Manager 2.0.4, see the Cisco EPN Manager 2.0.4 Installation Guide . For information on how to install Cisco EPN Manager 2.0.4.2, see the readme file supplied with the patch file on the Software Download site on Cisco.com .
The following table lists the installation/upgrade paths for Cisco EPN Manager 2.1.
1. Install Cisco EPN Manager 2.0.4—See Cisco EPN Manager 2.0.4 Installation Guide |
|
1. Install Cisco EPN Manager 2.0.4 PP2 (2.0.4.2)—See the readme file provided with the software on the Software Download site on Cisco.com . |
|
Note Point patches have been provided to address various issues found in Cisco EPN Manager 2.1. It is highly recommended to install the latest available point patch after installing Cisco EPN Manager 2.1. Information about the point patch and installation instructions can be found in the readme file supplied with the patch file on the Software Download site on Cisco.com.
Before starting the upgrade, ensure that:
1. Cisco EPN Manager 2.0.4 or Cisco EPN Manager 2.0.4.2 is installed. For information on how to install Cisco EPN Manager 2.0.4, see the Cisco EPN Manager 2.0.4 Installation Guide . For information on how to install Cisco EPN Manager 2.0.4.2, see the readme file supplied with the patch file on the Software Download site on Cisco.com . For upgrade paths for earlier versions, see Upgrade Options.
2. Your deployment meets the requirements in the relevant prerequisites topic:
– Prerequisites for OVA/VM Installations. For OVA/VM deployments, the upgrade is run from the vmWare vSphere client.
– Prerequisites for ISO/Bare Metal Installations. For ISO/bare metal deployments, the upgrade is run from the Cisco IMC server.
3. Your data is backed up. See Create a Copy of Your Data.
5. SCP is enabled on your client machine, and the required ports are open (see Ports Used by Cisco EPN Manager). You will need to use SCP to copy files from your client machine to the Cisco EPN Manager server.
6. Any gpg files located in /localdisk/defualtRepo are deleted.
Use one of the following options to create a copy of your current data:
1. Back up your data to a remote repository. Refer to the backup topics in the Cisco Evolved Programmable Network Manager User and Administrator Guide . If necessary, you can revert to the previous version by restoring the data. See Revert to the Previous Version using Data Restore.
2. If you are using a virtual machine (VM), take a base snapshot of the VM. Depending on whether you have a high availability (HA) environment or not, follow one of the procedures below. If necessary, you can revert to the previous version using the VM snapshot to restore the data. See Revert to the Previous Version Using the VM Snapshot.
Step 1 Stop Cisco EPN Manager.
Step 2 Suspend the VM and take a VM snapshot. Consult your system administrator for assistance, if necessary.
Step 3 Start Cisco EPN Manager.
Step 1 Remove the HA configuration:
a. Log into the Cisco EPN Manager web GUI as a user with Administrator privileges.
b. From the left sidebar, choose Administration > Settings > High Availability .
c. Click HA Configuration on the left.
e. When the remove operation completes, confirm that the Configuration Mode field displays HA Not Configured .
Step 2 Stop Cisco EPN Manager on the primary and the secondary servers (while logged in as the Cisco EPN Manager CLI admin user.)
Step 3 Pause the VM and take a VM snapshot on both the primary and secondary servers. Consult your system administrator for assistance, if necessary.
Step 4 Start Cisco EPN Manager on the primary and secondary servers.
These topics explain how to upgrade to Cisco EPN Manager 2.1 from an earlier version of Cisco EPN Manager in a standard deployment (no high availability).
If you are performing an upgrade in a high availability deployment, see Upgrade to Cisco EPN Manager 2.1 (High Availability).
Note VMware tools are not updated during the upgrade from an earlier version of Cisco EPN Manager.
In-place upgrade involves upgrading the application to the latest version on the server on which you are currently running Cisco EPN Manager.
In-place upgrade involves the following basic steps which are explained in detail in the procedure below:
1. Download the upgrade image from Cisco.com to your client machine.
2. Copy the files from your client machine to the Cisco EPN Manager server.
4. Perform the post-upgrade licensing, authentication, and web GUI tasks described in Post-Upgrade Tasks.
1. Complete the tasks in Prerequisites for Upgrading to Cisco EPN Manager 2.1.
2. Ensure that there will be enough space for the upgrade files by doing the following:
a. Log in as the as Linux CLI root user as described in Log In and Out as the Linux CLI Users.
b. Run the following command (one line):
c. Log out as the Linux CLI root user.
Step 1 From the Software Download site on Cisco.com , locate and download the upgrade image to your client machine. The file will have the prefix CEPNM-upgrade and the suffix .tar.gz . The numbers in the filename may not align to the current Cisco EPN Manager version, so be sure to check the file description.
Step 2 After the download completes, compare the upgrade image’s size on the Software Download site with its size on your client machine to make sure that the full file was downloaded. On the Software Download site, hover your mouse cursor over the upgrade image to view its MD5 Checksum size in a popup window, then compare it against the size on your client machine.
Step 3 Make sure the /localdisk/defaultRepo directory has enough space to copy the files.
a. Start an SSH session with the Cisco EPN Manager server and log in as the Cisco EPN Manager CLI admin user.
b. Log in as the as Linux CLI root user as described in Log In and Out as the Linux CLI Users.
c. Verify that /localdisk/defaultRepo has enough space using the following command. If it does not, delete all files and directories to free up some space.
Step 4 Use SCP to retrieve the files from your client machine and copy them to the Cisco EPN Manager server’s default local repository (/localdisk/defaultRepo). You should run this command as the Linux CLI root user.
For example (the following command is one line):
Step 5 After the file is transferred to the Cisco EPN Manager server, compare the MD5 Checksum size of the Cisco EPN Manager upgrade image against the value in Step 2 to ensure it has not been damaged.
Step 6 Log out as the Linux CLI root user.
Step 8 From the vmWare vSphere client (OVA) or the Cisco IMC server (Bare Metal):
Upgrade the Cisco EPN Manager software using the upgrade file that is located in /localdisk/defaultRepo.
Where filename is the upgrade file located in /localdisk/defaultRepo . For example:
Step 9 The script will ask you if you want to save the running ADE-OS configuration, and if you want to proceed with the upgrade. Answer yes to both questions.
Please ensure you have a backup of the system before proceeding.
Proceed with the application install ? (yes/no) [yes] ? yes
Step 10 Wait for the upgrade to complete and for Cisco EPN Manager to restart. This could take a few hours.
Perform the tasks in Post-Upgrade Tasks.
Backup-restore upgrade involves backing up all data from the currently installed version of Cisco EPN Manager, then installing Cisco EPN Manager 2.1 on a new server, then restoring the backed up data to the new Cisco EPN Manager 2.1 server. This is the recommended upgrade method.
Step 1 On the new server, install Cisco EPN Manager 2.1 by following the steps in Install Cisco EPN Manager 2.1 (No HA).
Step 2 Configure the new server to use the same remote backup repository as the old server, as explained in the remote backup repository topics in the Cisco Evolved Programmable Network Manager User and Administrator Guide .
Step 3 Restore the backup in the remote repository to the new server, as explained in the restore backup topics in the Cisco Evolved Programmable Network Manager User and Administrator Guide .
Perform the tasks in Post-Upgrade Tasks.
The following topics provide procedures for upgrading to Cisco EPN Manager 2.1 in a high availability deployment:
Note High availability will not be functional until the upgrade is complete.
These are the basic steps of the in-place upgrade procedure:
1. Download the upgrade image from Cisco.com to your client machine.
2. Copy the files from your client machine to the Cisco EPN Manager server.
4. Perform the post-upgrade licensing, authentication, and web GUI tasks described in Post-Upgrade Tasks
Step 1 On the primary server, note the HA configuration, then remove it.
a. Log into Cisco EPN Manager as a user with Administrator privileges.
b. Choose Administration > Settings > High Availability .
c. Make note of the HA configuration. You will need this information to reconfigure HA after the upgrade.
d. Choose HA Configuration in the left navigation area, then click Remove .
e. Wait for the remove operation to complete.
f. Click HA Configuration in the left navigation area and confirm that the Configuration Mode field displays HA Not Configured .
Step 2 From the Software Download site on Cisco.com , locate and download the upgrade image to your client machine. The file will have the prefix CEPNM-upgrade and the suffix .tar.gz . The numbers in the filename may not align to the current Cisco EPN Manager version, so be sure to check the file description.
Step 3 Compare the MD5 Checksum size of the CEPNM upgrade image from the Software Download site against the size on your client machine. On the Software Download site, hover your mouse cursor over the upgrade image to view its size in a popup window, then compare it against the size on your client machine.
Step 4 On the primary server, make sure the /localdisk/defaultRepo directory has enough space to copy the files.
a. Start an SSH session with the primary Cisco EPN Manager server and log in as the Cisco EPN Manager CLI admin user.
b. Log in as the as Linux CLI root user as described in Log In and Out as the Linux CLI Users.
c. Verify that /localdisk/defaultRepo has enough space using the following command. If it does not, delete all files and directories to free up some space.
Step 5 Use SCP to retrieve the files from your client machine and copy them to the Cisco EPN Manager primary server’s default local repository (/localdisk/defaultRepo). You should run this command as the Linux CLI root user.
For example (the following command is one line):
Step 6 After the file is transferred to the primary server, compare the MD5 Checksum size of the Cisco EPN Manager upgrade image against the value in Step 3 to ensure it has not been damaged.
Step 7 On the primary server, log out as the Linux CLI root user.
Step 8 Stop the primary server by running the following command:
Step 9 From the vmWare vSphere client (OVA) or the Cisco IMC server (Bare Metal):
Upgrade the primary server using the upgrade file that is located in /localdisk/defaultRepo.
Where filename is the upgrade file located in /localdisk/defaultRepo. For example:
Step 10 The script will ask you if you want to save the running ADE-OS configuration, and if you want to proceed with the upgrade. Answer yes to both questions.
Save the current ADE-OS running configuration? (yes/no) [yes] ? yes
Please ensure you have a backup of the system before proceeding.
Proceed with the application install ? (yes/no) [yes] ? yes
This step can take 30 minutes or more to complete, depending on the size of the application database. However you can continue with the next step while the upgrade is in progress for the primary server. Once the upgrade is complete, the primary server will be automatically restarted as part of the upgrade.
Step 11 Install Cisco EPN Manager 2.1 on the secondary server (you will perform a fresh installation on this server):
- Launch the VMware vSphere client.
- Select the VM to be deleted and choose Shut Down Guest .
- Select the VM again and choose Delete From Disk .
- Click Yes in the displayed confirmation message.
b. Deploy the OVA from the VMware vSphere Client
c. Install Cisco EPN Manager on the Server
Note (OVA/VM) If you want to retain the same IP address on the secondary server, you must first remove it from the vmWare vSphere client, then use the original address when you deploy the OVA.
Note The installation procedure provided in these sections is specific to the UCS server type and hardware requirements described in Bare Metal Requirements.
a. Configure the Bare Metal Cisco UCS Server
b. Install Cisco EPN Manager on the Server
Step 12 Log into the secondary server as a Cisco EPN Manager CLI admin user and stop and restart the secondary server by running the following commands:
Step 13 Update the time zone for the Compliance engine.
a. Log into the primary server as the Linux CLI root user (see Log In and Out as the Linux CLI Users).
b. Update the time zone using a soft link (the following command is one line):
Step 14 On the primary server:
a. Start the server and then verify that the server is restarted.
b. Run the ncs status command and make sure that the Health Monitor process and other processes have restarted. Ensure that, at a minimum, the following services are up and running: Health Monitor, Database, Matlab, NMS, SAM Daemon, DA Daemon, Compliance Engine. Note that for optimal Cisco EPN Manager functionality, all services should be up and running.
Step 15 On the secondary server:
a. Verify that the server is restarted.
b. Run the ncs status command and make sure that the Health Monitor process and other processes have restarted. Ensure that, at a minimum, the following services are up and running: Health Monitor, Database, Matlab, NMS, SAM Daemon, DA Daemon, Compliance Engine. Note that for optimal Cisco EPN Manager functionality, all services should be up and running.
Step 16 Perform the post-upgrade tasks on the primary server. See Post-Upgrade Tasks.
Step 17 Once the post upgrade tasks are completed, re-configure HA by registering the secondary server on the primary server. Use the information you saved in Step 1. The registration process must be performed from the primary server. For more information, see the section on registering the secondary server on the primary server, in the Cisco Evolved Programmable Network Manager User and Administrator Guide .
For an HA backup-restore upgrade, you will perform the following steps:
2. Back up your data to a remote repository.
3. Perform a fresh installation of Cisco EPN Manager on both the primary and secondary servers.
4. Restore the backup data on the primary server.
Step 1 On the primary server, remove the High Availability configuration:
a. Log into Cisco EPN Manager as a user with Administrator privileges.
b. Choose Administration > Settings > High Availability .
c. Make note of the HA configuration. You will need this information to reconfigure HA after the upgrade.
d. Choose HA Configuration in the left navigation area, then click Remove .
e. Wait for the remove operation to complete.
f. Click HA Configuration in the left navigation area and confirm that the Configuration Mode field displays HA Not Configured .
Step 2 Back up your data to the remote repository. For details, see the topics on backups in the Cisco Evolved Programmable Network Manager User and Administrator Guide .
Note If you do not have a remote repository, configure one. See the topics on remote backup repositories in the Cisco Evolved Programmable Network Manager User and Administrator Guide.
Step 3 Install Cisco EPN Manager 2.1 on the two new servers as described in Install Cisco EPN Manager 2.1 in a High Availability Deployment.
Step 4 Once the installation is completed, configure the new primary server to use the same remote backup repository as the old primary server (which you used in Step 2). See the topics on remote backup repositories in the Cisco Evolved Programmable Network Manager User and Administrator Guide .
Step 5 On the primary server (only), restore the backup from the remote repository. See the topics on restoring data in the Cisco Evolved Programmable Network Manager User and Administrator Guide .
Note You only need to perform the restore operation on the primary server. The secondary server will be synchronized with the primary server when HA is re-enabled.
a. Verify that the server is restarted.
b. Run the ncs status command and make sure that the Health Monitor process and other processes have restarted. Ensure that, at a minimum, the following services are up and running: Health Monitor, Database, Matlab, NMS, SAM Daemon, DA Daemon, Compliance Engine. Note that for optimal Cisco EPN Manager functionality, all services should be up and running.
Step 7 If the ncs status output on the primary server lists Compliance engine is stopped , do the following:
b. Log in as the Linux CLI root user (see Log In and Out as the Linux CLI Users.
c. Update the time zone using a soft link (the following command is one line):
Step 8 Once the restore is completed, perform the post-upgrade tasks on the primary server. See Post-Upgrade Tasks.
Step 9 Re-configure HA by registering the secondary server on the primary server. Use the information you saved in Step 1. The registration process must be performed from the primary server. For more information, see the section on registering the secondary server on the primary server, in the Cisco Evolved Programmable Network Manager User and Administrator Guide .
a. In the Cisco EPN Manager GUI, choose Monitor > Network Devices .
b. Select all devices, then click Sync .
b. Click on Settings in the top right of the dashboard.
c. Choose Manage Dashboards > Reset All Dashboards.
Note The reset dashboard operation removes existing user-defined dashboard tabs and they must be recreated.
This section describes how to go back to the previous version of Cisco EPN Manager after you have installed Cisco EPN Manager, for both high availability and standard environments. This is a manual process—automatic rollback is not supported.
Note You can only revert to a previous version if you created a copy of your data before installing Cisco EPN Manager, as described in Create a Copy of Your Data.
The procedure for reverting to the previous version of Cisco EPN Manager differs depending on which method you used to create a copy of your data.
If you used the backup facility to create a copy of your data, follow one of these procedures to revert to the previous version of Cisco EPN Manager (non-HA or HA).
For non-HA environments, do the following:
Step 1 Reinstall the previous release of Cisco EPN Manager—the release from which you did the backup.
Step 2 Restore the data from the backup. See the topics related to restoring data in the Cisco Evolved Programmable Network Manager User and Administrator Guide.
For HA environments, do the following:
Step 1 Reinstall the previous release of Cisco EPN Manager on the primary and secondary servers—the release from which you did the backup.
Step 2 On the primary server, restore the data from the backup. See the topics related to restoring data in the Cisco Evolved Programmable Network Manager User and Administrator Guide.
Step 3 Configure HA and register the secondary server on the primary server. The registration process must be performed from the primary server. For more information, see the section on registering the secondary server on the primary server in the Cisco Evolved Programmable Network Manager User and Administrator Guide.
If you are using a VM for your installation and you took a VM snapshot prior to the installation, follow one of these procedures to revert to the previous version of Cisco EPN Manager (non-HA or HA).
For non-HA environments, do the following:
Step 2 Revert the VM snapshot.
Step 4 Start Cisco EPN Manager.
For HA environments, do the following:
Step 1 Shut down the primary and secondary VM servers.
Step 2 Revert the VM snapshot on both servers.
Step 3 Start the primary and secondary VM servers.
Step 4 Start Cisco EPN Manager on the primary server and on the secondary server.
Step 5 Configure HA and register the secondary server on the primary server. The registration process must be performed from the primary server. For more information, see the section on registering the secondary server on the primary server in the Cisco Evolved Programmable Network Manager User and Administrator Guide.