auto-deletion-policy

Auto Deletion Policy

Wireless Manager stores historical information about the devices visible to it and the events related to these devices. The rate of growth of this information is dependent on the volatility of the wireless environment at the deployed location. So, it becomes necessary to delete this information periodically, as it becomes obsolete after some time. Auto-Deletion allows the user to specify values of various auto deletion parameters to control the frequency of deletion of information.

The system generates an event for tracking the action of auto-deletion which in turn gives us the information only about the device deletion. There is no event separately generated that indicates event deletion.

JSON Table

Attribute Data Type Description
policyCreatedAtLocId application/json It is used to specify location on which global policy is to be updated
(this must be the location on which global policy was created). The value
is of the type Location
ID JSON.
policyType String Type of the policy.
autoDeleteApUncatEnable boolean True or false value indicating whether the auto deletion of uncategorized
AP is enabled or not.
autoDeleteApRogueEnable boolean True or false value indicating whether auto deletion of rogue APs is
enabled or not.
autoDeleteApExtEnable boolean True or false value indicating whether auto deletion of external APs
is enabled or not.
autoDeleteApUncatTimeout application/json Timeout for uncategorized APs.
autoDeleteApUncatTimeout/minValue int Minimum timeout value for uncategorized APs.
autoDeleteApUncatTimeout/maxValue int Maximum timeout value for uncategorized APs.
autoDeleteApUncatTimeout/value int User configured value for uncategorized APs. The range is from 1 to
30.
autoDeleteApRogueTimeout application/json Timeout for rogue APs.
autoDeleteApRogueTimeout/minValue int Minimum timeout value for rogue APs.
autoDeleteApRogueTimeout/maxValue int Maximum timeout value for rogue APs.
autoDeleteApRogueTimeout/value int User configured time out value for rogue APs. The range is from 1 to
30.
autoDeleteApExtTimeout application/json Timeout for external APs.
autoDeleteApExtTimeout/minValue int Minimum timeout value for external APs.
autoDeleteApExtTimeout/maxValue int Maximum timeout value for external APs.
autoDeleteApExtTimeout/value int User configured time out value for external APs. The range is from 1
to 30.
autoDeleteClUncatEnable boolean True or false value indicating whether auto deletion of uncategorized
clients is enabled or not.
autoDeleteClAuthEnable boolean True or false value indicating whether auto deletion of authorized clients
is enabled or not.
autoDeleteClExternalEnable boolean True or false value indicating whether auto deletion of external clients
is enabled or not.
autoDeleteClRogueEnable boolean True or false value indicating whether auto deletion of rogue clients
is enabled or not.
autoDeleteClGuestEnable boolean True or false value indicating whether auto deletion of guest clients
is enabled or not.
autoDeleteClUncatTimeout application/json Timeout for uncategorized clients.
autoDeleteClUncatTimeout/minValue int Minimum timeout value for uncategorized clients.
autoDeleteClUncatTimeout/maxValue int Maximum timeout value for uncategorized clients.
autoDeleteClUncatTimeout/value int User configured time out value for uncategorized clients. The range
is from 1 to 30.
autoDeleteClAuthTimeout application/json Timeout for authorized clients.
autoDeleteClAuthTimeout/minValue int Minimum timeout value for authorized clients.
autoDeleteClAuthTimeout/maxValue int Maximum timeout value for authorized clients.
autoDeleteClAuthTimeout/value int User configured time out value for authorized clients. The range is
from 1 to 30.
autoDeleteClExternalTimeout application/json Timeout for external clients.
autoDeleteClExternalTimeout/minValue int Minimum timeout value for external clients.
autoDeleteClExternalTimeout/maxValue int Maximum timeout value for external clients.
autoDeleteClExternalTimeout/value int User configured time out value for external clients. The range is from
1 to 30.
autoDeleteClRogueTimeout application/json Timeout for rogue clients
autoDeleteClRogueTimeout/minValue int Minimum timeout value for rogue clients.
autoDeleteClRogueTimeout/maxValue int Maximum timeout value for rogue clients.
autoDeleteClRogueTimeout/value int User configured time out value for rogue clients. The range is from
1 to 30.
autoDeleteClGuestTimeout application/json Timeout for guest clients.
autoDeleteClGuestTimeout/minValue int Minimum timeout value for guest clients.
autoDeleteClGuestTimeout/maxValue int Maximum timeout value for guest clients.
autoDeleteClGuestTimeout/value int User configured time out value for guest clients. The range is from
1 to 30.
autoDeleteMaxNumSecurityEvents application/json Number of security events that would be retained on the server.
autoDeleteMaxNumSecurityEvents/minValue int Minimum value for number of security events that would be retained on
the server.
autoDeleteMaxNumSecurityEvents/maxValue int Maximum value for number of security events that would be retained on
the server.
autoDeleteMaxNumSecurityEvents/value int User configured value for number of security events that would be retained
on the server. The range is from 0 to 80000.
autoDeleteMaxNumPerformanceEvents application/json Number of performance events that would be retained on the server.
autoDeleteMaxNumPerformanceEvents/minValue int Minimum value for number of performance events that would be retained
on the server.
autoDeleteMaxNumPerformanceEvents/maxValue int Maximum value for number of performance events that would be retained
on the server.
autoDeleteMaxNumPerformanceEvents/value int User configured value for of performance events that would be retained
on the server. The range is from 0 to 0.
autoDeleteMaxNumSystemEvents application/json Number of system events that would be retained on the server.
autoDeleteMaxNumSystemEvents/minValue int Minimum value for number of system events that would be retained on
the server.
autoDeleteMaxNumSystemEvents/maxValue int Maximum value for number of system events that would be retained on
the server.
autoDeleteMaxNumSystemEvents/value int User configured value for number of system events that would be retained
on the server. The range is from 0 to 2000.
dontAutoDeleteManuallyClassifiedAp boolean True or false value indicating whether manual deletion of classified
AP is enabled or not.
dontAutoDeleteManuallyClassifiedClient boolean True or false value indicating whether manual deletion of classified
client is enabled or not.
autoDeleteNumEventLocInfo application/json Number of events for which location information would be retained on
the server.
autoDeleteNumEventLocInfo/minValue int Minimum value for number of events for which location information would
be retained on the server.
autoDeleteNumEventLocInfo/maxValue int Maximum value for number of events for which location information would
be retained on the server.
autoDeleteNumEventLocInfo/value int User configured value for number of events for which location information
would be retained on the server. The range is from 0 to 82000.
autoDeleteMaxDaysForEventLocInfo application/json Maximum number of events for which event location information would
be retained on the server.
autoDeleteMaxDaysForEventLocInfo/minValue int Minimum value for number of events for which event location information
would be retained on the server.
autoDeleteMaxDaysForEventLocInfo/maxValue int Maximum value for number of events for which event location information
would be retained on the server.
autoDeleteMaxDaysForEventLocInfo/value int User configured value for number of events for which event location
information would be retained on the server. The range is from 1 to 180.
autoDeleteMinDelevtData application/json Numberof days for which events should be retained in db.
autoDeleteMinDelevtData/minValue int Minimum value for number of days for which events should be retained
in db.
autoDeleteMinDelevtData/maxValue int Maximum value for number of days for which events should be retained
in db.
autoDeleteMinDelevtData/value int User configured value for number of days for which events should be
retained in db. The range is from 1 to 180.
autoDeleteNwEnable boolean True or false value indicating whether network deletion is enabled or
not.
autoDeleteNwTimeout application/json Number of days to retain exposed Networks.
autoDeleteNwTimeout/minValue int Minimum value for number of days to retain exposed Networks.
autoDeleteNwTimeout/maxValue int Maximum value for number of days to retain exposed Networks.
autoDeleteNwTimeout/value int User configured value for number of days to retain exposed Networks.
The range is from 1 to 90.
autoDeleteMinTimeout application/json Minimum days for auto deletion.
autoDeleteMinTimeout/minValue int Minimum value for minimum days for auto deletion.
autoDeleteMinTimeout/maxValue int Maximum for minimum days for auto deletion.
autoDeleteMinTimeout/value int User configured value for minimum days for auto deletion. The range
is from 1 to 1.
autoDeleteNwTimeout application/json Number of days to retain exposed networks.
autoDeleteMaxTimeout/minValue int Minimum Number of days to retain exposed networks.
autoDeleteMaxTimeout/maxValue int Maximum Number of days to retain exposed networks.
autoDeleteMaxTimeout/value int User configured value forNumber of days to retain exposed networks.
The range is from 30 to 30.

