Installation Guide for Cisco Evolved Programmable Network Manager 2.2

Bias-Free Language

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.

Book Contents
Find Matches in This Book
Available Languages
Download Options

Book Title

Installation Guide for Cisco Evolved Programmable Network Manager 2.2

Chapter Title

Overview of Cisco EPN Manager 2.2.x (MP) Installation

Results

Updated:
July 17, 2019

Chapter: Overview of Cisco EPN Manager 2.2.x (MP) Installation

Overview of Cisco EPN Manager 2.2.x (MP) Installation

The following topics provide information and procedures for installing maintenance packs on top of Cisco EPN Manager 2.2 in standard and high availability deployments.


Note
Before starting the installation procedure, please review the release notes for important information or issues relating to the installation.

Installation Paths for Cisco EPN Manager 2.2 Maintenance Packs

See the following section(s) for supported installation paths for each available Cisco EPN Manager 2.2 maintenance pack (MP), based on the version of Cisco EPN Manager you currently have installed:

Note that:

  • PP = Point Patch
  • Cisco EPN Manager 2.x.x = Cisco EPN Manager 2.x Maintenance Pack x. For example, Cisco EPN Manager 2.2.1 = Cisco EPN Manager 2.2 Maintenance Pack 1
  • Cisco EPN Manager 2.2.0.x = Cisco EPN Manager 2.2 installed with point patch x . For example, Cisco EPN Manager 2.2.0.1 = Cisco EPN Manager 2.2 with PP1.

Installation/Upgrade Paths for Cisco EPN Manager 2.2.1

Current Cisco EPN Manager Version

Installation/Upgrade Path to Cisco EPN Manager 2.2.1

Cisco EPN Manager is not installed (fresh installation)

  1. Install Cisco EPN Manager 2.2. See Cisco EPN Manager 2.2 Installation.
  2. Install Cisco EPN Manager 2.2.1. See Cisco EPN Manager 2.1.x (MP) Installation.

Cisco EPN Manager 2.1.x or lower

  1. Upgrade to Cisco EPN Manager 2.2—See Upgrade to Cisco EPN Manager 2.2.
  2. Install Cisco EPN Manager 2.2.1—See Cisco EPN Manager 2.1.x (MP) Installation.

Cisco EPN Manager 2.2

Install Cisco EPN Manager 2.2.1—See Cisco EPN Manager 2.1.x (MP) Installation.

Cisco EPN Manager 2.2.0.x

  1. Go to the Software Download site on Cisco.com and check that you have the latest point patch installed.
  2. If you do not have the latest point patch installed, install it before installing Cisco EPN Manager 2.2.1. Installation instructions can be found in the readme file supplied with the patch file.
  3. Install Cisco EPN Manager 2.2.1—See Cisco EPN Manager 2.1.x (MP) Installation.

Prerequisites for Cisco EPN Manager 2.2.x Installation

Before installing Cisco EPN Manager 2.2.x, you must perform the following tasks:

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:

Procedure

Step 1

Go to Administration > Settings > System Settings > Server.

Step 2

In the Global Idle Timeout section, uncheck the Logout all idle users check box.

Step 3

Click OK in the displayed message reminding you to save your change to the system settings.

Step 4

Click Save.

Step 5

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 6

Click Save.

Step 7

Log out and then log back into Cisco EPN Manager.

What to do next

Go to Place the Cisco EPN Manager 2.1.x Installation File on the Server.

Install Cisco EPN Manager 2.2.x in a Standard Environment (No HA)

Follow these steps to install a maintenance pack (Cisco EPN Manager 2.2.x) in a standard environment (no high availability).

  1. Make sure you have performed the tasks in Prerequisites for Cisco EPN Manager 2.1.x Installation.
  2. Place the Cisco EPN Manager 2.1.x Installation File on the Server.
  3. Install Cisco EPN Manager 2.1.x (No HA).
  4. Synchronize the Hardware and NTP Clock.
  5. Perform an inventory collection for all devices to synchronize them with the database. See Synchronize the Inventory of All Devices with the Database (Existing Deployments Only).

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 Evolved Programmable Network Manager User and Administrator Guide for more information.

Place the Cisco EPN Manager 2.2.x Installation File on the Server

This procedure explains how to download the ubf installation file to your local machine, then upload it from your local machine to the Cisco EPN Manager server.


