Cisco Prime Infrastructure API
Prime Infrastructure API Documentation
GET_Clients

GET Clients

Resource Information

Rate Limiting?

 Yes

Sorting?

 Yes

Paging?

 Yes

Filtering?

 Yes

Response Formats

xml

json

HTTP Methods

GET

Represents client view with information about the end points. It provides end point information such as MAC address, IP address, username, and status.

Resource URL

/webacs/api/v1/data/Clients

Since : 1.2

Response Parameters

Type Attribute Name Description

String

apMacAddress

associated AP MAC address for wireless client

long

associationTime

Last or current session start time of the client of the NCS server in unix format

String

clientInterface

interface that the client is connected to

ConnectionTypeEnum

connectionType

Type of connection (Lightweight AP, Autonomous AP, or Wired)

Allowed values:

  • LIGHTWEIGHTWIRELESS
  • AUTONOMOUSWIRELESS
  • WIRED

String

deviceIpAddress

associated device IP address

String

deviceName

associated device name

String

deviceType

device type of the client, like laptop, iPad, etc

String

hostname

DNS lookup by client IP address

String

ipAddress

Client IP Address

String

location

map location of the client

String

macAddress

Client MAC Address

ClientProtocolEnum

protocol

client connection protocol (802.11a, 802.11b, 802.11g, 802.11n or 802.3)

Allowed values:

  • DOT11A
  • DOT11B
  • DOT11G
  • UNKNOWN
  • MOBILE
  • DOT11N2_4GNZ
  • DOT11N5GHZ
  • DOT3

SecurityPolicyStatusEnum

securityPolicyStatus

status whether the client is on network (in running state)

Allowed values:

  • PASSED
  • FAILED

String

ssid

ssid that the client is connected to

ClientStatusEnum

status

current association status of the client

Allowed values:

  • IDLE
  • AUTHPENDING
  • AUTHENTICATED
  • ASSOCIATED
  • POWERSAVE
  • DISASSOCIATED
  • TOBEDELETED
  • PROBING
  • BLACKLISTED
  • NOTCONFIGURED
  • UNAUTHENTICATED

String

userName

Client Username

String

vendor

vendor name of client card

String

vlan

vlan that the client is connected to

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://192.168.116.207/webacs/api/v1/data/Clients/42

<?xml version="1.0" encoding="UTF-8" standalone="yes"?>
<queryResponse rootUrl="/webacs/data" requestUrl="https://192.168.116.207/webacs/api/v1/data/Clients/42" responseType="getEntity">
    <entity url="/webacs/data/className/15" type="className" dtoType="clientsDTO_$$_javassist_5985">
        <clientsDTO id="15" displayName="String value">
            <apMacAddress>String value</apMacAddress>
            <associationTime>2</associationTime>
            <clientInterface>String value</clientInterface>
            <connectionType>LIGHTWEIGHTWIRELESS</connectionType>
            <deviceIpAddress>String value</deviceIpAddress>
            <deviceName>String value</deviceName>
            <deviceType>String value</deviceType>
            <hostname>String value</hostname>
            <ipAddress>String value</ipAddress>
            <location>String value</location>
            <macAddress>String value</macAddress>
            <protocol>DOT11A</protocol>
            <securityPolicyStatus>PASSED</securityPolicyStatus>
            <ssid>String value</ssid>
            <status>IDLE</status>
            <userName>String value</userName>
            <vendor>String value</vendor>
            <vlan>String value</vlan>
        </clientsDTO>
    </entity>
</queryResponse>

Sample JSON Payload

https://192.168.116.207/webacs/api/v1/data/Clients/42.json

{
  "queryResponse" : {
    "@rootUrl" : "\/webacs\/data",
    "@requestUrl" : "https : \/\/192.168.116.207\/webacs\/api\/v1\/data\/Clients\/42",
    "@responseType" : "getEntity",
    "entity" : {
      "@url" : "\/webacs\/data\/className\/15",
      "@type" : "className",
      "@dtoType" : "clientsDTO_$$_javassist_5985",
      "clientsDTO" : {
        "@id" : "15",
        "@displayName" : "String value",
        "apMacAddress" : "String value",
        "associationTime" : 2,
        "clientInterface" : "String value",
        "connectionType" : "LIGHTWEIGHTWIRELESS",
        "deviceIpAddress" : "String value",
        "deviceName" : "String value",
        "deviceType" : "String value",
        "hostname" : "String value",
        "ipAddress" : "String value",
        "location" : "String value",
        "macAddress" : "String value",
        "protocol" : "DOT11A",
        "securityPolicyStatus" : "PASSED",
        "ssid" : "String value",
        "status" : "IDLE",
        "userName" : "String value",
        "vendor" : "String value",
        "vlan" : "String value"
      }
    }
  }
}