Cisco Evolved Programmable Network Manager API
Evolved Programmable Network Manager API Documentation

REST API Resources

BNG IP Pool Statistics

The BNG IP Pool Statistics provide performance information about IP Pool.

Resource Description
GET BNG IP Pool Details Fetch BNG IP Pool instances on all managed devices, or on a specific device.
GET BNG IP Pool Metric Data Fetch performance data for the given metric on the selected BNG IP Pool instance.
GET BNG IP Pool Metrics Fetch all available metrics for this BNG IP Pool instance.

BNG Sessions Statistics

The BNG Sessions Statistics provide performance information about Sessions.

Resource Description
GET BNG Sessions Details Fetch Bng Sessions instance on all managed devices, or on a specific device.
GET BNG Sessions Metric Data Fetch performance data for the given metric on the selected Bng Session instance.
GET BNG Sessions Metrics Fetch all available metrics for this Bng Sessions instance.

CEM Statistics

The CEM Statistics provide performance information about policy.

Resource Description
GET CEM Details Fetch CEM polices on all managed devices, or on a specific device.
GET CEM Metric Data Fetch performance data for the given metric on the selected CEM instance.
GET CEM Metrics Fetch all available metrics for this CEM instance.

CLI Template Configuration

The CLI Template Configuration service allows a CLI configuration template to be applied to one or more target devices. It also provides a way to upload, delete, and get the CLI templates in the system.

Resource Description
DELETE Delete Configuration Template Deletes a template from the system.
GET Download Configuration Template
Deprecated

Please use the CLI Configuration Templates resource instead. This operation may be removed in a future release.

Export a template from the system.
GET List Configuration Templates
Deprecated

This operation does not support pagination, filtering, or sorting. Please use the CLI Configuration Templates resource instead. This operation may be removed in a future release.

Get a list of the published Templates
GET List Device Types Returns the list of device types you can specify for a CLI template.
POST Upload Configuration Template Upload a new template into the system. Does not support Converged Access Templates (IOS-XE templates and templates created from them).
PUT Deploy Configuration Template
Deprecated

This resource deploys templates in a synchronized way which may take a long time to respond. Use the resource Deploy Configuration Template Through Job instead

Deploy a template to a list of devices.

Circuit Statistics

The Circuit Statistics provides performance data of circuits. Using a step-by-step process, by providing only the circuit name, user can retrieve performance data for each of the counters available depending on the circuit type. Each rest call contains the url for the next rest call in the process, so the only method that the user needs to manually compose is the first one - Circuit Details. The response will already contain the exact url for the next method (Circuit Available Metrics). Statistics will be available once appropriate monitoring policy is enabled. The order of the rest calls is as follows:
  • Circuit Details
  • Circuit Available Metrics
  • Circuit Metric Data
Resource Description
GET Circuit Available Metrics
Fetches all the counters that are relevant for the circuit type, the counter type, and the url of the next step (Circuit Metric Data) that is available under the "url" element. Example: /op/statisticsService/circuits/metrics?circuitType=EVC&circuitId=16229216
GET Circuit Details
Fetches the circuit basic details, in addition to the url for the next step that is available under the "metricsLink" element. Example: /op/statisticsService/circuits?.full=true&circuitName=EvcLink_EthPwLink%23EPW_50.50.50.50
GET Circuit Metric Data
Fetches performance data of a given circuit and counter name. Example: /op/statisticsService/circuits/metrics/Ipslay1731AvgAvailability?maxResults=24&timeInterval=6&circuitType=EVC&circuitId=16229216

Group Summary Service

The Group Summary Service provides a summary of alarms per group for each type of group (Site, Device Type or User Defined Group) , an overall alarm summary and a summary of the number devices per Site.

Resource Description
GET Alarm Summary Provides alarm summary information including: total number of alarms, number of alarmed devices, number of alarmed sites, number of alarmed APs and number of alarmed Clients.
GET Device Groups Returns list of Device Type groups, including the count of alarms of each severity for each group.
GET Location Groups Returns list of Locations, including the count of alarms of each severity for each group. Also includes counts of devices, APs and Clients associated with the Location and also location information regarding the location. This service was formerly known as "Site Groups."
GET User Defined Groups Returns list of User Defined groups for both Network Device Groups and Port Groups, including the count of alarms of each severity for each group.

