Skip to content

sdx_backup_restore

Configuration for Backup resource.

(click to see Operations)

Properties

(click to see Operations)

NameData TypePermissionsDescription
ip_address_list<String[]>Read-writeList of VM IP Address.
Minimum length = 1
Maximum length = 1024
reset_type<Integer>Read-writeReset Type [0: Reset (Without Network Configuration), 1: Reset (With Network Configuration), 2: Appliance Reset, 3: Appliance Restore, 4: Instance Restore, 5: Backup ].
file_name<String>Read-writeFile Name.
Minimum length = 1
Maximum length = 256
name<String>Read-onlyName of VM device.
act_id<String>Read-onlyActivity Id.
ip_address<String>Read-onlyIP Address for this VM device.
type<String>Read-onlyType of device, (br | ns).

Operations

(click to see Properties)

FACTORYRESET| GET| RESTORE| BACKUP

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

factoryreset

URL: https://<MGMT-IP>/nitro/v1/config/sdx_backup_restore?action=factoryreset;onerror=<String_value>

HTTP Method: null

Request Payload:

{sdx_backup_restore: {
"file_name":<String_value>,
"reset_type":<Integer_value>,
"ip_address_list":<String_value[]>}}

Response Payload:

{ "errorcode": 0, "message": "Done", "severity": ;ltString_value>, "sdx_backup_restore":[{
"restore_type":<Integer_value>,
"ip_address_list":<String_value>,
"name":<String_value>,
"reset_type":<Integer_value>,
"sync_operation":<Boolean_value>,
"file_name":<String_value>,
"act_id":<String_value>,
"ip_address":<String_value>,
"type":<String_value>}]}

get

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

HTTP Method: null

Response Payload:

{ "errorcode": 0, "message": "Done", "severity": ;ltString_value>, "sdx_backup_restore":[{
"restore_type":<Integer_value>,
"ip_address_list":<String_value>,
"name":<String_value>,
"reset_type":<Integer_value>,
"sync_operation":<Boolean_value>,
"file_name":<String_value>,
"act_id":<String_value>,
"ip_address":<String_value>,
"type":<String_value>}]}

restore

URL: https://<MGMT-IP>/nitro/v1/config/sdx_backup_restore?action=restore;onerror=<String_value>

HTTP Method: null

Request Payload:

{sdx_backup_restore: {
"file_name":<String_value>,
"reset_type":<Integer_value>,
"ip_address_list":<String_value[]>}}

Response Payload:

{ "errorcode": 0, "message": "Done", "severity": ;ltString_value>, "sdx_backup_restore":[{
"restore_type":<Integer_value>,
"ip_address_list":<String_value>,
"name":<String_value>,
"reset_type":<Integer_value>,
"sync_operation":<Boolean_value>,
"file_name":<String_value>,
"act_id":<String_value>,
"ip_address":<String_value>,
"type":<String_value>}]}

backup

URL: https://<MGMT-IP>/nitro/v1/config/sdx_backup_restore?action=backup;onerror=<String_value>

HTTP Method: null

Request Payload:

{sdx_backup_restore: {
"file_name":<String_value>,
"reset_type":<Integer_value>,
"ip_address_list":<String_value[]>}}

Response Payload:

{ "errorcode": 0, "message": "Done", "severity": ;ltString_value>, "sdx_backup_restore":[{
"restore_type":<Integer_value>,
"ip_address_list":<String_value>,
"name":<String_value>,
"reset_type":<Integer_value>,
"sync_operation":<Boolean_value>,
"file_name":<String_value>,
"act_id":<String_value>,
"ip_address":<String_value>,
"type":<String_value>}]}