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: 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/ClientsResponse Parameters
Attribute | Description |
---|---|
apMacAddress MacAddress |
Associated AP MAC address for wireless client |
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)
|
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 MacAddress |
Client MAC Address |
protocol ClientProtocolEnum |
Client connection protocol (802.11a, 802.11ac, 802.11ax, 802.11b, 802.11g, 802.11n or 802.3)
|
securityPolicyStatus SecurityPolicyStatusEnum |
Status whether the client is on network (in running state)
|
ssid String |
SSID that the client is connected to |
status ClientStatusEnum |
Current association status of the client
|
updateTime long |
Last time this record was updated, measured in milliseconds since the Unix epoch. |
userName String |
Client Username |
vendor String |
Vendor name of the client card derived from OUI mapping. Vendor names are updated when the client is first detected, and periodically as background jobs run (usually every 15 minutes). Disassociated clients will have vendor names updated until after they re-associate. |
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/v4/sse/Clients
<?xml version="1.0" ?>
<streamResponse count="1" responseType="listEvents" requestUrl="https://localhost/webacs/api/v4/sse/Clients" rootUrl="https://localhost/webacs/api/v4/sse">
<streamEvent dtoType="clientsDTO" id="Clients" action="CREATED">
<clientsDTO displayName="String value" id="15" uuid="String value">
<associationTime>2</associationTime>
<clientInterface>String value</clientInterface>
<connectionType>LIGHTWEIGHTWIRELESS</connectionType>
<deviceName>String value</deviceName>
<deviceType>String value</deviceType>
<hostname>String value</hostname>
<location>String value</location>
<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>
<apMacAddress>
<octets>000a959d6816</octets>
</apMacAddress>
<deviceIpAddress>
<address>192.168.115.243</address>
</deviceIpAddress>
<ipAddress>
<address>192.168.115.243</address>
</ipAddress>
<macAddress>
<octets>000a959d6816</octets>
</macAddress>
</clientsDTO>
</streamEvent>
</streamResponse>
Sample JSON Payload
https://localhost/webacs/api/v4/sse/Clients.json
{
"streamResponse" : {
"@count" : 1,
"@requestUrl" : "https://localhost/webacs/api/v4/sse/Clients",
"@responseType" : "listEvents",
"@rootUrl" : "https://localhost/webacs/api/v4/sse",
"streamEvent" : [ {
"@action" : "CREATED",
"@dtoType" : "clientsDTO",
"@id" : "Clients",
"clientsDTO" : {
"@displayName" : "String value",
"@id" : 15,
"@uuid" : "String value",
"apMacAddress" : {
"octets" : "000a959d6816"
},
"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" : {
"octets" : "000a959d6816"
},
"protocol" : "UNDEFINED",
"securityPolicyStatus" : "PASSED",
"ssid" : "String value",
"status" : "IDLE",
"updateTime" : 2,
"userName" : "String value",
"vendor" : "String value",
"vlan" : "String value",
"vlanId" : 1
}
} ]
}
}