Note
You need an account on Cisco.com in order to download the installation file.

Procedure

Step 1

Make sure you have performed the tasks in Prerequisites for Cisco EPN Manager 2.1.x Installation.

Step 2

Download the required ubf file to your local machine.

  1. Go to the Software Download site on Cisco.com.
  2. Locate the maintenance pack file (in the format cepnm2.2-mpx-buildxxx.ubf).
  3. 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.

  1. From the left sidebar menu, choose Administration > Licenses and Software Update > Software Update.
  2. Click the blue Upload link at the top of the page.
  3. In the Upload Update dialog box, click Browse and navigate to the file you downloaded previously.
  4. Click OK to upload the file to the server.

After the successful upload of Cisco EPN Manager 2.2.x, the software will appear under the Files tab.

What to do next

Go to Install Cisco EPN Manager 2.1.x (No HA).

Install Cisco EPN Manager 2.2.x (No HA)

Follow this procedure to install Cisco EPN Manager 2.2.x in a standard environment with no high availability.

Procedure

Step 1

From the left sidebar, choose Administration > Licenses and Software Update > Software Update.

Step 2

Click the Install button associated with EPN Manager 2.2.x on the Software Update page.

Step 3

Click Yes in the confirmation message pop-up window to proceed with the installation.

Note 
The server will restart when the installation is complete.
Step 4

If you are asked 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.

  1. Start an SSH session with the Cisco EPN Manager server and log in as the Cisco EPN Manager CLI admin user.
  2. Run the ncs status command to ensure that, at a minimum, the following services are up and running: Health Monitor, Database, NMS, SAM Daemon, DA Daemon, Compliance Engine. Note that for optimal Cisco EPN Manager functionality, all services should be up and running.
Step 6

When the Cisco EPN Manager web GUI is accessible, log in and check that the Maintenance Pack’s status is “Installed” in the Software Update page.

  1. From the left sidebar, choose Administration > Licenses and Software Update > Software Update.
  2. Verify that EPN Manager Maintenance Pack x is listed as Installed under the Updates tab. Also verify that the ubf file (in the format cepnm2.2-mpx-buildxxx.ubf) is listed in the Files tab and that the In Use status is Yes.

What to do next

Go to Synchronize the Hardware and NTP Clock.


Note
The service restart in the Synchorization Clock operation can be ignored as the installation of maintenance pack restarts the Cisco EPN Manager.

Synchronize the Inventory of All Devices with the Database (Existing Deployments Only)

If you have already been using a previous version of Cisco EPN Manager (i.e., this is not a fresh installation), you need to perform a Sync operation on the devices. The Sync operation instructs Cisco EPN Manager to collect device physical and logical inventory and save the information to the database.

Procedure

Step 1

Choose Monitor > Network Devices.

Step 2

Select all devices, then click Sync.

Install Cisco EPN Manager 2.2.x in a High Availability Environment

Follow these steps to install Cisco EPN Manager 2.2.x 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.1.x Installation File on the Server (HA Deployment).
  4. Install Cisco EPN Manager 2.1.x on Primary and Secondary Servers (HA Deployment).
  5. Synchronize the Hardware and NTP Clock.
  6. Synchronize the Inventory of All 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 Installation Guide for more information.

Perform the General and HA Installation Prerequisite Tasks

Before starting the HA installation, do the following:

  1. Perform the tasks in Prerequisites for Cisco EPN Manager 2.1.x Installation on both primary and secondary servers.
  2. Increase the Session Timeout on the 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:

Procedure
Step 1

Log in as the Linux CLI root user as described in 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 (one line): 


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: 


ncs stop
ncs start
Step 6

Ensure that all services are up and running by running this command: 


ncs status

Remove the HA Configuration

Before You Begin
  • 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.
  • Make sure that the status of the primary server is Active and the status of the secondary server is Secondary Syncing

Procedure

Step 1

Make sure you have performed the tasks in Prerequisites for Cisco EPN Manager 2.1.x Installation.

Step 2

Log into the Cisco EPN Manager web GUI on the primary server 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 5

Click Remove.

Step 6

When the remove operation completes, confirm that the Configuration Mode field displays HA Not Configured.

What to do next

