Developer Documentation
NetScaler SDX 14.1 NITRO API Reference

backup_policy

March 20, 2024
Contributed by: 
C

Configuration for Backup Policy resource.

Properties

(click to see Operations )

Name Data Type Permissions Description
backup_to_retain Read-write Number of previous backups to retain.

Minimum value = 1

Maximum value =
enable_external_transfer Read-write Enable transfer of backup file to external server.
policy_name Read-write Policy Name.

Minimum length = 1

Maximum length = 128
external_storage_info Read-write Information of the External storage for backup file.
backup_password Read-write Password for backup file encryption.
encrypt_backup_file Read-write Encrypts backup files.
id Read-write Id is system generated key.

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

The following parameters can be used in the nitro request : onerror <String_value>

Use this parameter to set the onerror status for nitro request. Applicable only for bulk requests.

Default value: EXIT

Possible values = EXIT, CONTINUE

get

URL: https://<MGMT-IP>/nitro/v2/config/backup_policy HTTPS Method: GET

Request Headers: Accept: application/json

X-NITRO-USER:username_value<String>

X-NITRO-PASS:password_value<String>

or

Cookie:NITRO_AUTH_TOKEN=token_value<String>

Response: HTTPS Status Code on Success: 200 OK HTTPS Status Code on Failure: 4xx (for general HTTPS errors) or 5xx (for NetScaler-MAS-specific errors). The response payload provides details of the error

Response Headers:

Content-Type:application/json

Response Payload: 

{ "errorcode": 0, "message": "Done", "severity": ;ltString_value;gt, "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>}]}

<!--NeedCopy-->

update

URL: https://<MGMT-IP>/nitro/v2/config/backup_policy/id_value<String> HTTPS Method: PUT

Request Headers: Content-Type: application/json

X-NITRO-USER:username_value<String>

X-NITRO-PASS:password_value<String>

or

Cookie:NITRO_AUTH_TOKEN=token_value<String>

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>}}

<!--NeedCopy-->

Response: HTTPS Status Code on Success: 200 OK HTTPS Status Code on Failure: 4xx (for general HTTPS errors) or 5xx (for NetScaler-MAS-specific errors). The response payload provides details of the error

Response Payload: 

{ "errorcode": 0, "message": "Done", "severity": ;ltString_value;gt, "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>}]}

<!--NeedCopy-->
backup_policy
March 20, 2024
Contributed by: 
C
March 20, 2024
Contributed by: 
C

In this article

Site feedback | Your privacy choices footer linkYour Privacy Choices | Privacy and legal terms | Cookie preferences | Consent settings | docs.cloud.com
© 1999- Cloud Software Group, Inc. All rights reserved.