Cisco Prime Infrastructure API
Prime Infrastructure API Documentation

GET ClientSessions

Resource Information

Rate Limiting?

Yes

Sorting?

Yes

Paging?

Yes

Filtering?

Yes

Response Formats

xml

json

User Group

NBI Read

HTTP Methods

GET

Represents detail view of client sessions. It provides device and session related attributes including security, connected device, session time, traffic, etc.

Resource URL

/webacs/api/v1/data/ClientSessions

Since : 1.2

Response Parameters

Type Attribute Name Description

String

adDomainName

AD domain name accquired from Cisco Identity Service Engine

String

anchorIpAddress

IP address of the mobility anchor controller if any

String

apIpAddress

Associated AP IP address

String

apMacAddress

Associated AP MAC address

String

apName

Associated AP name

AuthenticationAlgorithmEnum

authenticationAlgorithm

Client authentication algorithm

Allowed values:

  • OPENSYSTEM
  • SHAREDKEY
  • UNKNOW
  • OPENANDEAP

String

authorizationPolicy

Authorization Policy accquired from Cisco Identity Service Engine

long

bytesReceived

Number of bytes received during the session

long

bytesSent

Number of bytes sent during the session

String

clientInterface

Client Interface

ConnectionTypeEnum

connectionType

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

Allowed values:

  • LIGHTWEIGHTWIRELESS
  • AUTONOMOUSWIRELESS
  • WIRED

String

ctsSecurityGroup

CTS security group accquired from Cisco Identity Service Engine

String

deviceIpAddress

Associated device IP address

String

deviceName

Associated device name (controller or switch)

EapTypeEnum

eapType

EAP type

Allowed values:

  • EAPTLS
  • TTLS
  • PEAP
  • LEAP
  • SPEKE
  • EAPFAST
  • NA
  • UNNOWN
  • MD5
  • EAPSIM

EncryptionCypherEnum

encryptionCypher

Client encryption cypher

Allowed values:

  • CCMPAES
  • TKIPMIC
  • LITERAL2
  • WEP140
  • WEP128
  • NONE
  • NA
  • UNKNOWN

String

ipAddress

Client IP Address

IpTypeEnum

ipType

Client IP type (IPv4, IPv6 or Dual Stack)

Allowed values:

  • IPV4
  • IPV6
  • DUALSTACK
  • NOTDETECTED

String

location

Associated AP or switch Map location

String

macAddress

Client MAC Address

long

packetsReceived

Number of packets received during the session

long

packetsSent

Number of bytes sent during the session

PolicyTypeStatusEnum

policyTypeStatus

Client policy status

Allowed values:

  • IDLE
  • RUNNING
  • NOMETHOD
  • AUTHENTICATIONSUCEEDED
  • AUTHENTICATIONFAILED
  • AUTHORIZATIONSUCCEEDED
  • AUTHORIZATIONFAILED
  • DISASSOCIATED

ClientSpeedEnum

portSpeed

Port speed (10Mbps, 100Mbps, 1Gbps) for wired client

Allowed values:

  • UNKNOWN
  • SPEED10M
  • SPEED100M
  • SPEED1G

PostureStatusEnum

postureStatus

Client posture status accquired from Cisco Identity Service Engine

Allowed values:

  • UNKNOWN
  • COMPLIANT
  • NONCOMPLIANT
  • PENDING
  • NA
  • ERROR

String

profileName

Profile name

ClientProtocolEnum

protocol

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

Allowed values:

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

String

roamReason

The reason reported from controller why client is moved to another AP

int

rssi

RSSI observed from last polling during the session

SecurityPolicyEnum

securityPolicy

Client security policy type

Allowed values:

  • DOT1X
  • WPA1
  • WPA2
  • WPA2VFF
  • NA
  • UNKNOWN
  • MACAUTHBYPASS
  • WEBAUTH
  • WPA

long

sessionEndTime

Session end time in unix format. The time when session ends. it is a timestamp, e.g. 74060617600000 sessionTime is the duration of session start time and end time in milli-seconds.

long

sessionStartTime

Session start time in unix format. The time when the session starts. it is a timestamp. e.g. 64060617600000 sessionTime is the duration of session start time and end time in milli-seconds.

int

snr

SNR (Signal to Noise Ratio) observed from last polling during the session

String

ssid

SSID

double

throughput

Average session throughput

String

userName

Client Username

String

vlan

Vlan name

WebSecurityEnum

webSecurity

flag to indicate whether the client is authentocated via WebAuth

Allowed values:

  • DISABLED
  • ENABLED

String

wgbMacAddress

WGB MAC Address if it is a WGB client

WGBStatusEnum

wgbStatus

flag to indicate whether the client is WGB client, WGB AP or local clieny

Allowed values:

  • REGULARCLIENT
  • WGBCLIENT
  • WGBAP

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://szier-m8-106.cisco.com/webacs/api/v1/data/ClientSessions/42

