Skip to content

device_backup_policy

Configuration for Device Backup Policy resource.

(click to see Operations)

Properties

(click to see Operations)

NameData TypePermissionsDescription
external_storage_info<backup_external_storage>Read-writeInformation of the External storage for backup file.
backup_on_cfg_sav_trap<Boolean>Read-writeBackup On recieving NetscalerConfigSave trap.
device_family<String>Read-writeDevice family whose devices need to be backed up..
backup_password<String>Read-writePassword for backup file encryption.
encrypt_backup_file<Boolean>Read-writeEncrypts backup files.
enable_scheduled_backups<Boolean>Read-writeEnable Scheduled Backup (default is enabled).
enable_external_transfer<Boolean>Read-writeEnable transfer of device backup files to external server.
polling_interval<Integer>Read-writeFrequency of device backup in hours.
backup_times<String>Read-writeComma Separated string of backup times to be scheduled..
number_of_backups<Integer>Read-writeNumber of backup files maintained per device.
Minimum value = 1
is_interval_based<Boolean>Read-writeParameter to decide whether backup setting is interval based or time based.
enable_geodb_backups<Boolean>Read-writeEnable GeoDB Backup from NetScaler (default is disabled).

Operations

(click to see Properties)

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

do_poll

URL: https://<MGMT-IP>/nitro/v1/config/device_backup_policy?action=do_poll;onerror=<String_value>

HTTP Method: null

Request Payload:

{device_backup_policy: {
<b>"number_of_backups":<Integer_value></b>,
<b>"is_interval_based":<Boolean_value></b>,
"external_storage_info":<backup_external_storage_value>,
"enable_scheduled_backups":<Boolean_value>,
"device_family":<String_value>,
"encrypt_backup_file":<Boolean_value>,
"enable_external_transfer":<Boolean_value>,
"backup_times":<String_value>,
"backup_on_cfg_sav_trap":<Boolean_value>,
"backup_password":<String_value>,
"polling_interval":<Integer_value>,
"enable_geodb_backups":<Boolean_value>}}

Response Payload:

{ "errorcode": 0, "message": "Done", "severity": ;ltString_value>, "device_backup_policy":[{
"external_storage_info":<backup_external_storage_value>,
"backup_on_cfg_sav_trap":<Boolean_value>,
"device_family":<String_value>,
"backup_password":<String_value>,
"encrypt_backup_file":<Boolean_value>,
"enable_scheduled_backups":<Boolean_value>,
"enable_external_transfer":<Boolean_value>,
"polling_interval":<Integer_value>,
"backup_times":<String_value>,
"number_of_backups":<Integer_value>,
"is_interval_based":<Boolean_value>,
"enable_geodb_backups":<Boolean_value>}]}

get

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

HTTP Method: null

Response Payload:

{ "errorcode": 0, "message": "Done", "severity": ;ltString_value>, "device_backup_policy":[{
"external_storage_info":<backup_external_storage_value>,
"backup_on_cfg_sav_trap":<Boolean_value>,
"device_family":<String_value>,
"backup_password":<String_value>,
"encrypt_backup_file":<Boolean_value>,
"enable_scheduled_backups":<Boolean_value>,
"enable_external_transfer":<Boolean_value>,
"polling_interval":<Integer_value>,
"backup_times":<String_value>,
"number_of_backups":<Integer_value>,
"is_interval_based":<Boolean_value>,
"enable_geodb_backups":<Boolean_value>}]}

update

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

HTTP Method: null

Request Payload:

{device_backup_policy:{
<b>"number_of_backups":<Integer_value></b>,
<b>"is_interval_based":<Boolean_value></b>,
"external_storage_info":<backup_external_storage_value>,
"enable_scheduled_backups":<Boolean_value>,
"device_family":<String_value>,
"encrypt_backup_file":<Boolean_value>,
"enable_external_transfer":<Boolean_value>,
"backup_times":<String_value>,
"backup_on_cfg_sav_trap":<Boolean_value>,
"backup_password":<String_value>,
"polling_interval":<Integer_value>,
"enable_geodb_backups":<Boolean_value>}}

Response Payload:

{ "errorcode": 0, "message": "Done", "severity": ;ltString_value>, "device_backup_policy":[{
"external_storage_info":<backup_external_storage_value>,
"backup_on_cfg_sav_trap":<Boolean_value>,
"device_family":<String_value>,
"backup_password":<String_value>,
"encrypt_backup_file":<Boolean_value>,
"enable_scheduled_backups":<Boolean_value>,
"enable_external_transfer":<Boolean_value>,
"polling_interval":<Integer_value>,
"backup_times":<String_value>,
"number_of_backups":<Integer_value>,
"is_interval_based":<Boolean_value>,
"enable_geodb_backups":<Boolean_value>}]}