Represents detail view of client sessions. It provides device and session related attributes including security, connected device, session time, traffic, etc.
Since Product Version: 1.2
Resource URL
/webacs/api/v1/data/ClientSessionsResponse Parameters
Type | Attribute Name | Description |
---|---|---|
String |
adDomainName |
AD domain name acquired 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:
|
String |
authorizationPolicy |
Authorization Policy acquired 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:
|
String |
ctsSecurityGroup |
CTS security group acquired 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:
|
EncryptionCypherEnum |
encryptionCypher |
Client encryption cypher Allowed values:
|
String |
instanceUuid |
This is a uuid for this instance. |
String |
ipAddress |
Client IP Address |
ClientIpTypeEnum |
ipType |
Client IP type (IPv4, IPv6 or Dual Stack) Allowed values:
|
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:
|
ClientSpeedEnum |
portSpeed |
Port speed (10Mbps, 100Mbps, 1Gbps) for wired client Allowed values:
|
PostureStatusEnum |
postureStatus |
Client posture status acquired from Cisco Identity Service Engine Allowed values:
|
String |
profileName |
Profile name |
ClientProtocolEnum |
protocol |
client connection protocol (802.11a, 802.11b, 802.11g, 802.11n or 802.3) Allowed values:
|
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:
|
long |
sessionEndTime |
Session end time is the time the session finished, measured in milliseconds since the Unix epoch. For sessions that are still active, this time may be some point for in the future (for example Jan 1, 2100). |
long |
sessionStartTime |
Session start time is the time the session started, measured in milliseconds since the Unix epoch. |
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 authenticated via WebAuth Allowed values:
|
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 client Allowed values:
|
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://172.25.123.114/webacs/api/v1/data/ClientSessions/15
<?xml version="1.0" ?> <queryResponse type="ClientSessions" responseType="getEntity" requestUrl="https://172.25.123.114/webacs/api/v1/data/ClientSessions/15" rootUrl="https://172.25.123.114/webacs/api/v1/data"> <entity dtoType="clientSessionsDTO" type="ClientSessions" url="https://172.25.123.114/webacs/api/v1/data/ClientSessions/15"> <clientSessionsDTO displayName="String value" id="15" uuid="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://172.25.123.114/webacs/api/v1/data/ClientSessions/15.json
{ "queryResponse" : { "@type" : "ClientSessions", "@responseType" : "getEntity", "@requestUrl" : "https : \/\/172.25.123.114\/webacs\/api\/v1\/data\/ClientSessions\/15", "@rootUrl" : "https : \/\/172.25.123.114\/webacs\/api\/v1\/data", "entity" : { "@dtoType" : "clientSessionsDTO", "@type" : "ClientSessions", "@url" : "https : \/\/172.25.123.114\/webacs\/api\/v1\/data\/ClientSessions\/15", "clientSessionsDTO" : { "@displayName" : "String value", "@id" : "15", "@uuid" : "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" } } } }