Cisco Prime Infrastructure API
Prime Infrastructure API Documentation

GET Clients

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

Since Product Version: 1.2

Resource Information

Rate Limiting?

Yes

Sorting?

Yes

Paging?

Yes

Filtering?

Yes

Aggregation?

Yes

Response Formats

xml

json

User Group

NBI Read

HTTP Methods

GET

DevNet Discussions

Resource URL

/webacs/api/v2/data/Clients

Updated

This resource has been updated since the previous API version. It may have changes that are not compatible with API clients written for previous API versions.

Response Parameters

Attribute Description

apMacAddress String

Associated AP MAC address for wireless clients

associationTime long

Current or last session start time, measured in milliseconds since the Unix epoch.

clientInterface String

interface that the client is connected to

connectionType ConnectionTypeEnum

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

Allowed values:

  • LIGHTWEIGHTWIRELESS
  • AUTONOMOUSWIRELESS
  • WIRED

deviceIpAddress InetAddress

Associated device IP address

deviceName String

associated device name

deviceType String

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

hostname String

DNS lookup by client IP address

ipAddress InetAddress

Client IP Address

location String

map location of the client

macAddress String

Client MAC Address

protocol ClientProtocolEnum

Client connection protocol

Allowed values:

  • UNDEFINED
  • DOT11A
  • DOT11B
  • DOT11G
  • UNKNOWN
  • MOBILE
  • DOT11N2_4GNZ
  • DOT11N5GHZ
  • DOT3
  • DOT3GUEST
  • DOT11AC

securityPolicyStatus SecurityPolicyStatusEnum

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

Allowed values:

  • PASSED
  • FAILED

ssid String

ssid that the client is connected to

status ClientStatusEnum

current association status of the client

Allowed values:

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

updateTime long

Last time this record was updated, measured in milliseconds since the Unix epoch.

userName String

Client Username

vendor String

vendor name of client card

vlan String

Name of the vlan that the client is connected to

vlanId int

ID of the vlan the client is connected to

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/v2/data/Clients/15

<?xml version="1.0" ?>
<queryResponse type="Clients" responseType="getEntity" requestUrl="https://localhost/webacs/api/v2/data/Clients/15" rootUrl="https://localhost/webacs/api/v2/data">
  <entity dtoType="clientsDTO" type="Clients" url="https://localhost/webacs/api/v2/data/Clients/15">
    <clientsDTO displayName="String value" id="15" uuid="String value">
      <apMacAddress>String value</apMacAddress>
      <associationTime>2</associationTime>
      <clientInterface>String value</clientInterface>
      <connectionType>LIGHTWEIGHTWIRELESS</connectionType>
      <deviceIpAddress>
        <address>192.168.115.243</address>
      </deviceIpAddress>
      <deviceName>String value</deviceName>
      <deviceType>String value</deviceType>
      <hostname>String value</hostname>
      <ipAddress>
        <address>192.168.115.243</address>
      </ipAddress>
      <location>String value</location>
      <macAddress>String value</macAddress>
      <protocol>UNDEFINED</protocol>
      <securityPolicyStatus>PASSED</securityPolicyStatus>
      <ssid>String value</ssid>
      <status>IDLE</status>
      <updateTime>2</updateTime>
      <userName>String value</userName>
      <vendor>String value</vendor>
      <vlan>String value</vlan>
      <vlanId>1</vlanId>
    </clientsDTO>
  </entity>
</queryResponse>

Sample JSON Payload

https://localhost/webacs/api/v2/data/Clients/15.json

{
  "queryResponse" : {
    "@type" : "Clients",
    "@requestUrl" : "https://localhost/webacs/api/v2/data/Clients/15",
    "@responseType" : "getEntity",
    "@rootUrl" : "https://localhost/webacs/api/v2/data",
    "entity" : [ {
      "@dtoType" : "clientsDTO",
      "@type" : "Clients",
      "@url" : "https://localhost/webacs/api/v2/data/Clients/15",
      "clientsDTO" : {
        "@displayName" : "String value",
        "@id" : 15,
        "@uuid" : "String value",
        "apMacAddress" : "String value",
        "associationTime" : 2,
        "clientInterface" : "String value",
        "connectionType" : "LIGHTWEIGHTWIRELESS",
        "deviceIpAddress" : {
          "address" : "192.168.115.243"
        },
        "deviceName" : "String value",
        "deviceType" : "String value",
        "hostname" : "String value",
        "ipAddress" : {
          "address" : "192.168.115.243"
        },
        "location" : "String value",
        "macAddress" : "String value",
        "protocol" : "UNDEFINED",
        "securityPolicyStatus" : "PASSED",
        "ssid" : "String value",
        "status" : "IDLE",
        "updateTime" : 2,
        "userName" : "String value",
        "vendor" : "String value",
        "vlan" : "String value",
        "vlanId" : 1
      }
    } ]
  }
}