client-connection-logs

Client Connection Logs

Client Connection Logs displays the list of successful and failed connection attempts made by clients. The list provides information about every attempt made by a client. The list provides information about every attempt of connection made by a client. Green color represents the successful connection. Red Color represents the failed connections. Client connection logs can be retrieved only for 802.11ac APs.

Connection logs can be fetched for various time intervals: 2 hours, 4 hours, 8 hours, 12 hours, 1 day, or 1 week. The connection logs can be viewed either in Timeline form or Grid form.

JSON Table

Attribute Data Type Description
macAddress String
protocol String The 802.11 protocol version associated with the device. The applicable
values are:

  • UNKNOWN
  • A
  • B
  • BG
locationId application/json Location identifier for the client. The value is of the type Location
ID JSON.
eventType String Type of event. The applicable values are:

  • Success
  • Failure
bssid String BSSID of the associared AP
channel int Channel no used for connection
timestamp int Connection timestamp
associatedAPName String Name of the associated AP
ssid String SSID Name
associationTimestamp int Client association timestamp.
authenticationTimestamp int Client authentication timestamp.
networkTimestamp int Client connection timestamp.
autoTestSessionId int Session id of client connectivity test session.
autoTestStatusCode int Current status code of auto client connectivity test
autoTestStatus String Current status of auto client connectivity test.
failureCode int Category code of failures.
failure String Category of failures. For the types of failures and there ID refer
Failure Codes
subFailureCode int Specific failure code in a category.
subFailure String Specific failure in a category.
fileId String ID of a file containing client connection logs
dhcpLatency long Value in seconds for dhcp Latency.
aaaLatency long Value in seconds for aaa Latency.
dnsLatency long Value in seconds for dns Latency.

Copy Sample JSON
Sample JSON 
{
   "successLogs":[{
      "macAddress": "f0:d7:aa:df:59:a2",
      "protocol": "A",
      "locationId":{
         "type": "locallocationid",
         "id": 95
      },
      "eventType": "Success",
      "bssid": "00:11:74:88:af:60",
      "channel": 157,
      "timestamp": 1495010943,
      "associatedAPName": "Mojo_88:AF:8F",
      "ssid": "WebAppsDev",
      "associationTimestamp": 1495010618000,
      "authenticationTimestamp": 1495010618000,
      "networkTimestamp": 1495010943000,
      "autoTestSessionId": null,
      "autoTestStatusCode": 0,
      "autoTestStatus": null,
      "dhcpLatency": 0,
      "aaaLatency": 0,
      "dnsLatency": 0
   },
			. . .
			. . .
			. . .

   {
      "macAddress": "f0:d7:aa:df:59:a2",
      "protocol": "BG",
      "locationId":{
         "type": "locallocationid",
         "id": 95
      },
      "eventType": "Success",
      "bssid": "00:11:74:88:af:70",
      "channel": 1,
      "timestamp": 1495009833,
      "associatedAPName": "Mojo_88:AF:8F",
      "ssid": "WebAppsDev",
      "associationTimestamp": 1495009833000,
      "authenticationTimestamp": 1495009833000,
      "networkTimestamp": 1495009833000,
      "autoTestSessionId": null,
      "autoTestStatusCode": 0,
      "autoTestStatus": null,
      "dhcpLatency": 22,
      "aaaLatency": 0,
      "dnsLatency": 546
   }],
   "failureLogs":[{
      "macAddress": "f0:d7:aa:df:59:a2",
      "protocol": "BG",
      "locationId":{
         "type": "locallocationid",
         "id": 95
      },
      "eventType": "Failure",
      "bssid": "00:11:74:88:af:70",
      "channel": 1,
      "timestamp": 1495008869,
      "associatedAPName": "Mojo_88:AF:8F",
      "ssid": "WebAppsDev",
      "associationTimestamp": 1495008849000,
      "authenticationTimestamp": 1495008869000,
      "networkTimestamp": 1495008869000,
      "autoTestSessionId": null,
      "autoTestStatusCode": 0,
      "autoTestStatus": null,
      "failureCode": 8,
      "failure": "EAPOL Handshake Failure",
      "subFailureCode": 41,
      "subFailure": "Maximum retries for 3/4 msg reached.",
      "fileId": "DF59A2-88AF70-008869"
   },	
			. . .
			. . . 
			. . .

   {
   "macAddress": "f0:d7:aa:df:59:a2",
   "protocol": "BG",
   "locationId":{
      "type": "locallocationid",
      "id": 95
   },
   "eventType": "Failure",
   "bssid": "00:11:74:88:af:70",
   "channel": 1,
   "timestamp": 1495007414,
   "associatedAPName": "Mojo_88:AF:8F",
   "ssid": "WebAppsDev",
   "associationTimestamp": 1495007394000,
   "authenticationTimestamp": 1495007414000,
   "networkTimestamp": 1495007414000,
   "autoTestSessionId": null,
   "autoTestStatusCode": 0,
   "autoTestStatus": null,
   "failureCode": 8,
   "failure": "EAPOL Handshake Failure",
   "subFailureCode": 41,
   "subFailure": "Maximum retries for 3/4 msg reached.",
   "fileId": "DF59A2-88AF70-007414"
}]
}
API Calls
Get

/V5/devices/clients/connectionlogs

Client Connection Logs

Description This API is used to fetch the connection logs for a client.
Users with the following roles can call this API: super user, administrator, operator, and viewer.
Syntax
GET  <Base_URL>/devices/clients/connectionlogs?clientmacaddress=<value>&fromtime=<value>&totime=<value>&logtype=<value>&failuretype=<value>&limit=<value>

Here,

  • clientmacaddress

    It is used to specify MAC address of a client. It takes String value. It is a mandatory field. To fetch the appropriate clientmacaddress you can use Clients call.

  • fromtime

    It is used to specify start time in epoch format. It takes an Integer value. The default value is -1.

  • totime

    It is used to specify end time in epoch format. It takes an Integer value. The default value is -1.

  • logtype

    It is used to specify the types of logs to be fetched. It takes String value. Possible values are success, failure, and all (default).

  • failuretype

    It is used to specify the filter to retrieve logs by failure code. It takes an Integer value. Refer Failure Code for the list of failure codes.

  • limit

    It is used to specify the number of connection logs to be retrieved. It takes an Integer value.
Sample code
GET https://training.mojonetworks.com/new/webservice/V5/devices/clients/connectionlogs?clientmacaddress=60:36:DD:F7:E3:C4
GET https://training.mojonetworks.com/new/webservice/V5/devices/clients/connectionlogs?clientmacaddress=60:36:DD:F7:E3:C4&limit=2
Request Body  This API call does not require any request body parameters.
Response Body If the API call is successful, the HTTP response status is 200.
The response body contains Client Connection Logs. The Client Connection Logs are in the application/json format and are divided into two sections successLogs and failureLogs. The fields specific to success or failure logs are explicitly mentioned, rest of the fields are common to both.