Skip to content

prune_policy

Configuration for Prune Policy resource.

(click to see Operations)

Properties

(click to see Operations)

NameData TypePermissionsDescription
do_auto_purge<Boolean>Read-writeTrue, if user wants to opt for auto DB data purging once disk usage reaches threshold value.
policy_name<String>Read-writePolicy Name.
Minimum length = 1
Maximum length = 128
data_to_keep_in_days<Integer>Read-writeNumber of days data to retain.
Minimum value = 15
Maximum value =

Operations

(click to see Properties)

GET| UPDATE

Some options that you can use for each operations:

  • Getting warnings in response:NITRO allows you to get warnings in an operation by specifying the "warning" query parameter as "yes". For example, to get warnings while connecting to the NetScaler appliance, the URL is as follows:

    http://<netscaler-ip-address>/nitro/v1/config/login?warning=yes

    If any, the warnings are displayed in the response payload with the HTTP code "209 X-NITRO-WARNING".

  • Authenticated access for individual NITRO operations:NITRO allows you to logon to the NetScaler appliance to perform individual operations. You can use this option instead of creating a NITRO session (using the login object) and then using that session to perform all operations,

    To do this, you must specify the username and password in the request header of the NITRO request as follows:

    X-NITRO-USER:<username>

    X-NITRO-PASS:<password>

    Note: In such cases, make sure that the request header DOES not include the following:

    Cookie:NITRO_AUTH_TOKEN=<tokenvalue>

Note:

Mandatory parameters are marked in red and placeholder content is marked in <green>.

get

URL: https://<MGMT-IP>/nitro/v1/config/prune_policy

HTTP Method: null

Response Payload:

{ "errorcode": 0, "message": "Done", "severity": ;ltString_value>, "prune_policy":[{
"do_auto_purge":<Boolean_value>,
"policy_name":<String_value>,
"data_to_keep_in_days":<Integer_value>}]}

update

URL: https://<MGMT-IP>/nitro/v1/config/prune_policy/policy_name_value<String>

HTTP Method: null

Request Payload:

{prune_policy:{
<b>"data_to_keep_in_days":<Integer_value></b>,
"policy_name":<String_value>,
"do_auto_purge":<Boolean_value>}}

Response Payload:

{ "errorcode": 0, "message": "Done", "severity": ;ltString_value>, "prune_policy":[{
"do_auto_purge":<Boolean_value>,
"policy_name":<String_value>,
"data_to_keep_in_days":<Integer_value>}]}