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

GET pfrMonitoringExt/getAllBorderRouters/{startTime}/{endTime}/{siteName}

Since Product Version: 3.1

Resource Information

Rate Limiting?

No

Sorting?

No

Paging?

No

Filtering?

No

Group Filtering?

No

Aggregation?

No

Response Formats

xml

json

User Group

NBI Read

HTTP Methods

GET

Resource URL

/webacs/api/v2/op/pfrMonitoringExt/getAllBorderRouters/{startTime}/{endTime}/{siteName}

Unmodified

This resource has not been modified since the previous API version.

Request Parameters

Attribute Source Description

startTime Long

path

Required

Specifies the start time in milli seconds to get the all border routers from.

endTime Long

path

Required

Specifies the start time in milli seconds to get the all border routers to.

siteName String

path

Required

Specifies the site name to get the all border routers for specified site.

hierarchyPath String

query

Optional

OPTIONAL Specifies the site name to get the all border routers for specified site hierarchy.

Response Parameters

Attribute Description

childStatistics Arrow image StatisticsDTO[]

The set of nested StatisticsDTO objects.

statisticEntry Arrow image StatisticsEntry[]

The set of statistics entries with attribute name, display name, and value triplets belonging to a single entity for the given category of statistics.

statisticsName StatisticsOperationTypeEnum

The Statistics operation type.

  • DEVICE_TOPN_CPU_UTILIZATION
  • DEVICE_TOPN_MEMORY_UTILIZATION
  • DEVICE_TOPN_TEMPERATURE
  • DEVICE_AVAILABILITY
  • DEVICE_AVAILABILITY_SUMMARY
  • DEVICE_CPU_UTILIZATION_TREND
  • DEVICE_MEMORY_UTILIZATION_TREND
  • DEVICE_HEALTH_INFO
  • DEVICE_REACHABILITY_STATUS
  • DEVICE_PORT_SUMMARY
  • DEVICE_AVAILABILITY_MESSAGE
  • DEVICE_DOWN_MESSAGE
  • DEVICE_CPU_UTILIZATION_SUMMARY
  • INTERFACE_AVAILABILITY
  • INTERFACE_DETAILS
  • INTERFACE_OUT_ERRORS
  • INTERFACE_DISCARDS
  • INTERFACE_UTILIZATION
  • INTERFACE_TOPN_UTILIZATION
  • INTERFACE_TOPN_ERRORS
  • INTERFACE_TOPN_WAN_UTILIZATION
  • INTERFACE_UTILIZATION_SUMMARY
  • INTERFACE_AVAILABILITY_SUMMARY
  • INTERFACE_STATUS_SUMMARY
  • INTERFACE_AVAILABILITY_MESSAGE
  • INTERFACE_DOWN_MESSAGE
  • INTERFACE_TOPN_WAN_ISSUES
  • INTERFACE_CLASSMAP_QOS
  • APPLICATION_TOPN_WORST_HOSTS
  • APPLICATION_TOPN_WORST_SITES
  • APPLICATION_TOPN_HOSTS
  • APPLICATION_TOPN_APP_PERFORMANCE
  • APPLICATION_TOPN_TRAFFIC_ANALYSIS
  • APPLICATION_NUMBER_OF_USERS
  • SYSTEM_INFO
  • SYSTEM_HEALTH
  • APPLICATION_VOLUME
  • APPLICATION_ART_ANALYSIS
  • APPLICATION_TOPN_TRAFFICS
  • APPLICATION_TOPN_WITH_SITES

Sample Payloads

Sample payloads are for information only. They are automatically generated and the values included may not be representative of actual valid data values.

Sample XML Response Payload

https://10.64.80.159/webacs/api/v2/op/pfrMonitoringExt/getAllBorderRouters/1463999256456/1465208856234/Site1?hierarchyPath="Location/All Locations/Site1"

<?xml version="1.0" ?>
<mgmtResponse responseType="operation" requestUrl="https://10.64.80.159/webacs/api/v2/op/pfrMonitoringExt/getAllBorderRouters/1463999256456/1465208856234/Site1?hierarchyPath=&amp;quot;Location/All Locations/Site1&amp;quot;
					" rootUrl="https://10.64.80.159/webacs/api/v2/op">
  <statisticsDTO>
    <childStatistics></childStatistics>
    <statisticEntries>
      <statisticEntry>
        <attributeName>String value</attributeName>
        <displayName>String value</displayName>
        <entryValue>String value</entryValue>
      </statisticEntry>
      <statisticEntry>
        <attributeName>Another string value</attributeName>
        <displayName>Another string value</displayName>
        <entryValue>Another string value</entryValue>
      </statisticEntry>
    </statisticEntries>
    <statisticsName>DEVICE_TOPN_CPU_UTILIZATION</statisticsName>
  </statisticsDTO>
  <statisticsDTO>
    <childStatistics></childStatistics>
    <statisticEntries>
      <statisticEntry>
        <attributeName>String value</attributeName>
        <displayName>String value</displayName>
        <entryValue>String value</entryValue>
      </statisticEntry>
      <statisticEntry>
        <attributeName>Another string value</attributeName>
        <displayName>Another string value</displayName>
        <entryValue>Another string value</entryValue>
      </statisticEntry>
    </statisticEntries>
    <statisticsName>DEVICE_TOPN_MEMORY_UTILIZATION</statisticsName>
  </statisticsDTO>
</mgmtResponse>

Sample JSON Response Payload

https://10.64.80.159/webacs/api/v2/op/pfrMonitoringExt/getAllBorderRouters/1463999256456/1465208856234/Site1.json?hierarchyPath="Location/All Locations/Site1"

{
  "mgmtResponse" : {
    "@requestUrl" : "https://10.64.80.159/webacs/api/v2/op/pfrMonitoringExt/getAllBorderRouters/1463999256456/1465208856234/Site1?hierarchyPath=&quot;Location/All Locations/Site1&quot;\n\t\t\t\t\t",
    "@responseType" : "operation",
    "@rootUrl" : "https://10.64.80.159/webacs/api/v2/op",
    "statisticsDTO" : [ {
      "childStatistics" : {
        "childStatistic" : [ ]
      },
      "statisticEntries" : {
        "statisticEntry" : [ {
          "attributeName" : "String value",
          "displayName" : "String value",
          "entryValue" : "String value"
        }, {
          "attributeName" : "Another string value",
          "displayName" : "Another string value",
          "entryValue" : "Another string value"
        } ]
      },
      "statisticsName" : "DEVICE_TOPN_CPU_UTILIZATION"
    }, {
      "childStatistics" : {
        "childStatistic" : [ ]
      },
      "statisticEntries" : {
        "statisticEntry" : [ {
          "attributeName" : "String value",
          "displayName" : "String value",
          "entryValue" : "String value"
        }, {
          "attributeName" : "Another string value",
          "displayName" : "Another string value",
          "entryValue" : "Another string value"
        } ]
      },
      "statisticsName" : "DEVICE_TOPN_MEMORY_UTILIZATION"
    } ]
  }
}