local_policy

Client Classification Policy

Client Classification Policy can assign different policies to different client and devices. The client classification policy determines how clients are classified upon initial discovery and subsequent association with APs. In simple words, it helps us to separate corporate and non-corporate devices having one SSID.

JSON Table

Parameter Data Type Description
policyCreatedAtLocId application/json ID of the location at which the policy has been defined. For details
about the JSON, click Location
ID.
policyType String A read-only field for internal use.
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.
autoClassifyNewlyDiscClientsAs int Category of the newly discovered client. The applicable values are:

  • 7 – Authorized
  • 8 – External
  • 13 – Guest
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.
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.
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.
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.
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.
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.
unauthClientAssocToAuthAP boolean A true or false value indicating whether external clients can be reclassified
according the value for the externalClAssocAuthAPReClassify attribute.
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.
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.
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.
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.
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.
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.
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.
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.
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.
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.
clRssiBasedClassification boolean A true or false value indicating whether the RSSI-based classification
for clRssiBasedClassifyAsUncat and clRssiBasedClassifyAsExt is enabled.
clRssiBasedClassifyAsUncat boolean A true or false value indicating whether the RSSI-based client classification
for uncategorized clients must be enabled.
clRssiBasedClassifyAsExt boolean A true or false value indicating whether the RSSI-based client classification
for External clients must be enabled.
clClassifyRssiThreshold int Reclassification of clients with RSSI greater than x dBm.
clClassifyRssiGrp int The applicable values are:

  • 7 – Authorized
  • 12 – Rogue
  • 13 – Guest
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 WiFi to the wired corporate
network.
externalClAssocAuthAPReClassify int The applicable values are:

  • 7 – Authorized
  • 12 – Rogue
uncatClAssocAuthAPReClassify int The applicable values are:

  • 7 – Authorized
  • 12 – Rogue
guestClAssocAuthAPReClassify int The applicable values are:

  • 7 – Authorized
  • 12 – Rogue

Copy Sample JSON
Sample JSON 
{
    "policyCreatedAtLocId":
    {
        "type": "locallocationid",
        "id": 0
    },
    "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
}
API Calls
Get

/V5/policies/clientclassification/{fetch_factory_default}

Put

/V5/policies/clientclassification

Put

<Base_URL>/V2/analytics/associationdata/{startdate}/{enddate}

Post

/V5/policies/clientclassification

Delete

/V5/policies/clientclassification

Get Client Classification Policy

Description This API is used to fetch the Client Classification Policy at a specified location
from Wireless Manager or Arista Cloud Services.
Users with the roles can call this API: superuser, administrator, operator, and viewer.
Syntax
Get <Base_URL>/policies/clientclassification/{fetch_factory_default}?
locationid=<value>&nodeid=<value>

Here,

  • locationid

    It is an integer value specifying the location for which the Client Classification Policy
    is fetched. To retrieve the value for location id refer Location call.

  • nodeid

    It is an integer value specifying the node in a server cluster setup.

  • fetch_factory_default

    Is a boolean value specifying whether factory default policies will be fetched
    or user-defined policies. If set to true the factory default policies are fetched,
    and if set to false user-defined policies are fetched.
Sample code
Get https://training.mojonetworks.com/new/webservice/V5/policies
/clientclassification/true?locationid=0&nodeid=1
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 the details of Client Classification Policy. The response is in the application/json format.

Customize Client Classification Policy

Description This API is used to customize the Client Classification Policy at a specified location in
Wireless Manager or Arista Cloud Services. After calling this API, the policy
can be modified by calling the Modify Client Classification Policy API at
the specified location.
Users with the roles can call this API: superuser, administrator, operator, and viewer.
Syntax
PUT <Base_URL>/policies/clientclassification?locationid=<value>&nodeid=<value>

Here,

  • locationid

    It is an integer value specifying the location for which the Client Classification Policy is customized.
    To retrieve the value for location id refer Location call.

  • nodeid

    It is an integer value specifying the node in a server cluster setup.
Sample code
PUT https://training.mojonetworks.com/new/webservice/V5/policies/clientclassification?
locationid=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 204.
The response body does not contain any information.

Put APIs

Description This API is used to fetch the APs that match the specified filter criteria from the allowed locations for the logged-in user. If no filters are specified, all the APs from the allowed locations are fetched. However, this API is not supported in a server cluster environment.

Note: Do not use this API to fetch more than 100 devices. For fetching larger number of devices, consider using the Get Paged List of APs API.
User Privileges Users with the following roles can call this API: superuser, administrator, and operator.

Request Body Parameters
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 the details of the APs that match the filter criteria. The response is in the application/json format. Click AP to view the complete detais of the JSON along with a sample output.

