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

GET statisticsService/bngIp

Resource Information

Rate Limiting?

Yes

Sorting?

No

Paging?

No

Filtering?

No

Response Formats

xml

json

User Group

NBI Read

HTTP Methods

GET

Fetches the BNG IP Pool basic details, in addition to the URL for the next step that is available under the "metricsLink" element.
Examples:
op/statisticsService/bngIp
op/statisticsService/bngIp?.full=true&device=10.56.23.51

Since Product Version: 2.0

Resource URL

/webacs/api/v1/op/statisticsService/bngIp

Request Parameters

Type Attribute Name Source Description

String

device optional

query

Defines the IP address of the device to which the IP pool instance belongs.

Integer

firstResult optional

query

Defines the offset from the first result you want to fetch. Default is 0.

Integer

maxResults optional

query

Defines the maximum number of hits to be returned. Default is 20.

String

sort optional

query

Defines a comma-separated list of attribute names with their respective order.

Response Parameters

Type Attribute Name Description

ResourceDetailsDTO[]

resources

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://172.25.123.114/webacs/api/v1/op/statisticsService/bngIp

<?xml version="1.0" ?>
<mgmtResponse responseType="operation" requestUrl="../../../../pages/common/login.jsp.html" rootUrl="https://172.25.123.114/webacs/api/v1/op/">
  <resourcesDTO>
    <resources>
      <resources>
        <childrenLink>String value</childrenLink>
        <description>String value</description>
        <details>
          <item key="String value">
            <value xmlns:xs="http://www.w3.org/2001/XMLSchema" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:type="xs:string">String value</value>
          </item>
        </details>
        <metricsLink>String value</metricsLink>
        <name>String value</name>
        <type>String value</type>
      </resources>
    </resources>
  </resourcesDTO>
</mgmtResponse>

Sample JSON Response Payload

https://172.25.123.114/webacs/api/v1/op/statisticsService/bngIp.json

{
  "mgmtResponse" : {
    "@responseType" : "operation",
    "@requestUrl" : "https : \/\/172.25.123.114\/webacs\/api\/v1\/op\/statisticsService\/bngIp",
    "@rootUrl" : "https : \/\/172.25.123.114\/webacs\/api\/v1\/op\/",
    "resourcesDTO" : {
      "resources" : {
        "resources" : {
          "childrenLink" : "String value",
          "description" : "String value",
          "details" : {
            "item" : {
              "@key" : "String value",
              "value" : {
                "@xsi.type" : "xs : string",
                "$" : "String value"
              }
            }
          },
          "metricsLink" : "String value",
          "name" : "String value",
          "type" : "String value"
        }
      }
    }
  }
}