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/v1/data/Clients DeprecatedThis version has been deprecated due to poor performance in large-scale environments. Please use v2.
Response Parameters
Attribute | Description |
---|---|
apMacAddress String |
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) Allowed values: |
deviceIpAddress String |
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 String |
Client IP Address |
location String |
map location of the client |
macAddress String |
Client MAC Address |
protocol ClientProtocolEnum |
client connection protocol (802.11a, 802.11b, 802.11g, 802.11n or 802.3) Allowed values: |
securityPolicyStatus SecurityPolicyStatusEnum |
status whether the client is on network (in running state) Allowed values: |
ssid String |
ssid that the client is connected to |
status ClientStatusEnum |
current association status of the client Allowed values: |
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/v1/data/Clients/15
<?xml version="1.0" ?>
<queryResponse type="Clients" responseType="getEntity" requestUrl="https://localhost/webacs/api/v1/data/Clients/15" rootUrl="https://localhost/webacs/api/v1/data">
<entity dtoType="clientsDTO" type="Clients" url="https://localhost/webacs/api/v1/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>String value</deviceIpAddress>
<deviceName>String value</deviceName>
<deviceType>String value</deviceType>
<hostname>String value</hostname>
<ipAddress>String value</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/v1/data/Clients/15.json
{
"queryResponse" : {
"@type" : "Clients",
"@responseType" : "getEntity",
"@requestUrl" : "https : \/\/localhost\/webacs\/api\/v1\/data\/Clients\/15",
"@rootUrl" : "https : \/\/localhost\/webacs\/api\/v1\/data",
"entity" : {
"@dtoType" : "clientsDTO",
"@type" : "Clients",
"@url" : "https : \/\/localhost\/webacs\/api\/v1\/data\/Clients\/15",
"clientsDTO" : {
"@displayName" : "String value",
"@id" : "15",
"@uuid" : "String value",
"apMacAddress" : "String value",
"associationTime" : 2,
"clientInterface" : "String value",
"connectionType" : "LIGHTWEIGHTWIRELESS",
"deviceIpAddress" : "String value",
"deviceName" : "String value",
"deviceType" : "String value",
"hostname" : "String value",
"ipAddress" : "String value",
"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
}
}
}
}