Cisco Prime Infrastructure API
Prime Infrastructure API Documentation

GET ClientCounts

Represents number of clients counted during the last polling cycle. The combination of type, key and subtype represents number of clients associated with the entity.

Since Product Version: 1.2

Resource Information

Rate Limiting?

Yes

Sorting?

Yes

Paging?

Yes

Filtering?

Yes

Group Filtering?

No

Aggregation?

No

Response Formats

xml

json

User Group

NBI Read

HTTP Methods

GET

Resource URL

/webacs/api/v3/data/ClientCounts

Unmodified

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

Response Parameters

Attribute Description

authCount int

total authenticated client count on the element in last collection time

collectionTime long

The time collection of this record was finished, measured in milliseconds since the Unix epoch.

count int

total client count on the element in last collection time

dot11aAuthCount int

number of authenticated clients using 802.11a

dot11aCount int

number of clients using 802.11a

dot11acAuthCount int

number of authenticated clients using 802.11ac

dot11acCount int

number of clients using 802.11ac

dot11bAuthCount int

number of authenticated clients using 802.11b

dot11bCount int

number of clients using 802.11b

dot11gAuthCount int

number of authenticated clients using 802.11g

dot11gCount int

number of clients using 802.11g

dot11n2_4AuthCount int

number of authenticated clients using 802.11n on 2.4 GHz band

dot11n2_4Count int

number of clients using 802.11n in 2.4 GHz band

dot11n5AuthCount int

number of authenticated clients using 802.11n on 5 GHz band

dot11n5Count int

number of clients using 802.11n in 5GHz band

key String

The wireless MAC address for an access point, the management IP for all other devices, or the name of the virtual domain, SSID, or map location.

subkey String

Subkey is used to further categorize client count, and will generally be an SSID or virtual domain.

type ClientCountTypeEnum

Type of count element

Allowed values:

  • DEVICE
  • ACCESSPOINT
  • MAPLOCATION
  • SSID
  • VIRTUALDOMAIN
  • GUEST

wgbAuthCount int

number of authenticated clients connected as WGB or wired guest

wgbCount int

number of clients connected as WGB or wired guest

wired100MAuthCount int

number of authenticated wired clients connected to wired switch on 100Mbps port

wired100MCount int

number of wired clients connected to wired switch on 100Mbps port

wired10GAuthCount int

number of authenticated wired clients connected to wired switch on 10Gbps port

wired10GCount int

number of wired clients connected to wired switch on 10Gbps port

wired10MAuthCount int

number of authenticated wired clients connected to wired switch on 10Mbps port

wired10MCount int

number of wired clients connected to wired switch on 10Mbps port

wired1GAuthCount int

number of authenticated wired clients connected to wired switch on 1Gbps port

wired1GCount int

number of wired clients connected to wired switch on 1Gbps port

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 Payload

https://localhost/webacs/api/v3/data/ClientCounts/15

<?xml version="1.0" ?>
<queryResponse type="ClientCounts" responseType="getEntity" requestUrl="https://localhost/webacs/api/v3/data/ClientCounts/15" rootUrl="https://localhost/webacs/api/v3/data">
  <entity dtoType="clientCountsDTO" type="ClientCounts" url="https://localhost/webacs/api/v3/data/ClientCounts/15">
    <clientCountsDTO displayName="String value" id="15" uuid="String value">
      <authCount>1</authCount>
      <collectionTime>2</collectionTime>
      <count>1</count>
      <dot11aAuthCount>1</dot11aAuthCount>
      <dot11aCount>1</dot11aCount>
      <dot11acAuthCount>1</dot11acAuthCount>
      <dot11acCount>1</dot11acCount>
      <dot11bAuthCount>1</dot11bAuthCount>
      <dot11bCount>1</dot11bCount>
      <dot11gAuthCount>1</dot11gAuthCount>
      <dot11gCount>1</dot11gCount>
      <dot11n2_4AuthCount>1</dot11n2_4AuthCount>
      <dot11n2_4Count>1</dot11n2_4Count>
      <dot11n5AuthCount>1</dot11n5AuthCount>
      <dot11n5Count>1</dot11n5Count>
      <key>String value</key>
      <subkey>String value</subkey>
      <type>DEVICE</type>
      <wgbAuthCount>1</wgbAuthCount>
      <wgbCount>1</wgbCount>
      <wired100MAuthCount>1</wired100MAuthCount>
      <wired100MCount>1</wired100MCount>
      <wired10GAuthCount>1</wired10GAuthCount>
      <wired10GCount>1</wired10GCount>
      <wired10MAuthCount>1</wired10MAuthCount>
      <wired10MCount>1</wired10MCount>
      <wired1GAuthCount>1</wired1GAuthCount>
      <wired1GCount>1</wired1GCount>
    </clientCountsDTO>
  </entity>
</queryResponse>

Sample JSON Payload

https://localhost/webacs/api/v3/data/ClientCounts/15.json

{
  "queryResponse" : {
    "@type" : "ClientCounts",
    "@requestUrl" : "https://localhost/webacs/api/v3/data/ClientCounts/15",
    "@responseType" : "getEntity",
    "@rootUrl" : "https://localhost/webacs/api/v3/data",
    "entity" : [ {
      "@dtoType" : "clientCountsDTO",
      "@type" : "ClientCounts",
      "@url" : "https://localhost/webacs/api/v3/data/ClientCounts/15",
      "clientCountsDTO" : {
        "@displayName" : "String value",
        "@id" : 15,
        "@uuid" : "String value",
        "authCount" : 1,
        "collectionTime" : 2,
        "count" : 1,
        "dot11aAuthCount" : 1,
        "dot11aCount" : 1,
        "dot11acAuthCount" : 1,
        "dot11acCount" : 1,
        "dot11bAuthCount" : 1,
        "dot11bCount" : 1,
        "dot11gAuthCount" : 1,
        "dot11gCount" : 1,
        "dot11n2_4AuthCount" : 1,
        "dot11n2_4Count" : 1,
        "dot11n5AuthCount" : 1,
        "dot11n5Count" : 1,
        "key" : "String value",
        "subkey" : "String value",
        "type" : "DEVICE",
        "wgbAuthCount" : 1,
        "wgbCount" : 1,
        "wired100MAuthCount" : 1,
        "wired100MCount" : 1,
        "wired10GAuthCount" : 1,
        "wired10GCount" : 1,
        "wired10MAuthCount" : 1,
        "wired10MCount" : 1,
        "wired1GAuthCount" : 1,
        "wired1GCount" : 1
      }
    } ]
  }
}