Client Classification Policy Tree
The API is used to fetch details of the client classification policy and of the location on which the policy is created. It also provides details of the child locations inheriting the policy.
JSON Table
| Attribute | Data Type | Description |
|---|---|---|
| type | String | The type of location on which the policy is created. The applicable values are:
|
| id | application/json | Location identifier for the policy. The value is of the type Location Id json. |
| name | String | Name of the location. |
| accessibleToUser | boolean | A true or false value indicating whether the user has rights to access this location. |
| timezoneId | int | The JAVA timezone ID of the location. |
| locationTag | String | A user-defined tag for the location. |
| children | application/json | A list of IDs of the child locations. The ID is a JSON object. |
| children/type | String | Its the type of child location ID. The applicable values are:
The remotelocationid ID type is applicable only in cluster environments. |
| children/id | int | The system-generated unique ID of the child location. |
| children/name | String | Name of the child location. |
| children/accessibleToUser | boolean | A true or false value indicating whether the user has rights to access this child location. |
| children/timezoneId | int | The JAVA timezone ID of the child location. |
| children/locationTag | String | A user-defined tag for the child location. |
| children/children | application/json | A list of IDs of the child locations. The ID is a JSON object. |
| children/policy | application/json | Details of the policy applied or inherited at the location. |
| children/inherited | boolean | A true or false value indicating if the child has inherited the policy or not. |
| policy | application/json | Details of the policy applied at the location. |
| policy/policyCreatedAtLocId | application/json | The ID of the location at which the policy has been defined. For details about the JSON, click Location ID. |
| policy/policyType | String | Type of the policy. Applicable value is CLIENT_CLASSIFICATION_POLICY. |
| policy/autoClassifyNewlyDiscClients | boolean | A true or false value indicating whether newly discovered clients can be classified. True indicates that the newly discovered clients will be automatically classified. |
| policy/autoClassifyNewlyDiscClientsAs | int | Category of the newly discovered client. The applicable values are:
|
| policy/nonauthSGPClAsAuth | boolean | A true or false value indicating whether clients running AirTight Mobile can be classified as authorized. True indicates that the setting is enabled. |
| policy/smartDevicesWithSGPAsApproved | boolean | A true or false value indicating whether smart device clients running AirTight Mobile can be classified as approved. True indicates that the setting is enabled. |
| policy/uncatClientsAssocToExtAP | boolean | A true or false value indicating whether all uncategorized clients that connect to an external AP can be classified as External. True indicates that the clients can be classified as External. |
| policy/uncatClientAssocToRogueAp | boolean | A true or false value indicating whether clients other than authorized clients that connect to rogue AP can be reclassified as Rogue. True indicates that the clients can be reclassified as Rogue. |
| policy/uncatClientAssocToPotExtAP | boolean | A true or false value indicating whether all uncategorized clients that connect to a potentially external AP can be classified as External. True indicates that the uncategorized clients will be classified as External. |
| policy/uncatClientAssocToPotRogueAP | boolean | A true or false value indicating whether uncategorized clients other than authorized clients that connect to a potentially rogue AP can be reclassified as rogue. True indicates that the setting is enabled |
| policy/unauthClientAssocToAuthAP | boolean | A true or false value indicating whether external clients can be reclassified according the value for the externalClAssocAuthAPReClassify attribute. |
| policy/uncatClientAssocToAuthAP | boolean | A true or false value indicating whether uncategorized clients can be classified according to the value for the uncatClAssocAuthAPReClassify attribute. True indicates that the setting is enabled. |
| policy/guestClientAssocToExtAP | boolean | A true or false value indicating whether all guest clients connected to an external AP can be classified as External. True indicates that the setting is enabled. |
| policy/guestClientAssocToPotExtAP | boolean | A true or false value indicating whether clients that connect to a potentially external AP can be classified as External. True indicates that the setting is enabled. |
| policy/clNotReclassApMisconfig | boolean | A true or false value indicating whether clients connected to a misconfigured AP can be classified as uncategorized, external guest clients. False indicates that the clients connected to a misconfigured AP can be classified as uncategorized. |
| policy/clNotReclassNotCommOnWired | boolean | A true or false value indicating whether the client’s wireless traffic unidentified on the wired network can be classified as uncateorized, external clients. False indicates that the client’s wireless traffic unidentified on the wired network can be classified as uncateorized. |
| policy/guestClientAssocToAuthAP | boolean | A true or false value indicating whether guest clients connected to Authorized APs are classified according to the value set for the guestClAssocAuthAPReClassify attribute. True indicates that the setting is enabled. |
| policy/externalClientAssocToAuthGuestAP | boolean | A true or false value indicating whether external clients connected to Authorized APs are classified according to the value set for the externalClAssocAuthAPReClassify attribute. True indicates that the setting is enabled. |
| policy/uncatClientAssocToAuthGuestAP | boolean | A true or false value indicating whether external clients connecting to authorized APs are classified according to the value set for the uncatClAssocAuthAPReClassify attribute. True indicates that the setting is enabled. |
| policy/clNotReclassGuestApMisconfig | boolean | A true or false value indicating whether clients connected to a misconfigured guest AP are classified as uncategorized, external clients. Set to false to classify the client as uncategorized and external. |
| policy/clNotReclassGuestNotCommOnWired | boolean | A true or false value indicating whether clients with unidentified wireless traffic are classified as uncategorized guest clients. Set to false to classify the client as uncategorized. |
| policy/clRssiBasedClassification | boolean | A true or false value indicating whether the RSSI-based classification for clRssiBasedClassifyAsUncat and clRssiBasedClassifyAsExt is enabled. |
| policy/clRssiBasedClassifyAsUncat | boolean | A true or false value indicating whether the RSSI-based client classification for uncategorized clients must be enabled. |
| policy/clRssiBasedClassifyAsExt | boolean | A true or false value indicating whether the RSSI-based client classification for External clients must be enabled. |
| policy/clClassifyRssiThreshold | Reclassification of clients with RSSI greater than x dBm. | |
| policy/clClassifyRssiGrp | int | The applicable values are:
|
| policy/clRogueIfBrdgeCorpNw | boolean | A true or false value indicating whether the reclassification of clients other than authorized, as Rogue, is enabled. The reclassification occurs if the client is detected as bridging onto Wi-Fi to the wired corporate network. |
| policy/externalClAssocAuthAPReClassify | in | The applicable values are:
|
| policy/uncatClAssocAuthAPReClassify | intt | The applicable values are:
|
| policy/guestClAssocAuthAPReClassify | int | The applicable values are:
|
| inherited | boolean | A true or false value indicating whether the policy applied at the location is inherited or not. |
Copy Sample JSON
Sample JSON
{
"type": "PolicyLocation",
"id": {
"type": "locallocationid",
"id": 0
},
"name": "Locations",
"accessibleToUser": true,
"timezoneId": "Asia/Kolkata",
"locationTag": null,
"children": [
{
"type": "PolicyLocation",
"id": {
"type": "locallocationid",
"id": -1
},
"name": "Unknown",
"accessibleToUser": true,
"timezoneId": "Asia/Kolkata",
"locationTag": null,
"children": [],
"policy": null,
"inherited": true
},
{
"type": "PolicyLocation",
"id": {
"type": "locallocationid",
"id": 3
},
"name": "America",
"accessibleToUser": true,
"timezoneId": "Asia/Kolkata",
"locationTag": null,
"children": [
{
"type": "PolicyLocation",
"id": {
"type": "locallocationid",
"id": 7
},
"name": "California",
"accessibleToUser": true,
"timezoneId": "Asia/Kolkata",
"locationTag": null,
"children": [],
"policy": null,
"inherited": true
},
{
"type": "PolicyLocation",
"id": {
"type": "locallocationid",
"id": 5
},
"name": "Chicago",
"accessibleToUser": true,
"timezoneId": "Asia/Kolkata",
"locationTag": null,
"children": [],
"policy": null,
"inherited": true
},
{
"type": "PolicyLocation",
"id": {
"type": "locallocationid",
"id": 6
},
"name": "Palo Alto",
"accessibleToUser": true,
"timezoneId": "Asia/Kolkata",
"locationTag": null,
"children": [],
"policy": null,
"inherited": true
}
],
"policy": null,
"inherited": true
},
{
"type": "PolicyLocation",
"id": {
"type": "locallocationid",
"id": 2
},
"name": "Asia",
"accessibleToUser": true,
"timezoneId": "Asia/Kolkata",
"locationTag": null,
"children": [
{
"type": "PolicyLocation",
"id": {
"type": "locallocationid",
"id": 8
},
"name": "India",
"accessibleToUser": true,
"timezoneId": "Asia/Kolkata",
"locationTag": null,
"children": [
{
"type": "PolicyLocation",
"id": {
"type": "locallocationid",
"id": 10
},
"name": "Bangalore",
"accessibleToUser": true,
"timezoneId": "Asia/Kolkata",
"locationTag": null,
"children": [],
"policy": null,
"inherited": true
},
{
"type": "PolicyLocation",
"id": {
"type": "locallocationid",
"id": 11
},
"name": "Mumbai",
"accessibleToUser": true,
"timezoneId": "Asia/Kolkata",
"locationTag": null,
"children": [],
"policy": null,
"inherited": true
},
{
"type": "PolicyLocation",
"id": {
"type": "locallocationid",
"id": 9
},
"name": "Pune",
"accessibleToUser": true,
"timezoneId": "Asia/Kolkata",
"locationTag": null,
"children": [],
"policy": null,
"inherited": true
}
],
"policy": null,
"inherited": true
}
],
"policy": null,
"inherited": true
},
{
"type": "PolicyLocation",
"id": {
"type": "locallocationid",
"id": 1
},
"name": "MSU Child",
"accessibleToUser": true,
"timezoneId": "Asia/Kolkata",
"locationTag": null,
"children": [],
"policy": null,
"inherited": true
},
{
"type": "PolicyLocation",
"id": {
"type": "locallocationid",
"id": 19
},
"name": "SwapnilD",
"accessibleToUser": true,
"timezoneId": "Asia/Kolkata",
"locationTag": null,
"children": [],
"policy": null,
"inherited": true
},
{
"type": "PolicyLocation",
"id": {
"type": "locallocationid",
"id": 17
},
"name": "VijayP",
"accessibleToUser": true,
"timezoneId": "Asia/Kolkata",
"locationTag": null,
"children": [],
"policy": null,
"inherited": true
}
],
"policy": {
"policyCreatedAtLocId": null,
"policyType": "CLIENT_CLASSIFICATION_POLICY",
"autoClassifyNewlyDiscClients": false,
"autoClassifyNewlyDiscClientsAs": 8,
"nonauthSGPClAsAuth": true,
"smartDevicesWithSGPAsApproved": false,
"uncatClientsAssocToExtAP": true,
"uncatClientAssocToRogueAp": true,
"uncatClientAssocToPotExtAP": false,
"uncatClientAssocToPotRogueAP": true,
"unauthClientAssocToAuthAP": false,
"uncatClientAssocToAuthAP": true,
"guestClientAssocToExtAP": false,
"guestClientAssocToPotExtAP": false,
"clNotReclassApMisconfig": true,
"clNotReclassNotCommOnWired": false,
"guestClientAssocToAuthAP": false,
"externalClientAssocToAuthGuestAP": true,
"uncatClientAssocToAuthGuestAP": true,
"clNotReclassGuestApMisconfig": true,
"clNotReclassGuestNotCommOnWired": false,
"clRssiBasedClassification": false,
"clRssiBasedClassifyAsUncat": false,
"clRssiBasedClassifyAsExt": false,
"clClassifyRssiThreshold": -60,
"clClassifyRssiGrp": 7,
"clRogueIfBrdgeCorpNw": true,
"externalClAssocAuthAPReClassify": 7,
"uncatClAssocAuthAPReClassify": 7,
"guestClAssocAuthAPReClassify": 7
},
"inherited": false
}
API Calls
/V7/configuration/locationbased/clientclassification/policytree