Get Started With Cisco EPN Manager

Web Client Requirements

The following are the client and browser requirements for the Cisco EPN Manager Web GUI:

  • Hardware—Use a Mac or Windows laptop/desktop with one of these supported browsers:

    • Google Chrome (version 70 or later)

    • Mozilla Firefox ESR (version 78)

    • Mozilla Firefox (version 70 or later)


    Note
    You can have up to three Cisco EPN Manager tabs open simultaneously in a single browser session.

  • Recommended display resolution—1600x900 pixels or higher (minimum: 1366x768).

To improve loading time and reduce network bandwidth usage, Cisco EPN Manager caches static files (js, css) in the browser in the same version of Cisco EPN Manager (Firefox browsers).


Note
Google Chrome ignores all caching directives and reloads page content because of known limitations about self-signed certificates.

Log In and Out

To log into the GUI, enter the following in your web browser address field, where server-ip is the IP address of the Cisco EPN Manager server:

https:// server-ip


Note

Do not autofill or save any username and password in the browser when you log in to Cisco EPN Manager.

Depending on your network configuration, the first time your browser connects to the Cisco EPN Manager web server, you may have to update your client browser to trust the security certificate of the server. You can also generate and import user-specific client certificates to your browser, which allows the user to log into Cisco EPN Manager. These generated client certificates allow you to log in without specifying a username or password. These generated client certificates require a passcode when you update them to your browser. This ensures the security of the connection between your client and the Cisco EPN Manager web server.

To log out, click at the top right of the Cisco EPN Manager window and choose Log Out .

For information on Cisco EPN Manager users and the actions they can perform, see:

  • How to Transition Between the CLI User Interfaces in Cisco Evolved Programmable Network Manager —Describes all classes of users supported by Cisco EPN Manager, including the various CLI user accounts.

  • Types of Roles—Describes the user group mechanism which allows you to control the functions that everyday web GUI users can perform. What you can see and do in the user interface is controlled by your user account privileges. This topic also describes the virtual domain mechanism, which manages Role-Based Access Control (RBAC) for devices.

Setup Tasks to Complete Before Using Cisco EPN Manager

Before you can use the Cisco EPN Manager features, these tasks should be completed by an administrator:

Table 1. Setup Tasks and References

Tasks to complete before using Cisco EPN Manager

For information, see:

Setup and configure the Cisco EPN Manager server.

Server Setup Tasks

Add devices to Cisco EPN Manager and create device groups to simplify device and network management.

Add and Organize Devices

Enable monitoring for interfaces and technologies used by the network.

Monitor Device and Network Health and Performance

Customize alarm and event behavior for your deployment (for example, alarm and event refresh rates, and e-mail and trap receivers).

Set Alarm and Event Management Preferences

Change Your Password

To change your domain password,

  • Click on the top right of the Cisco EPN Manager window and select Change Password, or go to Administration > Users > Change Password.

  • Enter the Current Password and the New Password. Confirm the new password.

  • Click the Change Password button to save the password.

You have the flexibility to change passwords using this option, irrespective of the server type you are utilizing. This includes LDAP, SSO, RADIUS, TACACS, or local authentication servers.

Use the Main Window Controls

The top left of the Cisco EPN Manager title bar provides the following controls.

Menu button—Toggles the main Cisco EPN Manager navigation menu on the left (also called the left sidebar menu)

Home button—Returns you to the home page (normally the Overview Dashboard)

The right side of the title bar displays your username and the virtual domain you are working in. A virtual domain is a logical grouping of devices. Virtual domains are used to control who has access to the devices and areas of the network. To switch between virtual domains that are assigned to you, see Work In a Different Virtual Domain.

Web GUI global settings—log out, change password, view your Cisco.com account profile, adjust your GUI preferences, check a Cisco.com support case, and so on.

Current Server Time—displays the current server time and date.

Online Help—launches the online help (User and Admin guide) for Cisco EPN Manager.

Refresh—refreshes the page.

Dock—opens a side dock window that displays your recent searches and navigational history.

The Alarm Summary gives you a visual indicator of number of alarms in your network. The color indicates the highest severity alarm.

Alarm Summary—Provides a visual count of alarms in the categories that you specify. Clicking this area opens the Alarm Summary popup window.

When you click the Alarm Summary button, Cisco EPN Manager opens the Alarm Summary popup window. You can customize the data that is displayed in both the button and the pop-up window.

Application Search—Global search tab that can be used to search the entire Cisco EPN Manager database. You can also use the filters for Advanced Search and Saved Search.

Note

 
Application Search cannot be used to search any data under Raw Configuration Archive.

Change Your Default Home Page

You can specify which page you want to display when you perform either of the following tasks:

  • You click from the left side of the web GUI title bar.

  • You log in to the Cisco EPN Manager web GUI.

This setting is saved on a per-user basis. You can change it at any time without affecting other users.

