device_backup
Configuration for Device Backup resource.
(click to see Operations)
Properties
(click to see Operations)
| Name | Data Type | Permissions | Description |
|---|---|---|---|
| external_storage_info | <backup_external_storage> | Read-write | Information of the External storage for backup file. |
| device_family | <String> | Read-write | Device family.. |
| image_filesize | <Integer> | Read-write | Image File Size. |
| last_updated_time | <Integer> | Read-write | Last Updated Time. |
| backup_filesize | <Integer> | 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. |
| tenant_id | <String> | Read-only | Tenant ID. |
| device_name | <String> | Read-only | Device Hostname. |
| image_filename | <String> | Read-only | Name of the image file backed up. |
| backup_filename | <String> | Read-only | Name of the backed up file. |
| act_id | <String> | Read-only | Activity Id. |
Operations
(click to see Properties)
DEVICEBACKUP| DELETE| GET (ALL)| DEVICERESTORE| UPLOAD| 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>.
devicebackup
URL: https://<MGMT-IP>/nitro/v1/config/device_backup?action=devicebackup;onerror=<String_value>
HTTP Method: null
Request Payload:
{device_backup: {
"external_storage_info":<backup_external_storage_value>,
"last_updated_time":<Integer_value>,
"id":<String_value>,
"device_family":<String_value>,
"backup_filesize":<Integer_value>,
"backup_password":<String_value>,
"image_filesize":<Integer_value>,
"use_global_password":<Boolean_value>,
"ip_address":<String_value>,
"encrypted":<Boolean_value>}}
Response Payload:
{ "errorcode": 0, "message": "Done", "severity": ;ltString_value>, "device_backup":[{
"external_storage_info":<backup_external_storage_value>,
"device_family":<String_value>,
"image_filesize":<Integer_value>,
"last_updated_time":<Integer_value>,
"backup_filesize":<Integer_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/v1/config/device_backup/id_value<String>
HTTP Method: null
Response Payload:
{ "errorcode": 0, "message": "Done", "severity": ;ltString_value> }
get (all)
URL: https://<MGMT-IP>/nitro/v1/config/device_backup
HTTP Method: null
Response Payload:
{ "errorcode": 0, "message": "Done", "severity": ;ltString_value>, "device_backup":[{
"external_storage_info":<backup_external_storage_value>,
"device_family":<String_value>,
"image_filesize":<Integer_value>,
"last_updated_time":<Integer_value>,
"backup_filesize":<Integer_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/v1/config/device_backup?action=devicerestore;onerror=<String_value>
HTTP Method: null
Request Payload:
{device_backup: {
"external_storage_info":<backup_external_storage_value>,
"last_updated_time":<Integer_value>,
"id":<String_value>,
"device_family":<String_value>,
"backup_filesize":<Integer_value>,
"backup_password":<String_value>,
"image_filesize":<Integer_value>,
"use_global_password":<Boolean_value>,
"ip_address":<String_value>,
"encrypted":<Boolean_value>}}
Response Payload:
{ "errorcode": 0, "message": "Done", "severity": ;ltString_value>, "device_backup":[{
"external_storage_info":<backup_external_storage_value>,
"device_family":<String_value>,
"image_filesize":<Integer_value>,
"last_updated_time":<Integer_value>,
"backup_filesize":<Integer_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/v1/upload/device_backup
HTTP Method: null
Response Payload:
{ "errorcode": 0, "message": "Done }
download
URL: https://<MGMT-IP>/nitro/v1/download/device_backup/id_value<String>
HTTP Method: null