<?xml version="1.0" encoding="UTF-8" standalone="yes"?>
<queryResponse rootUrl="https://szier-m8-106.cisco.com/webacs/api/v1/data" requestUrl="https://szier-m8-106.cisco.com/webacs/api/v1/data/ClientSessions/42" responseType="getEntity">
    <entity url="https://szier-m8-106.cisco.com/webacs/api/v1/data/ClientSessions/15" type="ClientSessions" dtoType="clientSessionsDTO">
        <clientSessionsDTO id="15" displayName="String value">
            <adDomainName>String value</adDomainName>
            <anchorIpAddress>String value</anchorIpAddress>
            <apIpAddress>String value</apIpAddress>
            <apMacAddress>String value</apMacAddress>
            <apName>String value</apName>
            <authenticationAlgorithm>OPENSYSTEM</authenticationAlgorithm>
            <authorizationPolicy>String value</authorizationPolicy>
            <bytesReceived>2</bytesReceived>
            <bytesSent>2</bytesSent>
            <clientInterface>String value</clientInterface>
            <connectionType>LIGHTWEIGHTWIRELESS</connectionType>
            <ctsSecurityGroup>String value</ctsSecurityGroup>
            <deviceIpAddress>String value</deviceIpAddress>
            <deviceName>String value</deviceName>
            <eapType>EAPTLS</eapType>
            <encryptionCypher>CCMPAES</encryptionCypher>
            <ipAddress>String value</ipAddress>
            <ipType>IPV4</ipType>
            <location>String value</location>
            <macAddress>String value</macAddress>
            <packetsReceived>2</packetsReceived>
            <packetsSent>2</packetsSent>
            <policyTypeStatus>IDLE</policyTypeStatus>
            <portSpeed>UNKNOWN</portSpeed>
            <postureStatus>UNKNOWN</postureStatus>
            <profileName>String value</profileName>
            <protocol>UNDEFINED</protocol>
            <roamReason>String value</roamReason>
            <rssi>1</rssi>
            <securityPolicy>DOT1X</securityPolicy>
            <sessionEndTime>2</sessionEndTime>
            <sessionStartTime>2</sessionStartTime>
            <snr>1</snr>
            <ssid>String value</ssid>
            <throughput>4.0</throughput>
            <userName>String value</userName>
            <vlan>String value</vlan>
            <webSecurity>DISABLED</webSecurity>
            <wgbMacAddress>String value</wgbMacAddress>
            <wgbStatus>REGULARCLIENT</wgbStatus>
        </clientSessionsDTO>
    </entity>
</queryResponse>

Sample JSON Payload

https://szier-m8-106.cisco.com/webacs/api/v1/data/ClientSessions/42.json

{
  "queryResponse" : {
    "@rootUrl" : "https : \/\/szier-m8-106.cisco.com\/webacs\/api\/v1\/data",
    "@requestUrl" : "https : \/\/szier-m8-106.cisco.com\/webacs\/api\/v1\/data\/ClientSessions\/42",
    "@responseType" : "getEntity",
    "entity" : {
      "@url" : "https : \/\/szier-m8-106.cisco.com\/webacs\/api\/v1\/data\/ClientSessions\/15",
      "@type" : "ClientSessions",
      "@dtoType" : "clientSessionsDTO",
      "clientSessionsDTO" : {
        "@id" : "15",
        "@displayName" : "String value",
        "adDomainName" : "String value",
        "anchorIpAddress" : "String value",
        "apIpAddress" : "String value",
        "apMacAddress" : "String value",
        "apName" : "String value",
        "authenticationAlgorithm" : "OPENSYSTEM",
        "authorizationPolicy" : "String value",
        "bytesReceived" : 2,
        "bytesSent" : 2,
        "clientInterface" : "String value",
        "connectionType" : "LIGHTWEIGHTWIRELESS",
        "ctsSecurityGroup" : "String value",
        "deviceIpAddress" : "String value",
        "deviceName" : "String value",
        "eapType" : "EAPTLS",
        "encryptionCypher" : "CCMPAES",
        "ipAddress" : "String value",
        "ipType" : "IPV4",
        "location" : "String value",
        "macAddress" : "String value",
        "packetsReceived" : 2,
        "packetsSent" : 2,
        "policyTypeStatus" : "IDLE",
        "portSpeed" : "UNKNOWN",
        "postureStatus" : "UNKNOWN",
        "profileName" : "String value",
        "protocol" : "UNDEFINED",
        "roamReason" : "String value",
        "rssi" : 1,
        "securityPolicy" : "DOT1X",
        "sessionEndTime" : 2,
        "sessionStartTime" : 2,
        "snr" : 1,
        "ssid" : "String value",
        "throughput" : 4,
        "userName" : "String value",
        "vlan" : "String value",
        "webSecurity" : "DISABLED",
        "wgbMacAddress" : "String value",
        "wgbStatus" : "REGULARCLIENT"
      }
    }
  }
}