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.
Note | If you are an administrator and need to set up Cisco EPN Manager for its initial use, see Server Setup Tasks. |
Before you can use the Cisco EPN Manager features, these tasks should be completed by an administrator:
Tasks to completed before using Cisco EPN Manager |
For information, see: |
---|---|
Set up and configure the Cisco EPN Manager server. |
|
Add devices to Cisco EPN Manager and create device groups to simplify device and network management. |
|
Enable monitoring for interfaces and technologies used by the network. |
|
Customize alarm and event behavior for your deployment (for example, alarm and event refresh rates and e-mail and trap receivers). |
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
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 server’s security certificate. 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 EPN Manager—Describes all classes of users supported byCisco EPN Manager , including the various CLI user accounts.
Types of User Groups—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.
You can change your password at any time by clicking at the top right of the Cisco EPN Manager window and choosing Change Password. Click the information icon to review the password policy.
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 user name 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 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 button—Log out, change password, view your Cisco.com account profile, adjust your GUI preferences, check a Cisco.com support case, launch online help |
When you click on the right side of the title bar, the window settings menu opens.
Finally, 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 you specify. Clicking this area opens the Alarm Summary popup window. |
When you click the Alarm Summary button (circled in the following figure), 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. In this example, the button displays a count for Switches and Hubs and System alarms, and the Alarm Summary pop-up to show all of the alarm categories listed in the following illustration.
You can specify which page you want to display when you perform either of the following tasks:
This setting is saved on a per-user basis. You can change it at any time without affecting other users.
Dashboards provide at-a-glance views of the most important data in your network. They provide status as well as 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:
Network Summary dashboard—To check the health of the entire network. See Network Summary Dashboard Overview.
Service Performance dashboard—To monitor Carrier Ethernet and optical service performance. See Service Performance Dashboard Overview.
Performance dashboard—To view high-level performance metrics for network components such as interfaces, QoS policies, and ITU-T Y.1731 probes. See Performance Dashboard Overview.
Device Trends dashboard—To view performance information for a specific device, application, or service. See Device Trends Dashboard Overview.
DWDM/OTN Performance dashboard–—To view performance information for the dense wavelength division multiplexing (DWDM) and Optical Transport Network (OTN) interfaces in your network. See DWDM/OTN Performance Dashboard Overview.
Users with administrator privileges can also use the following dashboards:
Licensing dashboard—See View the Licensing Dashboard.
Jobs dashboard—See Manage Jobs Using the Jobs Dashboard.
System Monitoring dashboard—See Check Cisco EPN Manager Server Health, Jobs, Performance, and API Statistics Using the System Monitoring Dashboard.
Note the following:
For an explanation of the parts of the dashboard window and how to use dashboard filters, see How to Use the Dashboards.
To troubleshoot dashboard data issues, see Find Out Why Data is Missing from a Dashboard.
The following topics describe the dashboards available in Cisco EPN Manager.
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 any of the tabs described in the following table.
Note the following:
Interface monitoring is not enabled by default. For information on how to check this, see Check What Cisco EPN Manager Is Monitoring.
For a description of how to customize the contents and layout of a dashboard tab, see Customize a Dashboard Tab.
From the Performance dashboard, you can can view high-level performance metrics for network components such as interfaces, QoS policies, and ITU-T Y.1731 probes. To open this dashboard, choose any of the tabs described in the following table.
Note the following:
Interface monitoring is not enabled by default. For information on how to check this, see Check What Cisco EPN Manager Is Monitoring.
For a description of how to customize the contents and layout of a dashboard tab, see Customize a Dashboard Tab.
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 any of the tabs described in the following table.
Note the following:
In the Top N Interfaces and Top N QoS tabs, you can choose a specific port group to view information for:
If you choose a port group using a tab's Port Groups filter, all of the dashlets in that tab display information for the selected group.
If you click a dashlet's Edit icon and choose a port group from the Port Groups drop-down list, information for the selected group is displayed in just that dashlet.
To determine if a particular dashlet is displaying information for a specific port group or all port groups, view the Input of port group - field.
In the Top N Interfaces and Top N QoS tabs, you can 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 EPN Manager Is Monitoring.
For a description of how to customize the contents and layout of a dashboard tab, see Customize a Dashboard Tab.
From the Device Trends dashboard, you can view performance information for a specific device, application, or service. To open this dashboard, choose any of the tabs described in the following table.
Dashboard Tab |
Information Provided |
---|---|
Device |
For the selected device: |
Application |
For the selected application or service: |
Note the following:
Interface monitoring is not enabled by default. For information on how to check this, see Check What Cisco EPN Manager Is Monitoring.
For a description of how to customize the contents and layout of a dashboard tab, see Customize a Dashboard Tab.
From the DWDM/OTN Performance dashboard, you can view performance information for the dense wavelength division multiplexing (DWDM) and Optical Transport Network (OTN) interfaces in your network. This includes physical, optical data unit (ODU), optical transport unit (OTU), Ethernet, Synchronous Optical Network (SONET), and Synchronous Digital Hierarchy (SDH) interfaces. To open this dashboard, do one of the following:
Choose
.With an interface's 360 view open, choose
.If you open the DWDM/OTN Performance dashboard using the first method, you also need to choose an interface from the Interface drop-down list. The dashlets provided by the dashboard will vary, depending on the type of interface you choose.
Note the following:
The Circuits drop-down list is disabled, so you cannot use it to filter the information provided by this dashboard.
Interface monitoring is not enabled by default. For information on how to check this, see Check What Cisco EPN Manager Is Monitoring.
For a description of how to customize the contents and layout of a dashboard tab, see Customize a Dashboard Tab.
The following figure illustrates the key parts of a dashboard window and the controls you can use to adjust them.
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:
|
4 |
Standard dashlets—Provides at-a-glance data that is relevant to the dashboard. |
At the top right corner of each dashlet are 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 so forth. |
2 |
Help icon—Click to open a pop-up window that describes the dashlet, indicates the monitoring policy that needs to be activated in order for the dashlet to collect data, and lists the filters that can be applied to the dashlet. |
3 |
Refresh icon: Click to refresh the information displayed in the dashlet. |
4 |
Detach icon—Click to move the dashlet to another location in the dashboard. |
5 |
Collapse/Expand icon—Click to toggle between a maximized and minimized dashlet. |
6 |
Close icon—Click to remove the dashlet from the dashboard. |
See these topics for additional information on dashboards:
Use this procedure to create a new dashboard. Your new dashboard will appear as a new tab under one of the dashboards listed in Types of Dashboards.
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 . |
Step 2 | Click the + (Add New Dashboard) tab.
The Settings menu opens. |
Step 3 | Enter a name for the new dashboard, then click Apply. |
Step 4 | Click the new dashboard tab, then add dashlets as described in Add a Predefined Dashlet To a Dashboard. |
Step 1 | Choose
the dashboard tab you want to customize. For example, if you want to customize the Performance dashboard's BNG tab, you would choose . | ||
Step 2 | Adjust the dashboard tab as needed.
You can do things like:
| ||
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. |
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.
Customized dashlets that you create to monitor device performance—These dashlet types can only be added to the Device Trends dashboard. See Add a Customized Dashlet to the Device Trends Dashboard.
Cisco EPN Manager provides a predefined set of dashlets that will provide 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.) |
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 Trends dashboard, choose . |
Step 2 | Identify the dashlet you want to add, then add it: |
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.)
|
If none of the dashlets in the Device Trends dashboard provide the device performance information you need, you can add a dashlet that uses a customized template to poll devices for their SNMP MIB attributes. Complete the following procedure to add this dashlet to the dashboard.
Check the available monitoring policies to determine which policy collects the information you need. You will have to specify a policy during the dashlet creation process. If none of the policies meet your needs, you can create a policy that polls new parameters. See Create a Monitoring Policy for Unsupported Parameters and Third-Party Devices.
Step 1 | Choose . |
Step 2 | From the top right corner of the dashboard, click Settings and then choose Add Dashlets. |
Step 3 | Expand the Device Dashlets list. |
Step 4 | Locate Generic Dashlet, then click Add. Cisco EPN Manager
adds a blank generic dashlet to the Device Trends dashboard. |
Step 5 | Configure the new dashlet as needed. At a minimum, you should:
|
Step 6 | Click Save and Close.
If no data is displayed in the dashlet, see Find Out Why Data is Missing from a Dashboard. |
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:
If data is missing from a dashboard or dashlet, perform the following steps to identify the cause:
Step 1 | Check whether the dashlet data is filtered.
If you see Edited next to the dashlet name, do the following:
|
Step 2 | Check whether there is a problem with the device. |
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: |
Step 5 | Check whether the relevant data was purged from the system. |
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 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:
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 . 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. If this is the case, 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 .
The following table describes the buttons displayed in the Jobs dashboard.
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). |
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. |
To view the details of a job, follow these steps:
Step 1 | Choose . |
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. |
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 . The job details will list the devices that were successfully added and the devices that were not. |
To troubleshoot a failed software image import job:
Choose Jobs sidebar menu.
from theLocate the failed job in the table and then click its hyperlink.
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.
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.
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.
Advanced users can extend Cisco EPN Manager using the following tools:
To get information about these tools, click from the right side of the title bar and then choose
. You can also download the following documents from Cisco.com:Refer to the 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. |