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 URL
/webacs/api/v1/data/Clients DeprecatedThis version has been deprecated due to poor performance in large-scale environments. Please use v2.
Response Parameters
Type | Attribute Name | Description |
---|---|---|
String |
apMacAddress |
associated AP MAC address for wireless client |
long |
associationTime |
Last or current session start time of the client of the NCS server in unix format |
String |
clientInterface |
interface that the client is connected to |
ConnectionTypeEnum |
connectionType |
Type of connection (Lightweight AP, Autonomous AP, or Wired) Allowed values: |
String |
deviceIpAddress |
associated device IP address |
String |
deviceName |
associated device name |
String |
deviceType |
device type of the client, like laptop, iPad, etc |
String |
hostname |
DNS lookup by client IP address |
String |
instanceUuid |
This is a uuid for this instance. |
String |
ipAddress |
Client IP Address |
String |
location |
map location of the client |
String |
macAddress |
Client MAC Address |
ClientProtocolEnum |
protocol |
client connection protocol (802.11a, 802.11b, 802.11g, 802.11n or 802.3) Allowed values: |
SecurityPolicyStatusEnum |
securityPolicyStatus |
status whether the client is on network (in running state) Allowed values: |
String |
ssid |
ssid that the client is connected to |
ClientStatusEnum |
status |
current association status of the client Allowed values: |
long |
updateTime |
Last time this record was updated. Measured in milliseconds since the Unix epoch. |
String |
userName |
Client Username |
String |
vendor |
vendor name of client card |
String |
vlan |
Name of the vlan that the client is connected to |
int |
vlanId |
ID of the vlan the client is connected to |
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://192.168.115.187/webacs/api/v1/data/Clients/42
<?xml version="1.0" encoding="UTF-8" standalone="yes"?> <queryResponse rootUrl="https://192.168.115.187/webacs/api/v1/data" requestUrl="https://192.168.115.187/webacs/api/v1/data/Clients/42" responseType="getEntity"> <entity url="https://192.168.115.187/webacs/api/v1/data/Clients/15" type="Clients" dtoType="clientsDTO"> <clientsDTO uuid="String value" id="15" displayName="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://192.168.115.187/webacs/api/v1/data/Clients/42.json
{ "queryResponse" : { "@rootUrl" : "https : \/\/192.168.115.187\/webacs\/api\/v1\/data", "@requestUrl" : "https : \/\/192.168.115.187\/webacs\/api\/v1\/data\/Clients\/42", "@responseType" : "getEntity", "entity" : { "@url" : "https : \/\/192.168.115.187\/webacs\/api\/v1\/data\/Clients\/15", "@type" : "Clients", "@dtoType" : "clientsDTO", "clientsDTO" : { "@uuid" : "String value", "@id" : "15", "@displayName" : "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 } } } }
Resource URL
/webacs/api/v2/data/ClientsResponse Parameters
Type | Attribute Name | Description |
---|---|---|
String |
apMacAddress |
Associated AP MAC address for wireless clients |
long |
associationTime |
Last or current session start time of the client of the NCS server in unix format |
String |
clientInterface |
interface that the client is connected to |
ConnectionTypeEnum |
connectionType |
Type of connection (Lightweight AP, Autonomous AP, or Wired) Allowed values: |
InetAddress |
deviceIpAddress |
Associated device IP address |
String |
deviceName |
associated device name |
String |
deviceType |
device type of the client, like laptop, iPad, etc |
String |
hostname |
DNS lookup by client IP address |
String |
instanceUuid |
This is a uuid for this instance. |
InetAddress |
ipAddress |
Client IP Address |
String |
location |
map location of the client |
String |
macAddress |
Client MAC Address |
ClientProtocolEnum |
protocol |
Client connection protocol Allowed values: |
SecurityPolicyStatusEnum |
securityPolicyStatus |
status whether the client is on network (in running state) Allowed values: |
String |
ssid |
ssid that the client is connected to |
ClientStatusEnum |
status |
current association status of the client Allowed values: |
long |
updateTime |
Last time this record was updated. Measured in milliseconds since the Unix epoch. |
String |
userName |
Client Username |
String |
vendor |
vendor name of client card |
String |
vlan |
Name of the vlan that the client is connected to |
int |
vlanId |
ID of the vlan the client is connected to |
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://192.168.115.187/webacs/api/v1/data/ClientsV2/42
<?xml version="1.0" encoding="UTF-8" standalone="yes"?> <queryResponse rootUrl="/webacs/data" requestUrl="https://192.168.115.187/webacs/api/v1/data/ClientsV2/42" responseType="getEntity"> <entity url="/webacs/data/ClientsV2/15" type="ClientsV2" dtoType="clientsV2DTO"> <clientsV2DTO uuid="String value" id="15" displayName="String value"> <apMacAddress>String value</apMacAddress> <associationTime>2</associationTime> <clientInterface>String value</clientInterface> <connectionType>LIGHTWEIGHTWIRELESS</connectionType> <deviceIpAddress> <address>192.168.115.243</address> </deviceIpAddress> <deviceName>String value</deviceName> <deviceType>String value</deviceType> <hostname>String value</hostname> <ipAddress> <address>192.168.115.243</address> </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> </clientsV2DTO> </entity> </queryResponse>
Sample JSON Payload
https://192.168.115.187/webacs/api/v1/data/ClientsV2/42.json
{ "queryResponse" : { "@rootUrl" : "\/webacs\/data", "@requestUrl" : "https : \/\/192.168.115.187\/webacs\/api\/v1\/data\/ClientsV2\/42", "@responseType" : "getEntity", "entity" : { "@url" : "\/webacs\/data\/ClientsV2\/15", "@type" : "ClientsV2", "@dtoType" : "clientsV2DTO", "clientsV2DTO" : { "@uuid" : "String value", "@id" : "15", "@displayName" : "String value", "apMacAddress" : "String value", "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" : "String value", "protocol" : "UNDEFINED", "securityPolicyStatus" : "PASSED", "ssid" : "String value", "status" : "IDLE", "updateTime" : 2, "userName" : "String value", "vendor" : "String value", "vlan" : "String value", "vlanId" : 1 } } } }