Download full document:

remote_backup_config

Configuration for remote backup configuration resource.

(click to see Operations)

Properties

(click to see Operations)

NameData TypePermissionsDescription
is_enabled<Boolean>Read-writeIs Remote backup enabled for this server.
retention_interval<Integer>Read-writeNo of days upto which the base backup will be retained.
Minimum value = 5
Maximum value =
id<String>Read-writeId is system generated key for all the system users.
backup_vm_ip_address<String>Read-writeBACKUP VM IP Address.

Operations

(click to see Properties)

ADD| GET (ALL)| GET

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

add

URL: https://<MGMT-IP>/nitro/v1/config/remote_backup_config?onerror=<String_value>

HTTP Method: null

Request Payload: 

{remote_backup_config: {
"id":<String_value>,
"backup_vm_ip_address":<String_value>,
"is_enabled":<Boolean_value>,
"retention_interval":<Integer_value>}}

Response Payload: 

{ "errorcode": 0, "message": "Done", "severity": ;ltString_value>, "remote_backup_config":[{
"is_enabled":<Boolean_value>,
"retention_interval":<Integer_value>,
"id":<String_value>,
"backup_vm_ip_address":<String_value>}]}

get (all)

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

HTTP Method: null

Response Payload: 

{ "errorcode": 0, "message": "Done", "severity": ;ltString_value>, "remote_backup_config":[{
"is_enabled":<Boolean_value>,
"retention_interval":<Integer_value>,
"id":<String_value>,
"backup_vm_ip_address":<String_value>}]}

get

URL: https://<MGMT-IP>/nitro/v1/config/remote_backup_config/id_value<String>

HTTP Method: null

Response Payload: 

{ "errorcode": 0, "message": "Done", "severity": ;ltString_value>, "remote_backup_config":[{
"is_enabled":<Boolean_value>,
"retention_interval":<Integer_value>,
"id":<String_value>,
"backup_vm_ip_address":<String_value>}]}