Copy Sample JSON
Sample JSON 
{
    "policyCreatedAtLocId":
    {
       "type": "locallocationid",
       "id": 0
    },
    "policyType": "AUTO_DELETION_POLICY",
    "autoDeleteApUncatEnable": true,
    "autoDeleteApRogueEnable": false,
    "autoDeleteApExtEnable": true,
    "autoDeleteApUncatTimeout":
     {
        "minValue": 1,
        "maxValue": 30,
        "value": 7
     },
    "autoDeleteApRogueTimeout":
     {
        "minValue": 1,
        "maxValue": 30,
        "value": 30
     },
    "autoDeleteApExtTimeout": 
     {
        "minValue": 1,
        "maxValue": 30,
        "value": 7
      },
    "autoDeleteClUncatEnable": true,
    "autoDeleteClAuthEnable": false,
    "autoDeleteClExternalEnable": true,
    "autoDeleteClRogueEnable": false,
    "autoDeleteClGuestEnable": true,
    "autoDeleteClUncatTimeout":
     {
        "minValue": 1,
        "maxValue": 30,
        "value": 2
     },
    "autoDeleteClAuthTimeout":
     {
        "minValue": 1,
        "maxValue": 30,
        "value": 7
     },
    "autoDeleteClExternalTimeout": 
     {
        "minValue": 1,
        "maxValue": 30,
        "value": 3
     },
    "autoDeleteClRogueTimeout":
     {
        "minValue": 1,
        "maxValue": 30,
        "value": 7
     },
    "autoDeleteClGuestTimeout":
     {
        "minValue": 1,
        "maxValue": 30,
        "value": 7
     },
    "autoDeleteMaxNumSecurityEvents":
     {
        "minValue": 0,
        "maxValue": 80000,
        "value": 50000
     },
    "autoDeleteMaxNumPerformanceEvents":
     {
        "minValue": 0,
        "maxValue": 0,
        "value": 0
     },
    "autoDeleteMaxNumSystemEvents":
     {
        "minValue": 0,
        "maxValue": 2000,
        "value": 1000
     },
    "dontAutoDeleteManuallyClassifiedAp": false,
    "dontAutoDeleteManuallyClassifiedClient": false,
    "autoDeleteNumEventLocInfo": 
     {
        "minValue": 0,
        "maxValue": 82000,
        "value": 60000
     },
    "autoDeleteMaxDaysForEventLocInfo": {
        "minValue": 1,
        "maxValue": 180,
        "value": 45
    },
    "autoDeleteMinDelevtData": {
        "minValue": 1,
        "maxValue": 180,
        "value": 30
    },
    "autoDeleteNwEnable": true,
    "autoDeleteNwTimeout": {
        "minValue": 1,
        "maxValue": 90,
        "value": 30
    },
    "autoDeleteMinTimeout": {
        "minValue": 1,
        "maxValue": 1,
        "value": 1
    },
    "autoDeleteMaxTimeout": {
        "minValue": 30,
        "maxValue": 30,
      "value": 30
    }
}
API Calls
Get

