Skip to content

remote_backup_config

Configuration for remote backup configuration resource.

Properties

(click to see Operations )

Name Data Type Permissions Description
is_enabled <Boolean> Read-write Is Remote backup enabled for this server.
retention_interval <Integer> Read-write No of days upto which the base backup will be retained.

Minimum value = 5

Maximum value =
db_health <String> Read-write Database health of the node.
sync_progress <String> Read-write Database synchronization status with the primary node.
id <String> Read-write Id is system generated key for all the system users.
backup_vm_ip_address <String> Read-write BACKUP VM IP Address.
memory_total <Double> Read-only Total memory in KB.
disk_total_capacity <Double> Read-only Disk Total Capacity in KB.
disk_usage <Double> Read-only Disk Usage (%).
disk_total <Double> Read-only Total available disk space in KB.
memory_usage <Double> Read-only Memory Usage (%).
disk_free <Double> Read-only Free disk available in KB.
memory_free <Double> Read-only Free memory available in KB.
cpu_usage <Double> Read-only CPU Usage (%).
disk_used <Double> Read-only Disk used in KB.
act_id <String> Read-only Activity Id.

Operations

(click to see Properties )

  • ADD
  • SYNC_SECONDARY
  • 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

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

add

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

HTTPS Method: POST

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:

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

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, "remote_backup_config":[{
      "is_enabled":<Boolean_value>,
      "memory_total":<Double_value>,
      "retention_interval":<Integer_value>,
      "disk_total_capacity":<Double_value>,
      "disk_usage":<Double_value>,
      "disk_total":<Double_value>,
      "memory_usage":<Double_value>,
      "db_health":<String_value>,
      "disk_free":<Double_value>,
      "sync_progress":<String_value>,
      "memory_free":<Double_value>,
      "cpu_usage":<Double_value>,
      "id":<String_value>,
      "backup_vm_ip_address":<String_value>,
      "disk_used":<Double_value>,
      "act_id":<String_value>}]}

sync_secondary

URL: https://<MGMT-IP>/nitro/v2/config/remote_backup_config?action=sync_secondary;onerror=<String_value>

HTTPS Method: POST

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:

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

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, "remote_backup_config":[{
      "is_enabled":<Boolean_value>,
      "memory_total":<Double_value>,
      "retention_interval":<Integer_value>,
      "disk_total_capacity":<Double_value>,
      "disk_usage":<Double_value>,
      "disk_total":<Double_value>,
      "memory_usage":<Double_value>,
      "db_health":<String_value>,
      "disk_free":<Double_value>,
      "sync_progress":<String_value>,
      "memory_free":<Double_value>,
      "cpu_usage":<Double_value>,
      "id":<String_value>,
      "backup_vm_ip_address":<String_value>,
      "disk_used":<Double_value>,
      "act_id":<String_value>}]}

get (all)

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

Query-parameters:

filter https://<MGMT-IP>/nitro/v2/config/remote_backup_config ?filter=property-name1:property-value1,property-name2:property-value2

Use this query-parameter to get the filtered set of remote_backup_config resources configured on the system. You can set a filter on any property of the resource.

pagesize=#no;pageno=#no https://<MGMT-IP>/nitro/v2/config/remote_backup_config ?pagesize=#no;pageno=#no

Use this query-parameter to get the remote_backup_config resources in chunks.

count https://<MGMT-IP>/nitro/v2/config/remote_backup_config ?count=yes

Use this query-parameter to get the count of remote_backup_config resources.

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, "remote_backup_config":[{
      "is_enabled":<Boolean_value>,
      "memory_total":<Double_value>,
      "retention_interval":<Integer_value>,
      "disk_total_capacity":<Double_value>,
      "disk_usage":<Double_value>,
      "disk_total":<Double_value>,
      "memory_usage":<Double_value>,
      "db_health":<String_value>,
      "disk_free":<Double_value>,
      "sync_progress":<String_value>,
      "memory_free":<Double_value>,
      "cpu_usage":<Double_value>,
      "id":<String_value>,
      "backup_vm_ip_address":<String_value>,
      "disk_used":<Double_value>,
      "act_id":<String_value>}]}

get

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

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, "remote_backup_config":[{
      "is_enabled":<Boolean_value>,
      "memory_total":<Double_value>,
      "retention_interval":<Integer_value>,
      "disk_total_capacity":<Double_value>,
      "disk_usage":<Double_value>,
      "disk_total":<Double_value>,
      "memory_usage":<Double_value>,
      "db_health":<String_value>,
      "disk_free":<Double_value>,
      "sync_progress":<String_value>,
      "memory_free":<Double_value>,
      "cpu_usage":<Double_value>,
      "id":<String_value>,
      "backup_vm_ip_address":<String_value>,
      "disk_used":<Double_value>,
      "act_id":<String_value>}]}
Was this article helpful?