restore
Configuration for Restore resource.
(click to see Operations)
Properties
(click to see Operations)
| Name | Data Type | Permissions | Description |
|---|---|---|---|
| is_valid_license | <Boolean> | Read-write | To indicate if available license is valid and (NS+throughput) sufficient for restore.. |
| backup_components | <backup_component[]> | Read-write | Backup Components. |
| required_throughput | <Double> | Read-write | Throughput required by the backedup instances to get restored.. |
| max_allowed_ns | <Integer> | Read-write | Number of NS instances current license allows to be restored.. |
| restore_type | <Integer> | Read-write | . |
| backup_password | <String> | Read-write | Password of encrypted backup file. |
| required_ns | <Integer> | Read-write | Total number of instances present in backup file.. |
| ip_address_list | <String[]> | Read-write | List of VM IP Address. Minimum length = 1 Maximum length = 1024 |
| sbi_file | <String> | Read-write | SDX Image selected by User for Restore. |
| backup_file_name | <String> | Read-write | Backup file name. Maximum length = 64 |
| max_allowed_throughput | <Double> | Read-write | Maximum throughput current license allows.. |
| act_id | <String> | Read-only | Activity Id. |
Operations
(click to see Properties)
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/restore?onerror=<String_value>
HTTP Method: null
Request Payload:
{restore: {
"backup_components":[{
"component_message":<String_value>,
"component_hostname":<String_value>,
"component_version_bit":<String_value>,
"component_error_severity":<Integer_value>,
"component_versions":<String_value>,
"component_minimum_version":<String_value>,
"component_name":<String_value>,
"component":<String_value>,
"backup_file_name":<String_value>,
"component_ip":<String_value>}],
"backup_file_name":<String_value>,
"max_allowed_throughput":<Double_value>,
"is_valid_license":<Boolean_value>,
"restore_type":<Integer_value>,
"max_allowed_ns":<Integer_value>,
"backup_password":<String_value>,
"ip_address_list":<String_value[]>,
"required_ns":<Integer_value>,
"sbi_file":<String_value>,
"required_throughput":<Double_value>}}
Response Payload:
{ "errorcode": 0, "message": "Done", "severity": ;ltString_value>, "restore":[{
"is_valid_license":<Boolean_value>,
"backup_components":[{
"component_message":<String_value>,
"component_versions":<String_value>,
"component_minimum_version":<String_value>,
"backup_file_name":<String_value>,
"component":<String_value>,
"component_name":<String_value>,
"component_ip":<String_value>,
"component_version_bit":<String_value>,
"component_hostname":<String_value>,
"component_error_severity":<Integer_value>}],
"required_throughput":<Double_value>,
"max_allowed_ns":<Integer_value>,
"restore_type":<Integer_value>,
"backup_password":<String_value>,
"required_ns":<Integer_value>,
"ip_address_list":<String_value>,
"sbi_file":<String_value>,
"backup_file_name":<String_value>,
"act_id":<String_value>,
"max_allowed_throughput":<Double_value>}]}
get (all)
URL: https://<MGMT-IP>/nitro/v1/config/restore
HTTP Method: null
Response Payload:
{ "errorcode": 0, "message": "Done", "severity": ;ltString_value>, "restore":[{
"is_valid_license":<Boolean_value>,
"backup_components":[{
"component_message":<String_value>,
"component_versions":<String_value>,
"component_minimum_version":<String_value>,
"backup_file_name":<String_value>,
"component":<String_value>,
"component_name":<String_value>,
"component_ip":<String_value>,
"component_version_bit":<String_value>,
"component_hostname":<String_value>,
"component_error_severity":<Integer_value>}],
"required_throughput":<Double_value>,
"max_allowed_ns":<Integer_value>,
"restore_type":<Integer_value>,
"backup_password":<String_value>,
"required_ns":<Integer_value>,
"ip_address_list":<String_value>,
"sbi_file":<String_value>,
"backup_file_name":<String_value>,
"act_id":<String_value>,
"max_allowed_throughput":<Double_value>}]}