Error codes
If the API call is successful, the HTTP response status is 200.
Syntax
GET /devices/aps
Sample code
GET https://training.mojonetworks.com/new/webservice/v2/devices/aps
GET
https://training.mojonetworks.com/new/webservice/v2/devices/aps?macaddress=00:11:74:33:23:12&macaddress=00:11:74:45:12:21
GET
https://training.mojonetworks.com/new/webservice/v2/devices/aps?capability=49&locationid=10&locationid=12&sortcolumn=devicename&sortascending=false
URL Parameters This API call takes optional URL parameters to filter the list of APs to be fetched and the column on which the output must be sorted. AP Filter Parameters lists the parmeter names, datatypes, applicable values, and whether the results can be sorted based on the parameter.
Query Parameters This API call takes optional URL parameters to filter the list of APs to be fetched and the column on which the output must be sorted. AP Filter Parameters lists the parmeter names, datatypes, applicable values, and whether the results can be sorted based on the parameter.
Response Body If the API call is successful, the HTTP response status is 200. The response body contains the details of the APs that match the filter criteria. The response is in the application/json format. Click AP to view the complete detais of the JSON along with a sample output.

Modify Client Classification Policy

Description This API is used to modify Client Classification Policy at a specified location
in Wireless Manager or Arista Cloud Services. Before calling this API, the
policy must be customized by calling the Customize Client Classification Policy
API at the specified location.
Users with the roles can call this API:superuser, administrator, operator, and viewer.
Syntax
POST <Base_URL>/policies/clientclassification?locationid=
<value>&nodeid=<value>

Here,

  • locationid

    It is an integer value specifying the location for which the Client Classification Policy
    is modified. To retrieve the value for location id refer Location call.

  • nodeid

    It is an integer value specifying the node in a server cluster setup.
Sample code
POST https://training.mojonetworks.com/new/webservice/V5/policies/
clientclassification?locationid=2
Request Body This API call requires the modified details of the Client Classification Policy,
which are passed as parameters in the request body. The parameters are passed
in the application/json format. You must provide the appropriate values for
the following mandatory JSON attributes.

  • autoClassifyNewlyDiscClientsAs
  • clClassifyRssiThreshold
  • clClassifyRssiGrp
  • externalClAssocAuthAPReClassify
  • uncatClAssocAuthAPReClassify
  • guestClAssocAuthAPReClassify

A sample request will have a structure as follows:

{
...
List of Client Classification Policy with the mandatory attributes mentioned above
...
}
Response Body If the API call is successful, the HTTP response status is 204.
The response body does not contain any information.

Inherit Client Classification Policy

Description This API is used to inherit Client Classification Policy at a specified location
from its parent location in the Mojo Server or the Arista Cloud Services. The
Client Classification Policy, by default, is inherited from the parent location. This
API can be called to inherit the policy from the parent location if the
Customize Client Classification Policy API was called at a specified
location earlier. On calling this API, the customized policy is deleted and the policy
defined on the parent location is inherited.Users with the roles can call this API: superuser, administrator, operator and viewer.
Syntax
DELETE <Base_URL>/policies/clientclassification?locationid=<value>
&nodeid=<value>

Here,

  • locationid

    It is an integer value specifying the location for which the Client Classification Policy
    is inherited. To retrieve the value for location id refer Location call.

  • nodeid

    It is an integer value specifying the node in a server cluster setup.
Sample code
DELETE
https://training.mojonetworks.com/new/webservice/V5/policies/
clientclassification?locationid=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 204.
The response body does not contain any information.

Test APIs

Description This API is used to fetch the APs that match the specified filter criteria from the allowed locations for the logged-in user. If no filters are specified, all the APs from the allowed locations are fetched. However, this API is not supported in a server cluster environment.

Note: Do not use this API to fetch more than 100 devices. For fetching larger number of devices, consider using the Get Paged List of APs API.
User Privileges Users with the following roles can call this API: superuser, administrator, and operator.

Request Body Parameters
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 the details of the APs that match the filter criteria. The response is in the application/json format. Click AP to view the complete detais of the JSON along with a sample output.

Error codes
If the API call is successful, the HTTP response status is 200.
Syntax
GET /devices/aps
Sample code
GET https://training.mojonetworks.com/new/webservice/v2/devices/aps
GET
https://training.mojonetworks.com/new/webservice/v2/devices/aps?macaddress=00:11:74:33:23:12&macaddress=00:11:74:45:12:21
GET
https://training.mojonetworks.com/new/webservice/v2/devices/aps?capability=49&locationid=10&locationid=12&sortcolumn=devicename&sortascending=false
URL Parameters This API call takes optional URL parameters to filter the list of APs to be fetched and the column on which the output must be sorted. AP Filter Parameters lists the parmeter names, datatypes, applicable values, and whether the results can be sorted based on the parameter.
Query Parameters This API call takes optional URL parameters to filter the list of APs to be fetched and the column on which the output must be sorted. AP Filter Parameters lists the parmeter names, datatypes, applicable values, and whether the results can be sorted based on the parameter.
Response Body If the API call is successful, the HTTP response status is 200. The response body contains the details of the APs that match the filter criteria. The response is in the application/json format. Click AP to view the complete detais of the JSON along with a sample output.