/V5/configuration/global/autodeletion

Put

/V5/configuration/global/autodeletion

Put

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

Get Auto Deletion Policy

Description This API is used to get parameters of auto deletion global policy.
Users with the roles can call this API: superuser, administrator, operator, and viewer.
Syntax
GET <Base_URL>/configuration/global/autodeletion?nodeid=<Value>&isdefault=<Value>
Sample code
GET https://training.mojonetworks.com/new/webservice/V5/configuration/global
/autodeletion

 

GET https://training.mojonetworks.com/new/webservice/V5/configuration/global
/autodeletion?nodeid=0&isdefault=false
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 parameters of auto deletion global policy. The response is in the
application/json format.

Update Auto Deletion Global Policy

Description This API is used to update parameters of auto deletion global policy.
Users with the roles can call this API: superuser, administrator, operator, and viewer.
Syntax
PUT <Base_URL>/configuration/global/autodeletion
Sample code
PUT https://training.mojonetworks.com/new/webservice/V5/configuration/
global/autodeletion
Request Body The parameters are passed in the application/json format.
A sample request will have a structure as follows:

{
   ... 
   List of auto deletion policy JSONs with the mandatory attributes mentioned above
   ...
}
Response Body If the API call is successful, the HTTP response status is 200.
The response body contains parameters of auto deletion global policy. The response is in
the application/json format.

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.

Post 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.

Delete 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.

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.