Cisco Prime Infrastructure API
Prime Infrastructure API Documentation

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

Fetches all Border Routers in a PfR controlled site that are actively exporting PfR NetFlow within a specified time range.The URL Format is: /op/pfrMonitoringExt/getAllBorderRouters/startTime/endTime/siteName?siteHierachyPath. Here are the sample queries:
  • /op/pfrMonitoringExt/getAllBorderRouters/1475824562/1476429362/BANGALORE -- Returns all Border Routers in a PfR controlled site that are actively exporting pfr Netflow within a specified time range for the give site.
  • /op/pfrMonitoringExt/getAllBorderRouters/1475824562/1476429362/BANGALORE? hierarchyPath=/Location/All Locations-- Returns all Border Routers in a PfR controlled site that are actively exporting pfr Netflow within a specified time range for the given site under the given hierarchyPath.

Since Product Version: 3.1

Resource Information

Rate Limiting?

Yes

Sorting?

No

Paging?

No

Filtering?

No

Group Filtering?

No

Aggregation?

No

Response Formats

xml

json

User Group

NBI Read

HTTP Methods

GET

DevNet Discussions

API version v1 is deprecated

This API version has been deprecated. It will be removed in a future release of the product. Please develop new clients using the latest API version. Please modify your existing clients to use a later API version.

Resource URL

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

Request Parameters

Attribute Source Description

startTime Long

path

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

endTime Long

path

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

siteName String

path

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

hierarchyPath String

query

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

Response Parameters

Attribute Description

childStatistics StatisticsDTO[]

The set of nested StatisticsDTO objects.

statisticEntry 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.

Allowed values:

  • 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://localhost/webacs/api/v1/op/pfrMonitoringExt/getAllBorderRouters/1463999256456/1465208856234/Site1?hierarchyPath="Location/All Locations/Site1"

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

Sample JSON Response Payload

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

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