Skip to content

device_backup

Configuration for Device Backup resource.

Properties

(click to see Operations )

Name Data Type Permissions Description
wallet_key_encrypted <Boolean> Read-write True if wallet key encrypted for service deployment.
last_updated_time <Double> Read-write Last Updated Time.
backup_filesize <Double> Read-write Backup file size.
id <String> Read-write Id is system generated key for all backed up files.
ip_address <String> Read-write Device IP Address.

Minimum length = 1

Maximum length = 64
encrypted <Boolean> Read-write Indicates if the backup files are encrypted.
backup_password <String> Read-write Backup Password.
use_global_password <Boolean> Read-write Global Password.
device_name <String> Read-only Device Hostname.
backup_filename <String> Read-only Name of the backed up file.

Operations

(click to see Properties )

  • DEVICEBACKUP
  • UPLOAD
  • DELETE
  • GET (ALL)
  • DEVICERESTORE
  • DOWNLOAD

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

devicebackup

URL: https://<MGMT-IP>/nitro/v2/config/device_backup?action=devicebackup;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:

{"device_backup": {
      "wallet_key_encrypted":<Boolean_value>,
      "backup_filesize":<Double_value>,
      "use_global_password":<Boolean_value>,
      "encrypted":<Boolean_value>,
      "last_updated_time":<Double_value>,
      "id":<String_value>,
      "backup_password":<String_value>,
      "ip_address":<String_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, "device_backup":[{
      "external_storage_info":<backup_external_storage_value>,
      "device_family":<String_value>,
      "wallet_key_encrypted":<Boolean_value>,
      "image_filesize":<Double_value>,
      "last_updated_time":<Double_value>,
      "backup_filesize":<Double_value>,
      "tenant_id":<String_value>,
      "device_name":<String_value>,
      "image_filename":<String_value>,
      "backup_filename":<String_value>,
      "id":<String_value>,
      "ip_address":<String_value>,
      "encrypted":<Boolean_value>,
      "act_id":<String_value>,
      "backup_password":<String_value>,
      "use_global_password":<Boolean_value>}]}

delete

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

HTTPS Method: DELETE

Request Headers:

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 Payload:

{ "errorcode": 0, "message": "Done", "severity": ;ltString_value;gt }

get (all)

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

Query-parameters:

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

Use this query-parameter to get the filtered set of device_backup 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/device_backup ?pagesize=#no;pageno=#no

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

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

Use this query-parameter to get the count of device_backup 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, "device_backup":[{
      "external_storage_info":<backup_external_storage_value>,
      "device_family":<String_value>,
      "wallet_key_encrypted":<Boolean_value>,
      "image_filesize":<Double_value>,
      "last_updated_time":<Double_value>,
      "backup_filesize":<Double_value>,
      "tenant_id":<String_value>,
      "device_name":<String_value>,
      "image_filename":<String_value>,
      "backup_filename":<String_value>,
      "id":<String_value>,
      "ip_address":<String_value>,
      "encrypted":<Boolean_value>,
      "act_id":<String_value>,
      "backup_password":<String_value>,
      "use_global_password":<Boolean_value>}]}

devicerestore

URL: https://<MGMT-IP>/nitro/v2/config/device_backup?action=devicerestore;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:

{"device_backup": {
      "wallet_key_encrypted":<Boolean_value>,
      "backup_filesize":<Double_value>,
      "use_global_password":<Boolean_value>,
      "encrypted":<Boolean_value>,
      "last_updated_time":<Double_value>,
      "id":<String_value>,
      "backup_password":<String_value>,
      "ip_address":<String_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, "device_backup":[{
      "external_storage_info":<backup_external_storage_value>,
      "device_family":<String_value>,
      "wallet_key_encrypted":<Boolean_value>,
      "image_filesize":<Double_value>,
      "last_updated_time":<Double_value>,
      "backup_filesize":<Double_value>,
      "tenant_id":<String_value>,
      "device_name":<String_value>,
      "image_filename":<String_value>,
      "backup_filename":<String_value>,
      "id":<String_value>,
      "ip_address":<String_value>,
      "encrypted":<Boolean_value>,
      "act_id":<String_value>,
      "backup_password":<String_value>,
      "use_global_password":<Boolean_value>}]}

upload

URL: https://<MGMT-IP>/nitro/v2/upload/device_backup

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:

Multi-part form data with File Stream

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 }
Was this article helpful?