Procedure

Step 1

While you have the page you want displayed, click at the top right of the Cisco EPN Manager web GUI.

Step 2

Choose Set Current Page as Home.

Set Up and Use the Dashboards

Dashboards provide at-a-glance views of the most important data in your network. They provide status, alerts, monitoring, performance, and reporting information. You can customize these dashboards so they contain only the information that is important to you. It may be helpful to set the Network Summary dashboard as your default home page. By doing so, this dashboard is displayed after you log in and you can quickly check overall network health before you do anything else. To set any dashboard as your default home page, see Change Your Default Home Page.

Use the following dashboards to monitor and manage your network:


Note

To view data on the dashboards, you must enable the relevant monitoring policies. By default, only device health monitoring (Device Health monitoring policy) is enabled. See How Device Health and Performance Is Monitored: Monitoring Policies for more information.

Users with administrator privileges can also use the following dashboards (Administration > Dashboards):

Types of Dashboards

The following topics describe the dashboards available in Cisco EPN Manager.

Service Performance Dashboard Overview

From the Service Performance dashboard, you can view the performance statistics for a particular circuit, VC, or service during the time frame you specify. To open this dashboard, choose Dashboard > Service Performance > any of the tabs described in the following table.

Dashboard Tab

Information Provided

CEM

For the selected Circuit Emulation (CEM) circuit, the dashboard displays details, such as

  • name

  • type

  • creation date

  • statistics (you can toggle between the statistics for the circuit's endpoints)

  • number of packets lost during transmission

  • number of packets reordered in the jitter buffer before they reached their destination

  • number of jitter buffer overruns and underruns

  • number of packets ordered incorrectly and subsequently dropped

  • number of malformed packets

  • number of seconds that were errored, severely errored, or unavailable

  • failed events, and

  • dashlets that chart the number of Explicit Pointer Adjustment Relay counters (such L-bits and P-bits) that have been generated and received

    Note

     

    To view these dashlets, both the CEM and Pseudowire Emulation Edge to Edge monitoring policies must be enabled. See Monitoring Policies Reference.

TE Tunnel

For the selected Traffic Engineering (TE) tunnel circuit, the dashboard displays details, such as

  • name

  • type

  • creation date

  • service statistics

  • outgoing traffic,

  • bandwidth utilization

  • reserved bandwidth, and

  • service availability

SR Policy

For the selected Segment Routing (SR) policy, the dashboard displays details, such as

  • name

  • serviceability state

  • associated endpoint

  • service statistics

  • outgoing traffic

  • bandwidth utilization

  • reserved bandwidth, and

  • service availability

CE/L3VPN

For the selected circuit or VC, the dashboard displays details, such as

  • name

  • discovery state, and

  • last modified date

  • inbound and outbound QoS drops

  • service traffic

  • two-way delay

  • one-way jitter

  • service loss, and

  • end-to-end performance statistics for service probes with a cross-launch to the IPSLA dashboard for EVCs or to the Y.1731 dashboard for L3VPN services.

    Note

     

    You can toggle between inbound and outbound data. In the Top N Service QoS Class Traffic dashlet, you can also toggle between pre and postpolicy data.

Top CE/L3VPN

Lists the circuits and VCs with the highest values for parameters, such as

  • delay

  • jitter

  • service loss, and

  • traffic (both inbound and outbound)

You can toggle between CE and L3VPN services information.

Note

 

For large L3VPN circuits with more than 2000 endpoints, this data cannot be displayed.

From release 7.0 onwards, Cisco EPN Manager utilizes the device timestamp data to store and display historical PMON metric records for Cisco NCS 2000 series devices. Previously, local timestamp data was used, which resulted in displaying inaccurate (old) data in the graphs. To avoid false data, always set the device timestamps to the current date and time.


Note

For a description of how to customize the contents and layout of a dashboard tab, see Customize a Dashboard Tab.

Performance Dashboard Overview

From the Performance dashboard, you can view high-level performance metrics for network components such as device, interfaces, QoS policies, and ITU-T Y.1731 probes. To open this dashboard, choose Dashboard > Performance > any of the tabs that are described in the following table.

Dashboard Tab

Information Provided

Device

For the selected device:

  • Device Memory Utilization Trend—displays the memory utilization graphs for the device. You can choose the required time frame and dates from the drop-down/checkboxes (Zoom and Date).

  • Device CPU Utilization Trend—displays the CPU utilization graphs for the device. You can choose the required time frame and dates from the drop-down/checkboxes (Zoom and Date).

  • Device Health information—displays various device health information such as temperature, alarms, events, and reachability. You can choose the required time frame and dates from the drop-down/checkboxes (Zoom and Date).

  • Device Port Summary—displays the port summary. You can click the Down Ports to view details about ports that are down.

  • Device Availability Trend—displays the device availability graphs (against time) for the device. You can choose the required time frame and dates from the drop-down/checkboxes (Zoom and Date).

  • Custom MIB Table View and Custom MIB Graph View—displays custom MIB information (if any).

Interfaces

For the selected interface:

  • Details such as its name, the IP address of the device it is located on, and its configured speed.

  • The average, minimum, and maximum values for the following performance metrics (you can toggle between the metrics collected for inbound and outbound data):

    • Traffic

    • Utilization

    • Errors

    • Discards

    • Cyclic redundancy check (CRC) errors

      Note

       

      CRC error data is not polled by default. To enable the collection of this data, choose a polling frequency for the Interface Health monitoring policy's CRC parameter (see Change the Polling for a Monitoring Policy).

  • Individual graphs that chart the performance metrics listed in the Interface Statistics dashlet

  • Interface availability

  • Top N QoS class map policy graph (inbound and outbound prepolicy rate, postpolicy rate, and drops percentage)

  • QoS class map policy statistics (inbound and outbound)

QoS

For the selected QoS policy:

  • Summary information

  • Statistics and graphs for prepolicy, postpolicy, and dropped class map traffic.

  • Statistics and graphs for conforming, exceeding, and violating class map traffic

IP SLA

For Layer 3 services on the selected probe:

  • Summary information

  • IP Service Level Agreement (SLA) statistics

  • Delay, jitter, and frame loss between endpoints

  • Endpoint availability

Y1731

For Layer 2 services on the selected probe:

  • Summary information

  • ITU-T Y.1731 statistics

  • Delay, jitter, frame loss, and CCM frame loss between endpoints

  • Jitter Bins Statistics

  • Delay Bins Statistics

  • Endpoint availability

Note

 

Bins statistics data is not polled by default. To enable the collection of this data, choose a polling frequency for Bins Statistics parameters in IP SLA Y.1731 Monitoring Policy (see Change the Polling for a Monitoring Policy).

Optical SFPs

For the selected Small Form-Factor Pluggable (SFP) Transceiver Module interface:

  • Details such as its name, the name, and IP address of the device on which the interface is located, and its configured speed.

  • The average, minimum, and maximum values for the following operating metrics for a device:

    • Optical input and output power

    • Operating temperature

    • Transceiver supply voltage

    • Laser bias current

    For the selected Quad Small Form-Factor Pluggable (QSFP) Transceiver Module interface:

    Individual lane average, minimum, and maximum values for:

    • Temperature

    • Voltage

    • Current

    • Tx power

    • Rx power

  • Individual graphs that chart the operating metrics listed in the SFP Statistics dashlet

SONET/TDM Interfaces

For the selected SONET or time-division multiplexing (TDM) interface:

  • Details such as its name, configured speed, and the IP address of the device it is located on.

  • The average, minimum, and maximum values for the following performance metrics:

    • Interface Details

    • Interface Statistics

    • Severely Errored Seconds

    • Unavailable Seconds

    • Errored Seconds

    • P-bit Severely Errored Seconds

    • CP-bit Severely Errored Seconds

    • Code Violations

    • C-bit Errored Seconds

    • Severely Errored Framing Seconds

    • C-bit Code Violations

    • Controlled Slip Seconds

    • Bursty Errored Seconds

    • Degraded Minutes

    Values are provided for both the near-end (the receiving end) and far-end (the transmitting end) of the interface.

  • Individual graphs that chart the performance metrics listed in the SONET/TDM Statistics dashlet

Device Sensors

For each sensor of the selected device:

  • Sensor Name

  • Sensor Description

  • Equipment Name

  • Type

  • Current value

  • Unit

  • Status

Click the i icon on the current value to view the trend over last 6 hours.

MPLS Links Latency

You can get the following details for the link you select:

  • Link details such as the link name, endpoint device and interface.

  • Link delay (one-way and two-way).

Note

 

You can click Link Name in the Top N MPLS Links Table to launch the MPLS links dashboard on the selected link.

Note the following:

Network Summary Dashboard Overview

The Network Summary dashboard alerts you to the most important issues currently affecting your network. It also collects metrics from various sources to display a set of key performance indicators (KPIs). To open this dashboard, choose Dashboard > Network Summary > any of the tabs described in the following table.

Dashboard Tab

Information Provided

Network Devices

  • Status (ICMP reachability, SNMP reachability, device manageability), system health, and alarm summary metric dashlets

    Note the following:

    • To open a pop-up window that describes the information provided by a metric dashlet, place your cursor over its name and then click the ? icon.

    • To open a page that lists the alarms or devices that correspond to a particular metric, click a dashlet value. For example, if the SNMP Reachability Status dashlet indicates that 50 devices are currently reachable via SNMP, click 50 to open the Network Devices page and view a listing of these devices.

  • Top N devices by CPU utilization, memory utilization, and environmental temperature

    For the Top N Environmental Temperature dashlet, note the following:

    • Two temperature values are provided for each device: its highest recorded internal temperature (displayed in the Max Inlet Temp column) and its highest recorded ambient temperature (displayed in the Max Other Temp column). By default, devices are sorted by their internal temperature.

    • To identify the sensor that recorded a particular temperature value, place your cursor over its i (information) icon.

Incidents

  • System health and alarm summary metric dashlets

    Note the following:

    • To open a pop-up window that describes the information provided by a metric dashlet, place your cursor over its name and then click the ? icon.

    • To open a page that lists the alarms that correspond to a particular metric, click a dashlet value. For example, if the Alarm Summary dashlet indicates that 12 critical alarms have been raised in your network, click 12 to open the Alarms page and view a listing of these alarms.

  • Alarm count for the entire network and the Cisco EPN Manager server

  • Top N alarm types

  • Syslog summary

  • Top N event types and their count

  • Top N devices by number of syslogs sent

  • Syslog details such as the corresponding device, severity, and message text

  • Top N devices by number of alarms raised

Top N Interfaces

For the selected port group:

  • Interface availability and utilization summaries

  • Top N devices by interface traffic, errors and discards, cyclic redundancy check (CRC) errors, and utilization

    Note

     

    CRC error data is not polled by default. To enable the collection of this data, choose a polling frequency for the Interface Health monitoring policy's CRC parameter (see Change the Polling for a Monitoring Policy).

  • Bottom N devices by interface availability

Also note that the dashlets in this tab (except for the summary dashlets) allow you to open the 360 view for a device's adjacent device or interface by clicking its i (information) icon.

Top N QoS

For the selected port group:

  • Top N devices by QoS prepolicy, postpolicy, and drop rates

  • Top N devices by conforming, exceeding, and violating traffic rates

You can toggle between inbound and outbound traffic data.

Top N Y1731

Endpoints with the highest values for the following parameters:

  • Delay (one-way and two-way)

  • Jitter (one-way and two-way)

  • Frame loss

Top N MPLS Links Latency

  • Delay (one-way and two-way)

Note

 
You can click Link Name in the Top N MPLS Links Table to launch the MPLS links dashboard on the selected link.

PTP/SyncE

  • PTP Clock Class over time

  • Servo State over time

  • SyncE Quality Level over time

Note

 

Cisco EPN Manager uses the values that you have configured in the PTP/SyncE System Settings page to display data in the dashboard. See PTP/SyncE Dashboard Settings for more information.

GNSS

  • GNSS Module Satellite ID and SNR details

You can view specific data by adding or removing columns in the dashlets. In the Top N Interfaces, Top N QoS, and Top N Y1731 tabs, you can also use the Sort by option to sort the data displayed in the columns.

In the Top N Interfaces and Top N QoS tabs you can:

  • Choose a specific device group and/or port group to view only information for those devices/ports.

    • To filter data for all the dashlets based on port/device groups, use the Port Groups filter at the top of the dashboard.

    • To filter data for a specific dashlet only, click the dashlet's Edit icon and choose a device/port group from the Port Groups and/or Device Groups drop-down list.

  • Filter the data in the dashlets by Class Map (and you can choose to exclude the class-default).

  • Filter the data in the dashlets using the Time Frame (default is Past 6 hours).

  • Click an interface's name link to view performance information for that interface in the Performance dashboard. If you click a link in the Top N Interfaces tab, the Interfaces tab opens. If you click a link in the Top N QoS tab, the QoS tab opens instead.

  • Interface monitoring is not enabled by default. For information on how to check this, see Check What Cisco Evolved Programmable Network Manager Is Monitoring.

  • For a description of how to customize the contents and layout of a dashboard tab, see Customize a Dashboard Tab.

PTP/SyncE Dashboard Settings

To configure metrics that are used by Cisco EPN Manager to display data in the PTP/SyncE dashboard, navigate to Administrator > System Settings > Performance > PTP/SyncE. Configure the metrics as required and click Save.

Section Description Action

PTP Clock Class

 Allows you to define the range of values of PTP Clock Class that should be reported as Ok or Degraded or Failure. Enter values from the entire range of 0–255. Ensure that there is no overlap in values between the three categories.
PTP Servo State Allows you to define how Cisco EPN Manager reports each of the five possible PTP Servo states. Configure each of the five states in this section to Ok or Degraded or Failure.
SyncE Quality level Allows you to define the SyncE quality levels that Cisco EPN Manager reports as Ok. By default, Cisco EPN Manager allows you to define two values as Ok. You can add a third value if required by selecting the check-box next to the grayed out field. Any other SyncE QL values apart from the ones that you have defined as Ok is reported as Degraded. Choose a value from the drop-down list.
UTC Offset You can define the correct UTC offset in the system. Cisco EPN Manager reports the devices configured with the matching value of UTC offset as Correct UTC offset and devices configured with offset not matching this value as Incorrect UTC Offset. Enter a value between 0–65535.

DWDM/OTN Performance Dashboard Overview

The DWDM/OTN Performance dashboard displays performance information for the Dense Wavelength Division Multiplexing (DWDM) and Optical Transport Network (OTN) interfaces that are traversed by a specific circuit. This includes Circuit, Optical physical, Optical Data Unit (ODU), Optical Transport Unit (OTU), Ethernet, Synchronous Optical Network (SONET), and Synchronous Digital Hierarchy (SDH) interfaces.

To open this dashboard, perform one of the following actions:

  • Choose Dashboard > DWDM/OTN Performance > Circuit. Click an interface name in the Interfaces dashlet. The relevant tab for the type of interface opens. For example, if you click an OTU interface, the OTU tab opens.

  • From an Interface 360 view, choose View > Performance.


Note
For IOS-XR devices, the dashboard displays performance information of the collected OTN 15 mins interface or the chosen specific OTN 15 mins parameter. The different parameters are:

  • OTU FEnd

  • OTU NEnd

  • ODU FEnd

  • ODU NEnd

  • OTN GFP

  • OTN FEC

Note the following:

How to Use the Dashboards

The following figure illustrates the key parts of a dashboard window and the controls that you can use to adjust them.

Table 2. Dashboard Elements

1

Dashboard filters—Filters all dashlets in the dashboard according to the selection. In this example, a time-based filter is used. The filters displayed depend on the dashboard type. For example, in the performance dashboards, you must select a specific interface, device, circuit, or VC.

2

Metric dashlets—Provides quick metrics for alarms, available devices, and so forth.

3

Dashboard settings and controls:

  • Dashboard icons—Allows you to launch online help, refresh the entire dashboard, and open the Dock window.

  • Dashboard Settings menu—Allows you to add or rename a dashboard tab, add new dashlets (both standard and metric), adjust the dashboard's layout, reset all dashboards to their default settings, and export data from the selected dashlets.

    Note

     

    The newly added or a renamed dashboard tab can be viewed only in the Tab view. This change is not reflected in the Dashboard menu.

4

Standard dashlets—Provides at-a-glance data that is relevant to the dashboard.

The top-right corner of each dashlet has icons that are activated when you use that dashlet. The dashlet type determines the icons that are available. The most common icons are displayed in the following figure:

1

Edit icon—Click to change a dashlet's properties, such as its title, refresh interval, and the number of devices that are displayed (applicable only to Top N and Bottom N dashlets).

2

Help icon—Click to open a pop-up window that describes the dashlet, indicates the monitoring policy that must be activated to collect data by the dashlet, and lists the filters that can be applied to the dashlet.

3

Refresh icon—Click to refresh the information displayed in the dashlet.

4

Collapse/Expand icon—Click to toggle between a maximized and minimized dashlet.

5

Close icon—Click to remove the dashlet from the dashboard.

The bottom-left corner of each dashlet has icons that can be used to change the display type of the data and export them. The most common icons are given in the following table:

Icon

Description

  • Chart View—Click to view the dashlet information as a chart.

  • Table View—Click to view the dashlet information as a table.

Chart Type—Click to choose the type of chart a dashlet displays (such as displaying a unique fill pattern for each element).

Actions—Click to print the information provided by the dashlet or export the information.

You can also see the current date, time, and time zone, which is displayed in the standard time format of DD-MMM-YYYY hh:mm:ss AM/PM Z, where Z is the time zone.

Add a New Dashboard

Use this procedure to create a new dashboard. Your new dashboard appears as a new tab under one of the dashboards listed in Types of Dashboards.

Procedure

Step 1

Open the relevant existing dashboard.

For example, if you want to create a new tab under the Performance dashboard, click any tab under Dashboard > Performance.

Step 2

Click the Settings menu and choose Add New Dashboard.

Step 3

Enter a name for the new dashboard and click Apply .

Step 4

Click the new dashboard tab, and then add dashlets as described in Add a Predefined Dashlet To a Dashboard.

Customize a Dashboard Tab

To customize a tab in any of the dashboards that Cisco EPN Manager provides, complete the following procedure:
Procedure

Step 1

Choose the dashboard tab that you want to customize.

For example, if you want to customize the Performance dashboard's Device tab, choose Dashboard > Performance > Device.

Step 2

Adjust the dashboard tab as needed.

You can perform the following actions:

  • Drag dashlets to a different location on the dashboard.

  • From the tab's Settings menu, rename a tab, add new dashlets (see Add Dashlets to Dashboards), and change the tab's layout.

    The newly added or renamed dashboard tab can be viewed only in the Tab view. This change is not reflected in the Dashboard menu.

    Note

     

    To open a pop-up window that provides an overview of a dashlet you are thinking about adding, expand the Add Dashlets drop-down list, locate the dashlet, and then hover your cursor over its name.

  • Use the filters to specify the information you want to view and the appropriate time frame, then click Apply.

Step 3

If necessary, troubleshoot why the tab is not displaying any data.

See Find Out Why Data is Missing from a Dashboard for more information.

Add Dashlets to Dashboards

You can add two types of dashlets to your dashboards:

  • Prepackaged dashlets that are provided with Cisco EPN Manager—Some of the dashlets are displayed on dashboards by default; others are listed in the Settings menu, and you can add them as needed. These dashlets provide information you will likely monitor (for example, device CPU utilization, interface errors and discards, and traffic statistics). See Add a Predefined Dashlet To a Dashboard.

Add a Predefined Dashlet To a Dashboard

Cisco EPN Manager provides a predefined set of dashlets that provides you with commonly sought network data. By default, a subset of these dashlets is already included in the dashboards, to help you get started. Complete the following procedure to add another of these predefined dashlets to your dashboards.


Note

To edit or remove a dashlet, click the appropriate icon from the top-right corner of that dashlet. (See How to Use the Dashboards.)

Procedure

Step 1

From the sidebar menu, choose Dashboard, then select the dashboard you want to add a dashlet to.

For example, to add a Device Memory Utilization dashlet to the Device dashboard, choose Dashboard > Performance > Device.

Step 2

Identify the dashlet that you want to add, then add it:

  1. From the top-right corner of the dashboard, click Settings and then click Add Dashlet(s). Cisco EPN Manager lists the dashlets that can be added to that dashboard.

  2. To open a pop-up window that provides an overview of a particular dashlet, hover your cursor over dashlet's name. The pop-up window also lists the sources for the data that the dashlet provides and the filters you can apply to the dashlet.

  3. Click Add to add the selected dashlet to the dashboard.

Step 3

Verify that the dashlet is populated with data.

If it is not, check whether the required monitoring policy is enabled. (Only the Device Health monitoring policy is enabled by default. It checks device availability, CPU and memory pool utilization, and environmental temperature.)

  1. From the top-right corner of the dashlet, click its ? (Help) icon to open the dashlet's pop-up window.

  2. Check the information provided in the Data Sources area. If it lists a monitoring policy, check whether the policy is activated. See Check What Cisco Evolved Programmable Network Manager Is Monitoring.

Customize the Dock Window

Use the Dock window for quick navigation to frequently used web GUI pages and pop-up windows (such as the 360 view for a particular device). From here, you can also access links to the 15 most recently visited pages and Cisco EPN Manager training materials. To open this window, click the Dock icon (located in the top right area of the page).

Complete the following procedure to update the links provided in the Dock window:

Procedure

Step 1

Add a web GUI page link to the Favorites tab (Dock icon > Links Visited > Favorites):

  1. Open the web GUI page you want to add.

  2. Click its star (Favorite) icon, which is located in the top left area of the page.

Step 2

Add a pop-up window link to the Docked Items area (Dock icon > Docked Items):

  1. Open the pop-up window you want to add, then open its 360 view.

  2. From the top right corner of the pop-up window, click the Add to Dock icon.

Find Out Why Data Is Missing from a Dashboard

If data is missing from a dashboard or dashlet, Cisco EPN Manager displays possible reasons in an error message in the dashlet such as:

  • Monitoring policy not enabled

  • Unmanaged or unreachable devices in the system

  • Technology isn’t supported on the device

  • Inaccurate server time or server time not synced with the device

Perform the following steps to identify the cause:

Procedure

Step 1

Check whether the dashlet data is filtered.

If you see Edited next to the dashlet name, do the following:

  1. Click the Edit icon and adjust the current filter settings.

  2. Click Save and Close.

Step 2

Check whether there is a problem with the device.

See Get Basic Device Information: Device 360 View.

Step 3

Check whether the device inventory is being collected properly.

See Find Devices With Inventory Collection or Discovery Problems.

Step 4

Check whether Cisco EPN Manager is collecting the required data by viewing the monitoring policies it is using:

  1. Open the dashlet's overview pop-up window by clicking its Help icon.

  2. Note the monitoring policy listed under Data Sources.

    Monitoring policies are described in Monitoring Policies Reference.

  3. Verify that this policy is listed and active in the Monitoring Policies page.

    To open this page, choose Monitor > Monitoring Tools > Monitoring Policies, then choose My Policies.

    • If the policy is not listed, proceed to Step 4d.

    • If the policy is listed and its status is Active, click Details to open the Collection Data pop-up window and see if the device is being monitored by the policy. If it is not, you must adjust the policy as described in Change the Device Set a Policy is Monitoring. If the device is included in the policy, proceed to Step 5.

    • If the policy is listed and its status is Inactive, select the policy and click Activate.

  4. Create a new monitoring policy and activate it.

    See Adjust What Is Being Monitored.

Step 5

Check whether the relevant data was purged from the system.

See How Data Retention Settings Affect Web GUI Data.

Work In a Different Virtual Domain

Virtual domains are logical groupings of devices and are used to control your access to specific sites and devices. Virtual domains can be based on physical sites, device types, user communities, or any other designation the administer chooses. All devices belong to ROOT-DOMAIN, which is the parent domain for all new virtual domains. For more information about virtual domains, see the Create Virtual Domains to Control User Access to Devices .

If you are allowed access to more than one virtual domain, you can switch to a different domain by completing the following procedure:

Procedure

Step 1

Click from the right side of the title bar.

Step 2

Choose Virtual Domain: current-domain .

Step 3

From the Virtual Domain drop-down list, choose a different domain.

Cisco EPN Manager immediately changes your working domain.

Manage Jobs Using the Jobs Dashboard

If you have the appropriate user account privileges, you can manage Cisco EPN Manager jobs using the Jobs dashboard. To view the Jobs dashboard, choose Administration > Dashboards > Job Dashboard. From here, you can quickly see if a job was successful, partially successful, or failed.

If too many jobs are already running, Cisco EPN Manager will hold other jobs in the queue until resources are available. If this delays a scheduled job past its normal starting time, the job will not run. You will have to run it manually.

Some jobs may require approval. In such cases, Cisco EPN Manager sends an email to users with Administrator privileges notifying them that a job was scheduled and needs approval. The job will only run after it is approved. See Configure Job Approvers and Approve Jobs.

You can set a time interval at which the jobs table is auto-refreshed. Click Settings in the upper corner of the page, select a value from the drop-down list in the field Set Auto Refresh Rate and click Save.


Note

  • To disable auto-refresh of the jobs table, select OFF from the drop-down list.

  • When scheduling jobs with monthly or yearly recurrence:

    • Always select valid dates. For example, ensure the “fourth Saturday” exists every month, or avoid February 29 except in leap years.

    • The system does not check for invalid date selections. If you select an unavailable date, the job status becomes "undefined" and will not run.

    • If you see an "undefined" job status, check and correct your recurrence settings.

      Example: Scheduling on the “fifth Tuesday” may fail in months without one.

The following table describes the buttons displayed in the Jobs dashboard.

Table 3. Jobs Dashboard Buttons

Button

Description

Delete Job

Removes a job from the Jobs dashboard.

Edit Job

Edit the settings configured for the selected job.

Edit Schedule

Displays the series schedule and lets you edit it (start time, interval, and end time).

Note

 

Editing the schedule of an already-scheduled job will change the status of that job to Pending for Approval since each edit requires an approval from the user who created the job.

Run

Runs a new instance of the selected job. Use this to rerun partially successful or failed jobs; the job will only run for the failed or partially successful components.

Abort

Stops a currently-running job, but allows you to rerun it later. Not all jobs can be aborted; Cisco EPN Manager will indicate when this is the case.

Cancel Series

Stops a currently-running job and does not allow anyone to rerun it. If the job is part of a series, future runs are not affected.

Pause Series

Pauses a scheduled job series. When a series is paused, you cannot run any instances of that series (using Run).

Resume Series

Resumes a scheduled job series that has been paused.


Note

The Delete Job, Abort, and Cancel Series buttons are not available for system and poller jobs.


Note

If you have logged in as a root user, then you can view all the jobs under Job Dashboard. If you have logged in as a non-root user, then you can only view the jobs performed by you.

To view the details of a job, follow these steps:

Procedure

Step 1

Choose Administration > Dashboards > Job Dashboard.

Step 2

From the Jobs pane, choose a job series to get basic information (such as job type, status, job duration, and next start time).

Step 3

To view the job interval, click a job instance hyperlink.

At the top of the job page, the Recurrence field indicates how often the job recurs. Job interval details will be added for every job that triggers. The job details page is refreshed every 5 seconds until the job is completed.

Step 4

To get details about a failed or partially successful job, click the job instance hyperlink and expand the entries provided on the resulting page.

This is especially helpful for inventory-related jobs. For example, if a user imported devices using a CSV file (a bulk import), the job will be listed in the Jobs sidebar menu under User Jobs > Device Bulk Import. The job details will list the devices that were successfully added and the devices that were not.

Example

To troubleshoot a failed software image import job:

  1. Choose User Jobs > Software Image Import from the Jobs sidebar menu.

  2. Locate the failed job in the table and then click its hyperlink.

  3. Expand the job's details (if not already expanded) to view the list of devices associated with the job and the status of the image import for each device.

  4. To view the import details for a specific device, click that device's i (information) icon in the Status column. This opens an Image Management Job Results pop-up window.

  5. Examine each step and its status. For example, the Collecting image with Protocol: SFTP column might report that SFTP is not supported on the device.

Change User Preferences

To change the User Preferences, click the  icon at the top-right corner of the screen, and choose My Preferences > General.

Category

User Preference Setting

Description

List pages

Items Per Page List

Use this setting to define the number of entries displayed on the Monitoring pages for APs, Controllers, Site Maps, Roles & AAA > Active Sessions.

By default, 50 entries are listed.

Note

 
This setting does not apply to Network Devices, Alarms and Events, configuration archive, software image management, or configuration.

Network Topology

Automatically switch device group selection to show all participating devices

Use this setting to automatically switch device group selection to view all participating devices in topology view. By default, this setting is not enabled.

Auto-Refresh Interval (Map, Tables)

Use this setting to define the time interval at which the maps and tables in the network topology view are refreshed. You can set the refresh interval to 30 seconds, 1 minute, 2 minutes, or 5 minutes. Select No auto-refresh if you do not want to refresh the maps and tables.

By default, the refresh interval is 1 minute.

Service Provisioning

Default Technology

Use this setting to define the Technology that is selected by default when you go to the service provisioning page to create a new service.

Note

 

If this user preference is not set, Carrier Ethernet will be set as the default value.

Default Service Type

Use this setting to define the Service Type that is selected by default when you go to the service provisioning page to create a new service.

Note

 

If this user preference is not set, Access EPL will be set as the default value.

Chassis View Configuration

UI Refresh Interval

Use this setting to define how often the data in the UI is refreshed in the chassis view.

By default, the UI refresh interval is 1 minute.

Chassis racks to display

Use this setting to define the number of chassis racks Cisco EPN Manager should display.

By default, this value is 2.

Device Inventory List View

Device List Table Refresh Interval

Use this setting to define the time interval at which the table in the Network Devices page is refreshed. You can set the refresh interval to 1 minute, 2 minutes, 5 minutes, 10 minutes, 15 minutes, or 30 minutes. Select Do not refresh if you do not want to refresh the table.

The default value of this setting is Do not refresh.

Mobility Services Engine

Use MSE Admin View

By default, this setting is enabled.

User Idle Timeout

Logout all idle users after

Use this setting to define whether an idle user should be automatically logged out. To use this, navigate to Administration > Settings > System Settings > General > Server > Global Idle Timeout. By default, the value is 15 minutes.

After you make the desired changes, click Save to apply your changed settings.

To clear the page level customization and setting, click Clear GUI State Settings on the top-right corner of the EPNM window. This deletes the custom settings that are made to Network Summary Dashboard, Performance Graphs, Network Devices, and so on, pages and refreshes the application to the default values.

For information about user preference settings in Alarms and Events, see Set Up Your Alarm and Event Display Preferences.

Extend Cisco EPN Manager Functions

Advanced users can extend Cisco EPN Manager using the following tools:

  • Cisco EPN Manager MTOSI API—Integrates Cisco EPN Manager with your Operations Support System (OSS).

  • Cisco EPN Manager REST API—Manages additional administrative operations.

To get information about these tools, click from the right side of the title bar and then choose Help > API Help. You can also download the following documents from Cisco.com:

Secure User Inputs to Prevent XSS Vulnerabilities

Cross-site Scripting (XSS) is a security vulnerability that allows attackers to inject malicious scripts into applications. These scripts can be used to steal information or perform other malicious actions. To safeguard the Cisco EPN Manager, it is crucial to avoid certain patterns in user input fields and POST/PUT payloads.

The following patterns have been identified as vulnerable and are blocked by the Cisco EPN Manager's XSS prevention feature. The Cisco EPN Manager will not execute the command or proceed to the next step if it finds these patterns; therefore, ensure they are not used in user inputs or API calls.

  • src=’…’ (multiline, case insensitive pattern): Avoid using src= followed by any text or newline within single quotes. For example, <img src='malicious_code'>.

  • src=”…” (multiline, case insensitive pattern): Avoid using src= followed by any text or newline within double quotes. For example, <img src="malicious_code">.

  • </script> (case insensitive pattern): Avoid using the closing script tag in any form.

  • <script…> (multiline, case insensitive pattern): Avoid using the opening script tag with any content inside.

  • eval(…) (multiline, case insensitive pattern): Avoid using the eval function in any context. For example, eval('malicious_code').

  • expression(…) (multiline, case insensitive pattern).

  • javascript: (case insensitive pattern): Avoid using javascript: protocol in any field.

  • vbscript: (case insensitive pattern): Avoid using vbscript: protocol.

  • onload…= (multiline, case insensitive pattern): Avoid using event handlers like onload in any of the fields.

  • <…> (multiline, case insensitive pattern).

  • <script…/script> (multiline, case insensitive pattern): Avoid any complete script tags with content.

Check Cisco.com for the Latest Cisco EPN Manager Documentation

Refer to Cisco Evolved Programmable Network Manager Documentation Overview for information about and links to all of the documentation that is provided with Cisco EPN Manager.


Note
We sometimes update the documentation after original publication. Therefore, you should also review the documentation on Cisco.com for any updates.