Cisco Evolved Programmable Network Manager 2.0.4 Installation Guide
Available Languages
Table of Contents
Cisco Evolved Programmable Network Manager 2.0.4 Installation Guide
Installation Overview and General Information Installation Paths for Cisco EPN Manager2.0.4
How To Log In and Out as the Linux CLI Users
How to Copy Files From a Client Machine to the Cisco EPN Manager Server
Install Cisco EPN Manager2.0.4 in a Standard Environment (No HA) Perform the Cisco EPN Manager2.0.4 Prerequisite Tasks
Check for a Valid Cisco EPN Manager License
Move the navigation_Converged.json File
Disable Automatic Client Logout
Check Available Storage in /tmp Directory
Place the Cisco EPN Manager2.0.4 Installation File on the Server (No HA)
Install Cisco EPN Manager2.0.4 (No HA)
Synchronize the Hardware and NTP Clock
Synchronize the Inventory of Optical Devices with the Database (Existing Deployments Only)
Install Cisco EPN Manager2.0.4 in a High Availability Environment Perform the General and HA Installation Prerequisite Tasks
Increase the Session Timeout on the Servers
Place the Cisco EPN Manager2.0.4 Installation File on the Server (HA Deployment)
Install Cisco EPN Manager2.0.4 on Primary and Secondary Servers (HA Deployment)
Install Geo Map Resources for Offline Use Install Geo Map Resource Files (Standard Deployment)
Place the Geo Map Resource Files on the Cisco EPN Manager Server
Install the Geo Map Resource Files on the Cisco EPN Manager Server
Configure the Cisco EPN Manager Server to Use the Installed Map Resources
Verify that the Geo Maps Files Were Installed Successfully
Install the Geo Map Resource Files on the Cisco EPN Manager Server (High Availability Deployment)
Revert to the Previous Version of Cisco EPN Manager Revert to the Previous Version using Data Restore
Revert to the Previous Version Using the VM Snapshot
Obtaining Documentation and Submitting a Service Request Cisco Evolved Programmable Network Manager 2.0.4 Installation Guide
First Published: December 21, 2016
Installation Overview and General Information
Install Cisco EPN Manager 2.0.4 in a Standard Environment (No HA)
Install Cisco EPN Manager 2.0.4 in a High Availability Environment
Install Geo Map Resources for Offline Use
Revert to the Previous Version of Cisco EPN Manager
Obtaining Documentation and Submitting a Service Request
SUPPLEMENTAL LICENSE AGREEMENT FOR CISCO SYSTEMS NETWORK MANAGEMENT SOFTWARE: CISCO EVOLVED PROGRAMMABLE NETWORK MANAGER
IMPORTANT-READ CAREFULLY : This Supplemental License Agreement (“SLA”) contains additional limitations on the license to the Software provided to Customer under the End User License Agreement between Customer and Cisco. Capitalized terms used in this SLA and not otherwise defined herein shall have the meanings assigned to them in the End User License Agreement. To the extent that there is a conflict among any of these terms and conditions applicable to the Software, the terms and conditions in this SLA shall take precedence.
By installing, downloading, accessing or otherwise using the Software, Customer agrees to be bound by the terms of this SLA. If Customer does not agree to the terms of this SLA, Customer may not install, download or otherwise use the Software.
ADDITIONAL LICENSE RESTRICTIONS:
- Installation and Use. The Software components are provided to Customer solely to install, update, supplement, or replace existing functionality of the applicable Network Management Software product. Customer may install and use the following Software components:
– Cisco Evolved Programmable Network Manager: May be installed on a server in Customer's network management environment.
For each Software license granted, customers may install and run the Software on a single server to manage the number of network devices and codecs specified in the license file provided with the Software, or as specified in the Software License Claim Certificate. Customers whose requirements exceed the network device and codec limits must purchase upgrade licenses or additional copies of the Software. The network device and codec limits are enforced by license registration.
DESCRIPTION OF OTHER RIGHTS AND LIMITATIONS.
Refer to the Cisco Systems, Inc. End User License Agreement.
Cisco and the Cisco Logo are trademarks of Cisco Systems, Inc. and/or its affiliates in the U.S. and other countries. A listing of Cisco's trademarks can be found at www.cisco.com/go/trademarks . Third party trademarks mentioned are the property of their respective owners. The use of the word partner does not imply a partnership relationship between Cisco and any other company. (1110R)
Any Internet Protocol (IP) addresses used in this document are not intended to be actual addresses. Any examples, command display output, and figures included in the document are shown for illustrative purposes only. Any use of actual IP addresses in illustrative content is unintentional and coincidental.
Revisions to this Guide
The following table lists changes that have been made to the Installation Guide since the guide was first published.
Installation Overview and General Information
- Installation Paths for Cisco EPN Manager 2.0.4
- How To Log In and Out as the Linux CLI Users
- How to Copy Files From a Client Machine to the Cisco EPN Manager Server
Installation Paths for Cisco EPN Manager 2.0.4
The following table lists the installation paths for Cisco EPN Manager 2.0.4, based on the version of Cisco EPN Manager you currently have installed.
- PP = Point Patch
- Cisco EPN Manager 2.0.x = Cisco EPN Manager 2.0 Maintenance Pack x. For example, Cisco EPN Manager 2.0.1 = Cisco EPN Manager 2.0 Maintenance Pack 1
- Cisco EPN Manager 2.0.x.x = Cisco EPN Manager 2.0 Maintenance Pack x installed with point patch x . For example, Cisco EPN Manager 2.0.1.1 = Cisco EPN Manager 2.0 MP1 with PP 1.
Note For each existing deployment in the table below, we assume that the mandatory point patches for that release have been installed. To check which point patches have been installed, click the gear icon at the top right of the web GUI window, click About Cisco EPN Manager, then click the View Installed Updates link in the popup window).
1. Install Cisco EPN Manager 2.0—See Cisco EPN Manager 2.0 Installation Guide
2. Install Cisco EPN Manager 2.0 PP2—See Cisco EPN Manager 2.0 Release Notes
a. Install Cisco EPN Manager 2.0.4—Use this document
High availability installation:
a. Install Cisco EPN Manager 2.0.2. See Cisco EPN Manager 2.0.2 Installation Guide .
1. Upgrade to Cisco EPN Manager 2.0—See Cisco EPN Manager 2.0 Installation Guide
2. Install Cisco EPN Manager 2.0 PP2—See Cisco EPN Manager 2.0 Release Notes
a. Install Cisco EPN Manager 2.0.4—Use this document
High availability installation:
a. Install Cisco EPN Manager 2.0.2. See Cisco EPN Manager 2.0.2 Installation Guide .
Standard installation (no high availability):
1. Install Cisco EPN Manager 2.0.4—Use this document
High availability installation:
1. Install Cisco EPN Manager 2.0.2. See Cisco EPN Manager 2.0.2 Installation Guide
Standard installation (no high availability):
1. Install Cisco EPN Manager 2.0.4—Use this document
High availability installation:
1. Install Cisco EPN Manager 2.0.2. See Cisco EPN Manager 2.0.2 Installation Guide
How To Log In and Out as the Linux CLI Users
The Linux CLI has two shell users: One with administrative access (Linux CLI admin user), and another with root access (Linux CLI root user). The following diagram illustrates the flow for logging in as the various CLI users.
To log in as the Linux CLI root user, you must transition from being the Cisco EPN Manager CLI admin user to the Linux CLI admin user to the Linux CLI root user . The following procedure provides the steps for logging in as these users. For more information on these users, refer to the Cisco Evolved Programmable Network Manager User and Administrator Guide .
If the Linux CLI user is disabled, re-enable it. Refer to the user management procedures in the Cisco Evolved Programmable Network Manager User and Administrator Guide .
Step 1 To log in as the Linux CLI root user:
a. Start an SSH session with the Cisco EPN Manager server and log in as the Cisco EPN Manager CLI admin user.
b. As the Cisco EPN Manager CLI admin user, log in as the Linux CLI admin user:
shell
Enter shell access password:password
c. Log in as the Linux CLI root user:
By default, the Linux CLI shell prompt is the same for the Linux CLI admin and root user. You can use the whomai command to check the current user.
a. Log out as the Linux CLI root user.
You are now logged in as the Linux CLI admin user.
b. Log out as the Linux CLI admin user:
You are now logged in as the Cisco EPN Manager CLI admin user.
For security purposes, disable the Linux CLI users. Refer to the user management procedures in the Cisco Evolved Programmable Network Manager User and Administrator Guide .
How to Copy Files From a Client Machine to the Cisco EPN Manager Server
- You can use SCP, FTP, or SFTP protocols to retrieve files from the client machine. Make sure the required protocol is enabled on your client machine and the required ports are open (refer to the Cisco EPN Manager 2.0 Installation Guide ).
This procedure explains how to copy files from your client machine to the Cisco EPN Manager server.
Step 1 Start an SSH session with the Cisco EPN Manager server and log in as the Cisco EPN Manager CLI admin user.
Step 2 Log in as the Linux CLI admin user (see How To Log In and Out as the Linux CLI Users).
Step 3 From the Cisco EPN Manager server, retrieve the file from the client machine. You can use SCP, FTP, or SFTP. This example uses the scp command, which has the following syntax:
scp
clientUsername @ clientIP :/ fullpath-to-file-on-client/server-directory
- clientUsername is your username on the client machine
- clientIP is the IP address of the client machine
- fullpath-to-file-on-client is the full path to the file on the client machine that you want to copy to the server
- server-directory is the path to the directory on the server to which you want to copy the file
In the following example, a file named myfile located in the /temp directory on the client machine is being copied to the /localdisk/defaultRepo on the Cisco EPN Manager server.
scp joesmith@123.456.789.101:/temp/myfile /localdisk/defaultRepo
Step 4 Log out as the Linux CLI admin user as described in How To Log In and Out as the Linux CLI Users.
Install Cisco EPN Manager 2.0.4 in a Standard Environment (No HA)
Follow these steps to install Cisco EPN Manager 2.0.4 in a non-HA environment.
1. Perform the Cisco EPN Manager 2.0.4 Prerequisite Tasks.
2. Place the Cisco EPN Manager 2.0.4 Installation File on the Server (No HA).
3. Install Cisco EPN Manager 2.0.4 (No HA).
4. Synchronize the Hardware and NTP Clock.
5. Synchronize the Inventory of Optical Devices with the Database (Existing Deployments Only).
Note If you are using external authentication and authorization, after installation you must export the user task information to your AAA server in order to pick up the latest updates. See the Cisco EPN Manager 2.0.4 User and Administrator Guide for more information.
Perform the Cisco EPN Manager 2.0.4 Prerequisite Tasks
Before installing Cisco EPN Manager 2.0.4, you must perform the following tasks:
Check for a Valid Cisco EPN Manager License
Make sure that Cisco EPN Manager has a valid license. Refer to the topics in the Cisco Evolved Programmable Network Manager User and Administrator Guide .
Create a Copy of Your Data
We recommend that you create a copy of your data in case you need to revert to the previous version of Cisco EPN Manager after installing Cisco EPN Manager 2.0.4. 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
Take a Base Snapshot of the VM (no HA)
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.
Take a Base Snapshot of the VM (HA)
Step 1 Remove the HA configuration following the procedure in Remove the HA Configuration.
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.
Move the navigation_Converged.json File
Note This is relevant if you are installing Cisco EPN Manager 2.0.4 on top of Cisco EPN Manager 2.0.1 or Cisco EPN Manager 2.0.2.
If you have used the menu customization feature to adjust what is displayed in the web GUI, move the following file to ensure a smooth Cisco EPN Manager 2.0.4 installation.
Note You do not need to restart Cisco EPN Manager after performing this procedure.
- Start an SSH session and log into the Cisco EPN Manager server as the Linux CLI root user (as described in How To Log In and Out as the Linux CLI Users).
- Run the following command (this command is one line):
cp /opt/CSCOlumos/compliance_enable/disable/navigation_Converged.json.previous /opt/CSCOlumos/compliance_enable/disable/navigation_Converged.json
If you receive a “No file found” response, do not be concerned.
Note If you did have customized menus, you will need to re-customize them after the Cisco EPN Manager 2.0.4 installation.
Disable Automatic Client Logout
If the client is inactive for a certain period of time, you might be automatically logged out. To avoid being logged out during the installation, we recommend that you disable automatic logout of idle users in the system settings, as follows:
Step 1 Go to Administration > Settings > System Settings > General > Server. In the Global Idle Timeout section, uncheck the Logout all idle users check box.
Step 3 Click the gear icon at the top right of the web GUI window, then click My Preferences. Under User Idle Timeout, uncheck the Logout idle user check box.
Step 5 Log out and then log back into Cisco EPN Manager.
Check Available Storage in /tmp Directory
Verify that the /tmp directory has at least 1.8 GB free storage, by running the following command as the Linux CLI admin user:
If necessary, delete some files. Following are some examples of items you might find in the /tmp directory that can be deleted:
Go to Place the Cisco EPN Manager 2.0.4 Installation File on the Server (No HA).
Place the Cisco EPN Manager 2.0.4 Installation File on the Server (No HA)
This procedure explains how to download the Cisco EPN Manager 2.0.4 ubf file to your local machine, then upload it from your local machine to the Cisco EPN Manager server. (Although this section is directed at standard deployments, this procedure is also used to download the ubf file onto the primary server in a high availability deployment.)
Step 1 Make sure you have performed the tasks in Perform the Cisco EPN Manager 2.0.4 Prerequisite Tasks.
Step 2 Download the required ubf file to your local machine.
a. Log in to Cisco.com and go to the Software Download site.
b. Locate the maintenance pack file, which will have a name similar to cepnm2.0-mp4-build xxxx .ubf (be sure to check the file description).
c. Download the file to your local machine.
Step 3 Log into the Cisco EPN Manager web GUI as a user with Administrator privileges.
Step 4 Upload the ubf file from your local machine to the Cisco EPN Manager server.
a. From the left sidebar menu, choose Administration > Licenses and Software Update > Software Update .
b. Click the blue Upload link at the top of the page.
c. In the Upload Update dialog box, click Browse and navigate to the file you downloaded in Step 2.
d. Click OK to upload the file to the server.
After the successful upload of Cisco EPN Manager 2.0.4, the software will appear under the Files tab.
Install Cisco EPN Manager 2.0.4 (No HA)
Step 1 Verify that Cisco EPN Manager 2.0 Point Patch 2 is installed on the server.
a. Click the gear at the top right of the web GUI window (next to name of the current domain) and click About Cisco EPN Manager .
b. In the pop-up window, click View Installed Updates .
c. Verify that EPN Manager Point Patch 2.0.0 is listed.
If the point patch is not listed, you must install it as described in the Cisco EPN Manager 2.0 Release Notes . It is a requirement for Cisco EPN Manager 2.0.4.
Step 2 From the left sidebar, choose Administration > Licenses and Software Update > Software Update .
Step 3 Click the Install button associated with EPN Manager Maintenance Pack 2.0.4 on the Software Update page.
Step 4 Click Yes in the confirmation message pop-up window to proceed with the installation.
Note If you are prompted whether to overwrite an existing file, click Yes.
After successful installation, the status will change to Installed . Cisco EPN Manager will auto-restart and the Cisco EPN Manager web GUI will not be accessible for some time.
Step 5 Check the status of the Cisco EPN Manager services.
a. Start an SSH session with the Cisco EPN Manager server and log in as the Cisco EPN Manager CLI admin user.
b. Run the ncs status command to 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 6 Once the Cisco EPN Manager web GUI is accessible, log in and check that Maintenance Pack 4.0.0 appears as Installed in the Software Update page.
a. From the left sidebar, choose Administration > Licenses and Software Update > Software Update .
b. Verify that EPN Manager Maintenance Pack 4.0.0 is listed as Installed under the Updates tab. Also verify that cepnm2.0-mp4-build431.ubf is listed in the Files tab and that the In Use status is Yes.
Go to Synchronize the Hardware and NTP Clock.
Note Although this section is directed at standard deployments, this procedure also applies when installing the software to the primary server in an HA deployment. For the next step in HA deployments, go to Step 3 in Install Cisco EPN Manager 2.0.4 on Primary and Secondary Servers (HA Deployment).
Synchronize the Hardware and NTP Clock
This procedure synchronizes the hardware clock with the NTP clock using the hwclock command. (Although this section is directed at standard deployments, it is also used to synchronize the clocks on primary and secondary servers in an HA deployment.)
Step 1 Log in as the Linux CLI root user as described in How To Log In and Out as the Linux CLI Users.
Step 2 Check the NTP service status and ensure that NTP has obtained a stable time reference using the following commands. The following includes examples of the output you should see.
a. Ensure that ntpd is running.
service ntpd status
ntpd (pid 3290) is running...
b. If ntpd (pid 3290) is not running, start it using the following command:
(Repeat Step a to ensure it is running.)
c. Ensure that NTP is receiving time from an NTP server.
ntpstat
synchronised to NTP server (10.116.133.175) at stratum 3
time correct to within 62 ms
polling server every 1024 s
If you do not see output similar to this, then NTP synchronization has not yet occurred. Wait a few minutes and run ntpstat again. If synchronization does not happen within 10 minutes, contact your system administrator or Cisco support.
Step 3 Synchronize the hardware clock with NTP using the following command:
You should see output similar to the following:
hwclock from util-linux-ng 2.17.2
Using /dev interface to clock.
Last drift adjustment done at 1470117750 seconds after 1969
Last calibration done at 1470117750 seconds after 1969
Hardware clock is on local time
Assuming hardware clock is kept in local time.
Waiting for clock tick...
...got clock tick
Time read from Hardware Clock: 2016/08/02 16:03:30
Hw clock time : 2016/08/02 16:03:30 = 1470117810 seconds since 1969
1470117810.500000 is close enough to 1470117810.500000 (0.000000 < 0.001000)
Set RTC to 1470117810 (1470117810 + 0; refsystime = 1470117810.000000)
Setting Hardware Clock to 16:03:30 = 1470117810 seconds since 1969
ioctl(RTC_SET_TIME) was successful.
Not adjusting drift factor because it has been less than a day since the last calibration.
Step 4 Verify that the hardware clock is synchronized with NTP.
echo "hwclock is: $(hwclock --show)" ; echo "linux clock is: $(date)";
Check the output and ensure that the two clocks are synchronized (to at least within a few seconds of each other):
Hwclock is: Tue 26 Jul 2016 06:11:40 PM AEST -0.391028 seconds
linux clock is: Tue Jul 26 18:11:40 AEST 2016
Step 5 (High availability deployments) Do the following:
a. Perform the previous steps on both servers.
b. Check the clocks on each server and ensure they are synchronized with each other.
c. Go to in Install Cisco EPN Manager 2.0.4 on Primary and Secondary Servers (HA Deployment) to re-enable high availability.
Step 6 As the Linux CLI admin user, restart the Cisco EPN Manager services.
a. If you are logged in as the Linux CLI root user, switch to the Linux CLI admin user.
b. Switch to the Cisco EPN Manager CLI admin user.
c. Stop and restart the Cisco EPN Manager services.
If you installed Cisco EPN Manager 2.0.4 on an existing deployment that has optical devices, perform an inventory collection for those devices. See Synchronize the Inventory of Optical Devices with the Database (Existing Deployments Only).
Synchronize the Inventory of Optical Devices with the Database (Existing Deployments Only)
If you are installing Cisco EPN Manager 2.0.4 on top of an existing deployment (in other words, this is not a fresh installation of Cisco EPN Manager) and your deployment includes optical devices, you need to perform a Sync operation on the optical devices. The Sync operation instructs Cisco EPN Manager to collect device physical and logical inventory and save the information to the database.
Step 1 Choose Monitor > Network Devices .
Step 2 Select all of the optical devices, then click Sync .
Install Cisco EPN Manager 2.0.4 in a High Availability Environment
Follow these steps to install Cisco EPN Manager 2.0.4 in a HA environment.
1. Perform the General and HA Installation Prerequisite Tasks.
2. Remove the HA Configuration.
3. Place the Cisco EPN Manager 2.0.4 Installation File on the Server (HA Deployment).
4. Install Cisco EPN Manager 2.0.4 on Primary and Secondary Servers (HA Deployment).
5. Synchronize the Hardware and NTP Clock.
6. Synchronize the Inventory of Optical Devices with the Database (Existing Deployments Only).
Note If you are using external authentication and authorization, after installation you must export the user task information to your AAA server in order to pick up the latest updates. See the Cisco EPN Manager 2.0.4 User and Administrator Guide for more information.
Perform the General and HA Installation Prerequisite Tasks
Before starting the HA installation, do the following:
1. Perform the Cisco EPN Manager 2.0.4 Prerequisite Tasks on both primary and secondary servers.
Increase the Session Timeout on the Servers
Increase the timeout on the primary and secondary servers from 30 minutes to 90 minutes, as follows:
Step 1 Log in as the Linux CLI root user as described in How To Log In and Out as the Linux CLI Users.
Step 2 Save a backup of the web.xml file located under /opt/CSCOlumos/tomcatSWUpdate/webapps/ROOT/WEB-INF/ by running the following command:
cp/opt/CSCOlumos/tomcatSWUpdate/webapps/ROOT/WEB-INF/web.xml/opt/CSCOlumos/tomcatSWUpdate/webapps/ROOT/WEB-INF/web.xml.orig
Step 3 In the web.xml file (/opt/CSCOlumos/tomcatSWUpdate/webapps/ROOT/WEB-INF/web.xml), search for the following:
<session-timeout>30</session-timeout>Step 4 Change the session timeout to 90 minutes:
<session-timeout>90</session-timeout>Step 5 As the Cisco EPN Manager CLI admin user, manually stop and restart the server:
Step 6 Ensure that all services are up and running by running this command:
Remove the HA Configuration
- Make sure you have the password (authentication key) that was created when HA was enabled. You will need it to install the patch on the secondary server.
- (Existing deployments) Back up your data.
Step 1 Make sure you have performed the tasks in Perform the Cisco EPN Manager 2.0.4 Prerequisite Tasks.
Step 2 Log into the Cisco EPN Manager web GUI as a user with Administrator privileges.
Step 3 From the left sidebar, choose Administration > Settings > High Availability .
Step 4 Click HA Configuration on the left.
Step 6 When the remove operation completes, confirm that the Configuration Mode field displays HA Not Configured .
Download Cisco EPN Manager 2.0.4 as described in Place the Cisco EPN Manager 2.0.4 Installation File on the Server (HA Deployment).
Place the Cisco EPN Manager 2.0.4 Installation File on the Server (HA Deployment)
- Make sure you have the password (authentication key) that was created when HA was enabled. You will need it to install the patch on the secondary server.
Step 1 Make sure you have removed the HA configuration as described in Remove the HA Configuration.
Step 2 On the primary server, upload the Cisco EPN Manager 2.0.4 ubf file. Follow the procedure in Place the Cisco EPN Manager 2.0.4 Installation File on the Server (No HA).
Step 3 Upload the Cisco EPN Manager 2.0.4 ubf file to the secondary server. (You will use the same file that was uploaded and installed on the primary server.)
a. Log into the secondary server’s HM web page by entering the following URL in your browser:
Where serverIP is the IP address or host name of the secondary server.
b. Enter the authentication key and click Login .
c. Click Software Update at the top right of the Health Monitor window to open the Secondary Server Software Update window.
d. Enter the authentication key and click Login .
e. Click the Upload link under the window title, browse to the ubf file, and click OK .
After the successful upload of Cisco EPN Manager 2.0.4, the software will appear under the Files tab.
Install Cisco EPN Manager 2.0.4 as described in Install Cisco EPN Manager 2.0.4 on Primary and Secondary Servers (HA Deployment).
Install Cisco EPN Manager 2.0.4 on Primary and Secondary Servers (HA Deployment)
- Make sure you have the password (authentication key) that was created when HA was enabled. You will need to install the maintenance pack on the secondary server.
- Make sure no backups are in progress.
- On the secondary server, update the time zone using a soft link (the following command is one line):
ln -sf /usr/share/zoneinfo/$(grep ^clock /storedconfig/active/startup-config | cut -d " " -f 3) /etc/localtime
This ensures that the compliance server will be up and running on the secondary server after failover.
Step 1 Verify that Cisco EPN Manager 2.0 Point Patch 2 is installed on the primary server.
a. Click the gear at the top right of the web GUI window (next to name of the current domain) and click About Cisco EPN Manager .
b. In the pop-up window, click View Installed Updates .
c. Verify that EPN Manager Point Patch 2.0.0 is listed.
If it is not listed, you must install it as described in the Cisco EPN Manager 2.0 Release Notes . It is a requirement for Cisco EPN Manager 2.0.4.
Step 2 Install Cisco EPN Manager 2.0.4 on the primary server as described in Install Cisco EPN Manager 2.0.4 (No HA). That section includes the steps for verifying the installation. After the installation, the primary server automatically restarts and the web GUI will not be accessible for some time.
Step 3 Verify that Cisco EPN Manager 2.0 Point Patch 2 is installed on the secondary server.
a. Click the gear at the top right of the web GUI window (next to name of the current domain) and click About Cisco EPN Manager .
b. In the pop-up window, click View Installed Updates .
c. Verify that EPN Manager Point Patch 2.0.0 is listed.
If it is not listed, you must install it as described in the Cisco EPN Manager 2.0 Release Notes . It is a requirement for Cisco EPN Manager 2.0.4.
Step 4 Install Cisco EPN Manager 2.0.4 on the secondary server.
a. Log into the secondary server’s HM web page by entering the following URL in your browser:
Where serverIP is the IP address or host name of the secondary server.
b. Enter the authentication key and click Login .
c. Click Software Update at the top right of the Health Monitor window to open the Secondary Server Software Update window.
d. Enter the authentication key and click Login .
e. Click the Install button associated with EPN Manager Maintenance Pack 2.0.4 on the Software Update page.
f. Click Yes in the confirmation message pop-up window to proceed with the installation. On successful installation, the status will change to Installed and the secondary server will restart automatically.
Step 5 After the secondary server has restarted, verify the installation on the secondary server.
a. Start an SSH session with the secondary server and log in as the Cisco EPN Manager CLI admin user.
b. Run the ncs status command to 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.
c. Once the web GUI is accessible, verify the installation and version in the secondary server’s HM web page. Enter the following URL in your browser:
Where serverIP is the IP address or host name of the secondary server.
– Enter the authentication key and click Login .
– Click Software Update at the top right of the Health Monitor window to open the Secondary Server Software Update window.
– Enter the authentication key and click Login .
– In the Files tab, verify that cepnm2.0-mp4-build431.ubf is listed and that the In Use status is Yes.
Step 6 Synchronize the hardware and NTP clocks on both the primary and secondary servers as described in Synchronize the Hardware and NTP Clock.
Step 7 As the Cisco EPN Manager CLI admin user, manually stop and restart the primary and secondary servers:
Step 8 Ensure that all services are up and running by running this command:
Step 9 On the primary server, enable high availability and verify that the primary server’s HA status is Primary Active.
– Log into the Cisco EPN Manager web GUI as a user with Administrator privileges.
– From the left sidebar menu, choose Administration > Settings > High Availability .
– Click HA Configuration on the left, then enter the secondary server’s IP address, the secondary server’s authentication key, and an email address to which Cisco EPN Manager should send HA state change notifications.
– If you are using virtual IP addressing in your HA setup (if the primary and secondary servers are in the same subnet), check the Enable Virtual IP check box and enter the virtual IP address(es).
– Click Save , then wait until the servers are synchronized.
– Verify that the Configuration Mode is HA Enabled .
b. Verify the primary server’s HA status.
– Click HA Status on the left.
– Check that the Current State Mode displays Primary Active .
Step 10 Verify that the secondary server’s HA status is Secondary Syncing.
a. Log into the secondary server’s HM web page by entering the following URL in your browser:
Where serverIP is the IP address or host name of the secondary server.
b. Enter the authentication key and click Login .
c. Verify that the Current State Mode is Secondary Syncing (with a green check mark).
Install Geo Map Resources for Offline Use
The network can be visualized on a topology map or on a geographical map (geo map). The geo map enables you to position your network devices on a world map and monitor them within their geographical context.
To display the geo map in the GUI, the system is set up by default to get the map tiles from a specific Mapbox URL through a direct Internet connection from the client or via the EPN Manager server which acts as a proxy. If you do not have an Internet connection, you must install the map resources locally and specify that you want the system to use the local map resources (i.e., offline use).
These topics explain how to download and install geo maps for offline use in both HA and non-HA environments.
- Install Geo Map Resource Files (Standard Deployment)
- Install the Geo Map Resource Files on the Cisco EPN Manager Server (High Availability Deployment)
Note Geo map compressed files are very large. We recommend you save the files to a remote repository.
Install Geo Map Resource Files (Standard Deployment)
Installing geo map resource files for offline use in a standard environment (no high availability) involves the following steps:
1. Place the Geo Map Resource Files on the Cisco EPN Manager Server.
2. Install the Geo Map Resource Files on the Cisco EPN Manager Server.
3. Configure the Cisco EPN Manager Server to Use the Installed Map Resources.
4. Verify that the Geo Maps Files Were Installed Successfully
Place the Geo Map Resource Files on the Cisco EPN Manager Server
- If you plan to use a remote repository (because geo map files are very large), make sure a remote repository has been configured. For more information, refer to the topics on using remote FTP backup repositories in the Cisco Evolved Programmable Network Manager User and Administrator Guide .
- Make sure SCP is enabled on your client machine and the required ports are open (refer to the Cisco EPN Manager 2.0 Installation Guide ).
This procedure shows you how to download and copy the geo map resources to the default local repository on the Cisco EPN Manager server.
Step 1 Download the geo map compressed files to a client machine.
a. Go to the Software Download site on Cisco.com .
b. Navigate to the files by choosing All Releases > 2.0 >2.0.1 .
Note Even though the files are listed under 2.0.1, they apply to this release.
c. Identify the map you want to download and click Download .
d. Follow the instructions to save the file to the client machine.
Step 2 Copy the geo map compressed files from the local machine to the Cisco EPN Manager server’s default local repository (/localdisk/defaultRepo) by following the procedure in How to Copy Files From a Client Machine to the Cisco EPN Manager Server.
In the following example, the Russia geo map file was downloaded to a /temp directory on the client machine. The user has logged into the Cisco EPN Manager server as the Linux CLI admin user and is retrieving the file from the client machine and copying it to /localdisk/defaultRepo on the server:
scp joesmith@123.456.789.101:/temp/Russia_GeoMap_CEPNM_2_0_1-bundle.tar.gz /localdisk/defaultRepo
Install the geo map files as described in Install the Geo Map Resource Files on the Cisco EPN Manager Server.
Install the Geo Map Resource Files on the Cisco EPN Manager Server
The installation process will extract the geo map files and install them in /opt/CSCOlumos/resources/offline_geo. To avoid storage constraints, consider mounting additional storage on the directory by editing the /etc/fstab file after logging in as a Linux CLI admin user (see How To Log In and Out as the Linux CLI Users). If you have high availability and need to mount additional storage, be sure to edit the /etc/fstab file on both the primary and secondary servers.
Note Even though the file names contain 2_0_1, they apply to this release.
Step 1 Start an SSH session with the Cisco EPN Manager server and log in as the Cisco EPN Manager CLI admin user.
Step 2 Install the geo map resource file that is located in /localdisk/defaultRepo.
application install filename defaultRepo
Where filename is the geo map resource file located in /localdisk/defaultRepo (this is the file you copied in Place the Geo Map Resource Files on the Cisco EPN Manager Server). For example:
application install Russia_GeoMap_CEPNM_2_0_1-bundle.tar.gz defaultRepo
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
The installation takes a few minutes to complete depending on the size of the map resources.
Configure Cisco EPN Manager to use the installed geo map files, as described in Configure the Cisco EPN Manager Server to Use the Installed Map Resources.
Configure the Cisco EPN Manager Server to Use the Installed Map Resources
Step 1 Choose Administration > Settings > System Settings , then choose Maps > Network Topology .
Step 2 Check Enable Geo Maps .
Step 3 Choose Installed Map Resources from the Map Provider drop-down list.
You do not have to restart the Cisco EPN Manager server to apply your changes. A notification message informs you that the system is now working with the installed map resources.
Verify that the geo map files have been installed, as described in Verify that the Geo Maps Files Were Installed Successfully.
Verify that the Geo Maps Files Were Installed Successfully
After installing the geo map files and configuring the system to use these geo map files, check that they have been successfully installed and that they are being displayed in the GUI.
Step 1 Verify that a directory named geoMaps was created under /opt/CSCOlumos/resources/offline_geo:
Is/opt/CSCOlumos/resources/offline_geo
geoMapsStep 2 Check that the map is being displayed in the GUI:
a. Log in to the Cisco EPN Manager web GUI as a user with Administrator privileges.
b. From the left sidebar menu, choose Maps > Topology Maps > Network Topology .
c. Click the Geographical Map icon at the top right of the topology window to display the geo map.
d. Verify that the desired map is displayed. For example, if you installed the map of Russia, it should be displayed.
Install the Geo Map Resource Files on the Cisco EPN Manager Server (High Availability Deployment)
For a high availability environment, you must install the offline map resources on both the primary and the secondary servers.
Note If a failure occurs on the primary server that requires you to reinstall Cisco EPN Manager on the primary server, you must reinstall the geo map resources on the primary server and restart the server.
Follow this workflow to install geo map files in a high availability deployment:
Step 1 Place the geo map files on the primary server and on the secondary server, as described in Place the Geo Map Resource Files on the Cisco EPN Manager Server.
Step 2 Install the geo map files on the primary server, as described in Install the Geo Map Resource Files on the Cisco EPN Manager Server.
Step 3 Install the geo map files on the secondary server, as described in Install the Geo Map Resource Files on the Cisco EPN Manager Server.
Step 4 On the primary server, enable the use of installed map files, as described in Configure the Cisco EPN Manager Server to Use the Installed Map Resources.
Step 5 On the primary server, check that the geo map is displayed, as described in Verify that the Geo Maps Files Were Installed Successfully.
Revert to the Previous Version of Cisco EPN Manager
This section describes how to go back to the previous version of Cisco EPN Manager after you have installed Cisco EPN Manager 2.0.4, for both high availability and standard environments.
Note You can only revert to a previous version if you created a copy of your data before installing Cisco EPN Manager 2.0.4, as described in Perform the Cisco EPN Manager 2.0.4 Prerequisite Tasks.
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, see Revert to the Previous Version using Data Restore
- If you took a VM snapshot, see Revert to the Previous Version Using the VM Snapshot
Revert to the Previous Version using Data Restore
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.
Revert to the Previous Version Using the VM Snapshot
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.
Related Documentation
Refer to the Cisco Evolved Programmable Network Manager 2.0 Documentation Overview for information about and links to all of the documentation that is provided with Cisco EPN Manager 2.0 and its maintenance packs.
Note We sometimes update the documentation after original publication. Therefore, you should also review the documentation on Cisco.com for any updates.
Obtaining Documentation and Submitting a Service Request
For information on obtaining documentation, submitting a service request, and gathering additional information, see the monthly What’s New in Cisco Product Documentation , which also lists all new and revised Cisco technical documentation, at:
http://www.cisco.com/en/US/docs/general/whatsnew/whatsnew.html
Subscribe to What’s New in Cisco Product Documentation , which lists all new and revised Cisco technical documentation, as an RSS feed and deliver content directly to your desktop using a reader application. The RSS feeds are a free service.
This document is to be used in conjunction with the documents listed in the “Related Documentation” section.
Cisco and the Cisco logo are trademarks or registered trademarks of Cisco and/or its affiliates in the U.S. and other countries. To view a list of Cisco trademarks, go to this URL: www.cisco.com/go/trademarks . Third-party trademarks mentioned are the property of their respective owners. The use of the word partner does not imply a partnership relationship between Cisco and any other company. (1110R)
Any Internet Protocol (IP) addresses and phone numbers used in this document are not intended to be actual addresses and phone numbers. Any examples, command display output, network topology diagrams, and other figures included in the document are shown for illustrative purposes only. Any use of actual IP addresses or phone numbers in illustrative content is unintentional and coincidental.
FeedbackContact Cisco
- Open a Support Case
- (Requires a Cisco Service Contract)