api-object-access

Client Filter

The following table list the client filter parameters that can be used in the respective API calls. Filter Parameters Name column lists the filter names to be used in the API call. These parameters map to the Client JSON attributes mentioned in the JSON attributes column. The column data type contains the appropriate data type for the filter parameters along with the applicable values if any. The Searchable and Sortable column, state whether the filter parameters are searchable and sortable. The value yes in these columns state them as searchable and sortable respectively.

JSON Table

Filter Parameter Name Data Type Searchable Sortable JSON Attributes
devicename String No Yes name
activestatus boolean Yes Yes activeStatus
macaddress String Yes Yes macaddress
ipaddress String Yes Yes ipAddress
capability int Refer the Client Capabilities for applicable values. Yes No capability
locationname String Yes Yes name
group String The applicable values are:

  • AUTHORIZED
  • EXTERNAL
  • UNCATEGORIZED
  • ROGUE
  • GUEST
  • ALL
 Yes Yes group
upsincetimefilter application/JSON Yes Yes upSince
tag String Yes Yes deviceNote
username String Yes Yes userName
vendorname String Yes Yes vendorName
showadhocclient boolean Yes Yes
signalstrength int Yes Yes signalStrength
smartdevicetype String Yes Yes
associatedap String Yes Yes associatedAPName
protocol String The applicable values are:

  • A
  • B
  • BG
 Yes Yes protocol
ssid String Yes Yes ssid
firstdetectedtimefilter
quarantinestatus “String The applicable values are:

  • QUARANTINE_STATUS_OFF
  • QUARANTINE_STATUS_STOPPED
  • QUARANTINE_STATUS_PENDING
  • QUARANTINE_STATUS_ON
  • DOS_QUARANTINE_STATUS_PENDING
  • DOS_QUARANTINE_STATUS_ON
 Yes Yes quarantineStatus
banned boolean Yes Yes banned
troubleshooting boolean Yes Yes
manuallyclassified boolean Yes Yes manuallyClassified
misbehaving String The applicable values are:

  • NO
  • YES
  • NA
 Yes Yes misbehaving
sticky boolean Yes Yes sticky
uplinkdatarate int Yes Yes uplinkDataRate
uplinkusage int Yes Yes uplinkUsage
downlinkdatarate int Yes Yes downlinkDataRate
downlinkusage int Yes Yes downlinkUsage
retryrate int Yes Yes retryRate
manageddeviceboxid int Yes No assocManagedDeviceBoxId
channel int Yes Yes channel
managedclient boolean Yes No
lastfailuretype int
The applicable values are:

  • 1 – Maximum Association Limit Exceeded
  • 2 – Association Capability Mismatch
  • 3 – Association Failure
  • 4 – RADIUS Authentication Failure
  • 5 – RADIUS Server Unreachable
  • 6 – RADIUS Server Not Responding
  • 7 – Incorrect PSK
  • 8 – EAPOL Handshake Failure
  • 9 – Fast Roaming Failure
  • 10 – Portal Shared Secret Mismatch
  • 11 – Portal Authentication Failure
  • 12 – Portal Blackout Period
  • 13 – DHCP Failure
  • 14 – DNS Failure
  • 15 – WAN Failure
  • 16 – MAC Filtering
  • 17 – Google Authentication Failure
 Yes No lastFailureType
failurecount int Yes Yes failureCount
successcount int Yes Yes successCount
averagedatarate int Yes Yes averageDataRate
bestsignalstrength int Yes Yes bestSignalStrength
googleauthorizationstatus String Yes Yes googleAuthorizationStatus
lastconnectionsuccessful boolean Yes No lastConnectionSuccessful
ostype String Yes Yes osType
role String Yes Yes role
poorperformancereasons enum
Applicable values are:

  • LOW_DATA_RATE
  • HIGH_RETRY_RATE
  • LOW_RSSI
  • STICKY
 Yes No poorPerformanceReasons