-
-
-
-
sdx_backup_restore
-
This content has been machine translated dynamically.
Dieser Inhalt ist eine maschinelle Übersetzung, die dynamisch erstellt wurde. (Haftungsausschluss)
Cet article a été traduit automatiquement de manière dynamique. (Clause de non responsabilité)
Este artículo lo ha traducido una máquina de forma dinámica. (Aviso legal)
此内容已经过机器动态翻译。 放弃
このコンテンツは動的に機械翻訳されています。免責事項
이 콘텐츠는 동적으로 기계 번역되었습니다. 책임 부인
Este texto foi traduzido automaticamente. (Aviso legal)
Questo contenuto è stato tradotto dinamicamente con traduzione automatica.(Esclusione di responsabilità))
This article has been machine translated.
Dieser Artikel wurde maschinell übersetzt. (Haftungsausschluss)
Ce article a été traduit automatiquement. (Clause de non responsabilité)
Este artículo ha sido traducido automáticamente. (Aviso legal)
この記事は機械翻訳されています.免責事項
이 기사는 기계 번역되었습니다.책임 부인
Este artigo foi traduzido automaticamente.(Aviso legal)
这篇文章已经过机器翻译.放弃
Questo articolo è stato tradotto automaticamente.(Esclusione di responsabilità))
Translation failed!
sdx_backup_restore
Configuration for Backup resource.
Properties
(click to see Operations )
| Name | Data Type | Permissions | Description |
|---|---|---|---|
| ip_address_list | <String[]> | Read-write | List of VM IP Address.
Minimum length = 1 Maximum length = 1024 |
| reset_type |
|
Read-write | Reset Type [0: Reset (Without Network Configuration), 1: Reset (With Network Configuration), 2: Appliance Reset, 3: Appliance Restore, 4: Instance Restore, 5: Backup ]. |
| file_name |
|
Read-write | File Name.
Minimum length = 1 Maximum length = 256 |
| name |
|
Read-only | Name of VM device. |
| act_id |
|
Read-only | Activity Id. |
| ip_address |
|
Read-only | IP Address for this VM device. |
| type |
|
Read-only | Type 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
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
factoryreset
URL: https://<MGMT-IP>/nitro/v2/config/sdx_backup_restore?action=factoryreset;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:
{"sdx_backup_restore": {
"file_name":<String_value>,
"reset_type":<Integer_value>,
"ip_address_list":<String_value[]>}}
<!--NeedCopy-->
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, "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>}]}
<!--NeedCopy-->
get
URL: https://<MGMT-IP>/nitro/v2/config/sdx_backup_restore 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, "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>}]}
<!--NeedCopy-->
restore
URL: https://<MGMT-IP>/nitro/v2/config/sdx_backup_restore?action=restore;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:
{"sdx_backup_restore": {
"file_name":<String_value>,
"reset_type":<Integer_value>,
"ip_address_list":<String_value[]>}}
<!--NeedCopy-->
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, "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>}]}
<!--NeedCopy-->
backup
URL: https://<MGMT-IP>/nitro/v2/config/sdx_backup_restore?action=backup;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:
{"sdx_backup_restore": {
"file_name":<String_value>,
"reset_type":<Integer_value>,
"ip_address_list":<String_value[]>}}
<!--NeedCopy-->
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, "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>}]}
<!--NeedCopy-->
Share
Share
In this article
This Preview product documentation is Citrix Confidential.
You agree to hold this documentation confidential pursuant to the terms of your Citrix Beta/Tech Preview Agreement.
The development, release and timing of any features or functionality described in the Preview documentation remains at our sole discretion and are subject to change without notice or consultation.
The documentation is for informational purposes only and is not a commitment, promise or legal obligation to deliver any material, code or functionality and should not be relied upon in making Citrix product purchase decisions.
If you do not agree, select I DO NOT AGREE to exit.