backup_external_storage
Configuration for Backup File External storage resource.
(click to see Operations)
Properties
(click to see Operations)
| Name | Data Type | Permissions | Description |
|---|---|---|---|
| parent_name | <String> | Read-write | . |
| delete_from_svm | <Boolean> | Read-write | Password for backup file encryption. |
| port | <Integer> | Read-write | External transfer server port. Maximum value = |
| parent_id | <String> | Read-write | . |
| username | <String> | Read-write | Uername. |
| transfer_protocol | <String> | Read-write | File transfer Protocol: SCP, SFTP or FTP. |
| password | <String> | Read-write | Password. |
| directory_path | <String> | Read-write | External server directory path where backup file will be uploaded. |
| server | <String> | Read-write | External server IP Address/Hostname. |
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>.
get (all)
URL: https://<MGMT-IP>/nitro/v1/config/backup_external_storage
HTTP Method: null
Response Payload:
{ "errorcode": 0, "message": "Done", "severity": ;ltString_value>, "backup_external_storage":[{
"parent_name":<String_value>,
"delete_from_svm":<Boolean_value>,
"port":<Integer_value>,
"parent_id":<String_value>,
"username":<String_value>,
"transfer_protocol":<String_value>,
"password":<String_value>,
"directory_path":<String_value>,
"server":<String_value>}]}
get
URL: https://<MGMT-IP>/nitro/v1/config/backup_external_storage/server_value<String>
HTTP Method: null
Response Payload:
{ "errorcode": 0, "message": "Done", "severity": ;ltString_value>, "backup_external_storage":[{
"parent_name":<String_value>,
"delete_from_svm":<Boolean_value>,
"port":<Integer_value>,
"parent_id":<String_value>,
"username":<String_value>,
"transfer_protocol":<String_value>,
"password":<String_value>,
"directory_path":<String_value>,
"server":<String_value>}]}
update
URL: https://<MGMT-IP>/nitro/v1/config/backup_external_storage/server_value<String>
HTTP Method: null
Request Payload:
{backup_external_storage:{
"parent_id":<String_value>,
"password":<String_value>,
"server":<String_value>,
"parent_name":<String_value>,
"port":<Integer_value>,
"username":<String_value>,
"delete_from_svm":<Boolean_value>,
"transfer_protocol":<String_value>,
"directory_path":<String_value>}}
Response Payload:
{ "errorcode": 0, "message": "Done", "severity": ;ltString_value>, "backup_external_storage":[{
"parent_name":<String_value>,
"delete_from_svm":<Boolean_value>,
"port":<Integer_value>,
"parent_id":<String_value>,
"username":<String_value>,
"transfer_protocol":<String_value>,
"password":<String_value>,
"directory_path":<String_value>,
"server":<String_value>}]}