Download Cisco EPN Manager 2.2.x as described in Place the Cisco EPN Manager 2.1.x Installation File on the Server (HA Deployment).

Place the Cisco EPN Manager 2.2.x Installation File on the Server (HA Deployment)

Before You Begin

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.

Procedure

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.2.x ubf file. Follow the procedure in Place the Cisco EPN Manager 2.1.x Installation File on the Server.

Step 3

Upload the Cisco EPN Manager 2.2.x ubf file to the secondary server. (You will use the same file that was uploaded and installed on the primary server.)

  1. Log into the secondary server’s HM web page by entering the following URL in your browser:

https://serverIP:8082

Where serverIP is the IP address or host name of the secondary server.

  1. Enter the authentication key and click Login.
  2. Click Software Update at the top right of the Health Monitor window to open the Secondary Server Software Update window.
  3. Enter the authentication key and click Login.
  4. Click the Upload link under the window title, browse to the ubf file, and click OK.

After the successful upload of the ubf file, the file will appear under the Files tab.

What to do next

Install Cisco EPN Manager 2.1.x on Primary and Secondary Servers (HA Deployment).

Install Cisco EPN Manager 2.2.x on Primary and Secondary Servers (HA Deployment)

Before You Begin

  • Make sure you have the password (authentication key) that was created when HA was enabled. You will need it 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.

Procedure

Step 1

Install Cisco EPN Manager 2.2.x on the primary server and verify the installation, as described in Install Cisco EPN Manager 2.1.x (No HA). After the installation, the primary server automatically restarts and the web GUI will not be accessible for some time.

Step 2

Synchronize the hardware and NTP clocks on both the primary and secondary servers as described in Synchronize the Hardware and NTP Clock, then check that the clocks on each server are synchronized with one another.

Note 

The service restart in the Synchorization Clock operation can be ignored as the installation of maintenance pack restarts the Cisco EPN Manager.

Step 3

Install Cisco EPN Manager 2.2.x on the secondary server.

  1. Log into the secondary server’s HM web page by entering the following URL in your browser: https://serverIP:8082

    Where serverIP is the IP address or host name of the secondary server.

  2. Enter the authentication key and click Login.
  3. Click Software Update at the top right of the Health Monitor window to open the Secondary Server Software Update window.
  4. Enter the authentication key and click Login.
  5. Click the Install button associated with EPN Manager Maintenance Pack x on the Software Update page.
  6. 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 4

After the secondary server has restarted, verify the installation on the secondary server.

  1. Start an SSH session with the secondary server and log in as the Cisco EPN Manager CLI admin user.
  2. Run the ncs status command to ensure that, at a minimum, the following services are up and running: Health Monitor, Database, NMS, SAM Daemon, DA Daemon, Compliance Engine. Note that for optimal Cisco EPN Manager functionality, all services should be up and running.
  3. 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: https://serverIP:8082

    Where serverIP is the IP address or host name of the secondary server.

  4. Enter the authentication key and click Login .
  5. Click Software Update at the top right of the Health Monitor window to open the Secondary Server Software Update window.
  6. Enter the authentication key and click Login .
  7. In the Files tab, verify that the MPx ubf file (in the format cepnm2.2-mpx-buildxxx.ubf) is listed and that the In Use status is Yes.
Step 5

Ensure that all services are up and running by running this command: 


ncs status
Step 6

On the primary server, enable high availability and verify that the primary server’s HA status is Primary Active.

  1. Enable high availability.
    1. Log into the Cisco EPN Manager web GUI as a user with Administrator privileges.
    2. From the left sidebar menu, choose Administration > Settings > High Availability.
    3. 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.
    4. 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).
    5. Click Save, then wait until the servers are synchronized.
    6. Verify that the Configuration Mode is HA Enabled.
  2. Verify the primary server’s HA status.
    1. Click HA Status on the left.
    2. Check that the Current State Mode displays Primary Active.
Step 7

Verify that the secondary server’s HA status is Secondary Syncing.

  1. Log into the secondary server’s HM web page by entering the following URL in your browser: https://serverIP:8082

    Where serverIP is the IP address or host name of the secondary server.

  2. Enter the authentication key and click Login .
  3. Verify that the Current State Mode is Secondary Syncing (with a green check mark).

Was this Document Helpful?

FeedbackFeedback

Contact Cisco