IPSLA (ICMP JITTER) Statistics

The IPSLA (ICMP JITTER) Statistics provide performance information about probe.

Resource Description
GET IPSLA (ICMP JITTER) Available Probe Metrics Fetches properties and URLs for various metrics of IPSLA (ICMP JITTER) probes.
GET IPSLA (ICMP JITTER) Probe Details Fetches IPSLA (ICMP JITTER) probe details.
GET IPSLA (ICMP JITTER) Probe Metric Data Fetches metric KPI for an IPSLA (ICMP JITTER) probe.

IPSLA Y1731 Statistics

The IPSLA Y1731 Statistics provide performance information about probe.

Resource Description
GET IPSLA Y1731 Available Probe Metrics Fetches the properties and URLs for various metrics of IPSLA Y1731 Probes.
GET IPSLA Y1731 Probe Details Fetches the details of IPSLA Y1731 probes
GET IPSLA Y1731 Probe Metric Data Fetches metric KPI for an IPSLA Y1731 Probe.

Interface CRC Errors Statistics

The Interface CRC Errors Statistics provide CRC information.

Resource Description
GET Interface CRC Errors Details Fetch all Interfaces on the system on which the CRC Errors are monitored.
GET Interface CRC Errors Metric Data Fetch CRC Errors performance data for a given metric on the selected device and interface.
GET Interface CRC Errors Metrics Fetch available metrics for the CRC Error on the selected device and interface.

Manage and Monitor Info Service

The Manage and Monitor Info Service service provides information about the application and the server it runs on.

Resource Description
GET Core Dumps Returns the number of application core dumps present on the server.
GET Disk Usage and Capacity Returns capacity and usage information for the volumes present on the application's server.
GET Licenses Returns license information about the application.
GET Uptime Returns uptime information as well as information about the application and the server it runs on.
GET Version Returns the version of the application.

Me1200 Quality of Service Statistics

The Me1200 Quality of Service Statistics provide performance information about policy.

Resource Description
GET Me1200 Quality of Service Details Fetch ME 1200 QoS polices on all managed devices, or on a specific device.
GET Me1200 Quality of Service Metric Data Fetch performance data for the given metric on the selected ME 1200 QoS instance.
GET Me1200 Quality of Service Metrics Fetch all available metrics for this ME 1200 QoS instance.

Optical SFP Statistics

The Optical SFP Statistics provide performance information about SFP modules.

Resource Description
GET Optical SFP Details Fetch all optical SFP transceivers on the system, or on a specific device.
GET Optical SFP Metric Data Fetch optical SFP performance data for a given metric on the selected transceiver.
GET Optical SFP Metrics Fetch available metrics for the optical SFP transceiver. Available metrics are Voltage, Current, Temperature, Tx Power, Rx Power.

Quality of Service Statistics

The Quality of Service Statistics provide performance information about policy.

Resource Description
GET Quality of Service Policy Details Fetch QoS instances on all managed devices, or on a specific device.
GET Quality of Service Policy Metric Data Fetch performance data for the given metric on the selected QoS instance.
GET Quality of Service Policy Metrics Fetch all available metrics for this QoS instance.

Sensors Statistics

The Sensors Statistics provide sensor value.

Resource Description
GET Sensors Details Fetch sensors instance on all managed devices, or on a specific device.
GET Sensors Metric Data Fetch performance data for the given metric on the selected sensor instance.
GET Sensors Metrics Fetch all available metrics for this sensor instance.

TDM and Sonet Port Statistics

The TDM and Sonet Statistics provide performance information about port.

Resource Description
GET TDM and Sonet Port Available Metrics Fetch TDM and SONET available metrics for the selected port, such as SESNE, SESFE, UASNE, UASFE etc.
GET TDM and Sonet Port Details Fetch TDM and SONET ports on all managed devices, or on a specific device.
GET TDM and Sonet Port Metric Data Fetch TDM and SONET performance data for the given metric on the selected port