backup_policy
Configuration for Backup Policy resource.
(click to see Operations)
Properties
(click to see Operations)
| Name | Data Type | Permissions | Description |
|---|---|---|---|
| backup_to_retain | <Integer> | Read-write | Number of previous backups to retain. Minimum value = 1 Maximum value = |
| enable_external_transfer | <Boolean> | Read-write | Enable transfer of backup file to external server. |
| policy_name | <String> | Read-write | Policy Name. Minimum length = 1 Maximum length = 128 |
| external_storage_info | <backup_external_storage> | Read-write | Information of the External storage for backup file. |
| backup_password | <String> | Read-write | Password for backup file encryption. |
| encrypt_backup_file | <Boolean> | Read-write | Encrypts backup files. |
| id | <String> | Read-write | Id is system generated key. |
Operations
(click to see Properties)
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/backup_policy
HTTP Method: null
Response Payload:
{ "errorcode": 0, "message": "Done", "severity": ;ltString_value>, "backup_policy":[{
"backup_to_retain":<Integer_value>,
"enable_external_transfer":<Boolean_value>,
"policy_name":<String_value>,
"external_storage_info":<backup_external_storage_value>,
"backup_password":<String_value>,
"encrypt_backup_file":<Boolean_value>,
"id":<String_value>}]}
update
URL: https://<MGMT-IP>/nitro/v1/config/backup_policy/id_value<String>
HTTP Method: null
Request Payload:
{backup_policy:{
<b>"backup_to_retain":<Integer_value></b>,
"policy_name":<String_value>,
"external_storage_info":<backup_external_storage_value>,
"id":<String_value>,
"encrypt_backup_file":<Boolean_value>,
"enable_external_transfer":<Boolean_value>,
"backup_password":<String_value>}}
Response Payload:
{ "errorcode": 0, "message": "Done", "severity": ;ltString_value>, "backup_policy":[{
"backup_to_retain":<Integer_value>,
"enable_external_transfer":<Boolean_value>,
"policy_name":<String_value>,
"external_storage_info":<backup_external_storage_value>,
"backup_password":<String_value>,
"encrypt_backup_file":<Boolean_value>,
"id":<String_value>}]}