Represents detail view of client sessions. It provides device and session related attributes including security, connected device, session time, traffic, etc.
Since Product Version: 3.7
Resource Information
Rate Limiting? |
Yes |
Sorting? |
No |
Paging? |
No |
Filtering? |
No |
Group Filtering? |
No |
Aggregation? |
No |
Response Formats |
xml json |
User Group |
NBI Read |
HTTP Methods |
GET |
Resource URL
/webacs/api/v4/sse/ClientSessionsResponse Parameters
Attribute | Description |
---|---|
adDomainName String |
AD domain name acquired from Cisco Identity Service Engine |
anchorIpAddress InetAddress |
IP address of the mobility anchor controller if any |
apMacAddress MacAddress |
Associated AP MAC address |
authenticationAlgorithm AuthenticationAlgorithmEnum |
Client authentication algorithm
|
Authorization Policy acquired from Cisco Identity Service Engine |
|
bytesReceived long |
Number of bytes received during the session |
bytesSent long |
Number of bytes sent during the session |
clientInterface String |
Client Interface |
connectionType ConnectionTypeEnum |
Type of connection (Lightweight AP, Autonomous AP, or Wired)
|
ctsSecurityGroup String |
CTS security group acquired from Cisco Identity Service Engine |
deviceMgmtAddress InetAddress |
Associated device management address. The management address is the address used to add the device to the managed inventory, either an IP address or hostname. |
deviceName String |
Associated device name (controller or switch) |
eapType EapTypeEnum |
EAP type
|
encryptionCypher EncryptionCypherEnum |
Client encryption cypher
|
ipAddress InetAddress |
Client IP Address |
ipType ClientIpTypeEnum |
Client IP type (IPv4, IPv6 or Dual Stack)
|
location String |
Associated AP or switch Map location |
macAddress MacAddress |
Client MAC Address |
packetsReceived long |
Number of packets received during the session |
packetsSent long |
Number of bytes sent during the session |
policyTypeStatus PolicyTypeStatusEnum |
Client policy status
|
portSpeed ClientSpeedEnum |
Port speed (10Mbps, 100Mbps, 1Gbps, 10Gbps, 2.5Gbps, 5Gbps, 25Gbps, 40Gbps) for wired client
|
postureStatus PostureStatusEnum |
Client posture status acquired from Cisco Identity Service Engine
|
profileName String |
Profile name |
protocol ClientProtocolEnum |
Client connection protocol (802.11a, 802.11ac, 802.11ax, 802.11b, 802.11g, 802.11n or 802.3)
|
roamReason String |
The reason reported from controller why client is moved to another AP |
rssi int |
RSSI observed from last polling during the session |
securityPolicy SecurityPolicyEnum |
Client security policy type
|
sessionEndTime long |
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). |
sessionStartTime long |
Session start time is the time the session started, measured in milliseconds since the Unix epoch. |
sessionTime long |
Session duration on the moment of last updating. If session is finished then sessionTime = sessionEndTime - sessionStartTime, else sessionTime = currentTime - sessionStartTime. |
snr int |
SNR (Signal to Noise Ratio) observed from last polling during the session |
ssid String |
SSID |
throughput double |
Average session throughput |
userName String |
Client Username |
vlan int |
Vlan name |
webSecurity WebSecurityEnum |
Flag to indicate whether the client is authenticated via WebAuth
|
wgbMacAddress MacAddress |
WGB MAC Address if it is a WGB client |
wgbStatus WGBStatusEnum |
Flag to indicate whether the client is WGB client, WGB AP or local client
|
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/v4/sse/ClientSessions
<?xml version="1.0" ?>
<streamResponse count="1" responseType="listEvents" requestUrl="https://localhost/webacs/api/v4/sse/ClientSessions" rootUrl="https://localhost/webacs/api/v4/sse">
<streamEvent dtoType="clientSessionsDTO" id="ClientSessions" action="CREATED">
<clientSessionsDTO displayName="String value" id="15" uuid="String value">
<adDomainName>String value</adDomainName>
<authenticationAlgorithm>OPENSYSTEM</authenticationAlgorithm>
<authorizationPolicy>String value</authorizationPolicy>
<bytesReceived>2</bytesReceived>
<bytesSent>2</bytesSent>
<clientInterface>String value</clientInterface>
<connectionType>LIGHTWEIGHTWIRELESS</connectionType>
<ctsSecurityGroup>String value</ctsSecurityGroup>
<deviceName>String value</deviceName>
<eapType>EAPTLS</eapType>
<encryptionCypher>CCMPAES</encryptionCypher>
<ipType>IPV4</ipType>
<location>String value</location>
<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>
<sessionTime>2</sessionTime>
<snr>1</snr>
<ssid>String value</ssid>
<throughput>4.0</throughput>
<userName>String value</userName>
<webSecurity>DISABLED</webSecurity>
<wgbStatus>REGULARCLIENT</wgbStatus>
<anchorIpAddress>
<address>192.168.115.243</address>
</anchorIpAddress>
<apMacAddress>
<octets>000a959d6816</octets>
</apMacAddress>
<deviceMgmtAddress>
<address>192.168.115.243</address>
</deviceMgmtAddress>
<ipAddress>
<address>192.168.115.243</address>
</ipAddress>
<macAddress>
<octets>000a959d6816</octets>
</macAddress>
<vlan>1</vlan>
<wgbMacAddress>
<octets>000a959d6816</octets>
</wgbMacAddress>
</clientSessionsDTO>
</streamEvent>
</streamResponse>
Sample JSON Payload
https://localhost/webacs/api/v4/sse/ClientSessions.json
{
"streamResponse" : {
"@count" : 1,
"@requestUrl" : "https://localhost/webacs/api/v4/sse/ClientSessions",
"@responseType" : "listEvents",
"@rootUrl" : "https://localhost/webacs/api/v4/sse",
"streamEvent" : [ {
"@action" : "CREATED",
"@dtoType" : "clientSessionsDTO",
"@id" : "ClientSessions",
"clientSessionsDTO" : {
"@displayName" : "String value",
"@id" : 15,
"@uuid" : "String value",
"adDomainName" : "String value",
"anchorIpAddress" : {
"address" : "192.168.115.243"
},
"apMacAddress" : {
"octets" : "000a959d6816"
},
"authenticationAlgorithm" : "OPENSYSTEM",
"authorizationPolicy" : "String value",
"bytesReceived" : 2,
"bytesSent" : 2,
"clientInterface" : "String value",
"connectionType" : "LIGHTWEIGHTWIRELESS",
"ctsSecurityGroup" : "String value",
"deviceMgmtAddress" : {
"address" : "192.168.115.243"
},
"deviceName" : "String value",
"eapType" : "EAPTLS",
"encryptionCypher" : "CCMPAES",
"ipAddress" : {
"address" : "192.168.115.243"
},
"ipType" : "IPV4",
"location" : "String value",
"macAddress" : {
"octets" : "000a959d6816"
},
"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,
"sessionTime" : 2,
"snr" : 1,
"ssid" : "String value",
"throughput" : 4.0,
"userName" : "String value",
"vlan" : 1,
"webSecurity" : "DISABLED",
"wgbMacAddress" : {
"octets" : "000a959d6816"
},
"wgbStatus" : "REGULARCLIENT"
}
} ]
}
}