Skip to content

systembackup

Configuration for Backup Data for ns backup and restore resource.

Properties

(click to see Operations )

Name Data Type Permissions Description
filename <String> Read-write Name of the backup file(*.tgz) to be restored.

Maximum length = 63
uselocaltimezone <Boolean> Read-write This option will create backup file with local timezone timestamp.
level <String> Read-write Level of data to be backed up.

Default value: basic

Possible values = basic, full
includekernel <String> Read-write Use this option to add kernel in the backup file.

Default value: NO

Possible values = NO, YES
comment <String> Read-write Comment specified at the time of creation of the backup file(*.tgz).
skipbackup <Boolean> Read-write Use this option to skip taking backup during restore operation.
size <Double> Read-only Size of the backup file(*.tgz) in KB.
creationtime <String> Read-only Creation time of the backup file(*.tgz).
version <String> Read-only Build version of the backup file(*.tgz).
createdby <String> Read-only Name of user who created the backup file(*.tgz).
ipaddress <String> Read-only Ip of Citrix ADC box where the backup file(*.tgz) was created.
__count <Double> Read-only count parameter

Operations

(click to see Properties )

  • CREATE
  • RESTORE
  • ADD
  • DELETE
  • GET (ALL)
  • GET
  • COUNT

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

create

URL: http:// <netscaler-ip-address> /nitro/v1/config/systembackup? action=create

HTTP Method: POST

Request Headers:

Cookie:NITRO_AUTH_TOKEN= <tokenvalue>

Content-Type:application/json

Request Payload:

{"systembackup":{
      "filename":<String_value>,
      "uselocaltimezone":<Boolean_value>,
      "level":<String_value>,
      "includekernel":<String_value>,
      "comment":<String_value>
}}

Response:

HTTP Status Code on Success: 200 OK

HTTP Status Code on Failure: 4xx <string> (for general HTTP errors) or 5xx <string> (for NetScaler-specific errors). The response payload provides details of the error

restore

URL: http:// <netscaler-ip-address> /nitro/v1/config/systembackup? action=restore

HTTP Method: POST

Request Headers:

Cookie:NITRO_AUTH_TOKEN= <tokenvalue>

Content-Type:application/json

Request Payload:

{"systembackup":{
<b>      "filename":<String_value>,
</b>      "skipbackup":<Boolean_value>
}}

Response:

HTTP Status Code on Success: 200 OK

HTTP Status Code on Failure: 4xx <string> (for general HTTP errors) or 5xx <string> (for NetScaler-specific errors). The response payload provides details of the error

add

URL: http:// <netscaler-ip-address> /nitro/v1/config/systembackup

HTTP Method: POST

Request Headers:

Cookie:NITRO_AUTH_TOKEN= <tokenvalue>

Content-Type:application/json

Request Payload:

{"systembackup":{
<b>      "filename":<String_value>
</b>}}

Response:

HTTP Status Code on Success: 201 Created

HTTP Status Code on Failure: 4xx <string> (for general HTTP errors) or 5xx <string> (for NetScaler-specific errors). The response payload provides details of the error

delete

URL: http:// <netscaler-ip-address> /nitro/v1/config/systembackup/ filename_value<String>

HTTP Method: DELETE

Request Headers:

Cookie:NITRO_AUTH_TOKEN= <tokenvalue>

Response:

HTTP Status Code on Success: 200 OK

HTTP Status Code on Failure: 4xx <string> (for general HTTP errors) or 5xx <string> (for NetScaler-specific errors). The response payload provides details of the error

get (all)

URL: http:// <netscaler-ip-address> /nitro/v1/config/systembackup

Query-parameters:

attrs

http:// <netscaler-ip-address> /nitro/v1/config/systembackup? attrs=property-name1,property-name2

Use this query parameter to specify the resource details that you want to retrieve.

filter

http:// <netscaler-ip-address> /nitro/v1/config/systembackup? filter=property-name1:property-val1,property-name2:property-val2

Use this query-parameter to get the filtered set of systembackup resources configured on NetScaler.Filtering can be done on any of the properties of the resource.

view

http:// <netscaler-ip-address> /nitro/v1/config/systembackup? view=summary

Use this query-parameter to get the summary output of systembackup resources configured on NetScaler.

Note: By default, the retrieved results are displayed in detail view (?view=detail).

pagination

http:// <netscaler-ip-address> /nitro/v1/config/systembackup? pagesize=#no;pageno=#no

Use this query-parameter to get the systembackup resources in chunks.

HTTP Method: GET

Request Headers:

Cookie:NITRO_AUTH_TOKEN= <tokenvalue>

Accept:application/json

Response:

HTTP Status Code on Success: 200 OK

HTTP Status Code on Failure: 4xx <string> (for general HTTP errors) or 5xx <string> (for NetScaler-specific errors). The response payload provides details of the error

Response Header:

Content-Type:application/json

Response Payload:

{ "systembackup": [ {
      "filename":<String_value>,
      "level":<String_value>,
      "includekernel":<String_value>,
      "comment":<String_value>,
      "size":<Double_value>,
      "uselocaltimezone":<Boolean_value>,
      "creationtime":<String_value>,
      "version":<String_value>,
      "createdby":<String_value>,
      "ipaddress":<String_value>
}]}

get

URL: http:// <netscaler-ip-address> /nitro/v1/config/systembackup/ filename_value<String>

Query-parameters:

attrs

http:// <netscaler-ip-address> /nitro/v1/config/systembackup/ filename_value<String> ? attrs=property-name1,property-name2

Use this query parameter to specify the resource details that you want to retrieve.

view

http:// <netscaler-ip-address> /nitro/v1/config/systembackup/ filename_value<String> ? view=summary

Use this query-parameter to get the summary output of systembackup resources configured on NetScaler.

Note: By default, the retrieved results are displayed in detail view (?view=detail).

HTTP Method: GET

Request Headers:

Cookie:NITRO_AUTH_TOKEN= <tokenvalue>

Accept:application/json

Response:

HTTP Status Code on Success: 200 OK

HTTP Status Code on Failure: 4xx <string> (for general HTTP errors) or 5xx <string> (for NetScaler-specific errors). The response payload provides details of the error

Response Header:

Content-Type:application/json

Response Payload:

{  "systembackup": [ {
      "filename":<String_value>,
      "level":<String_value>,
      "includekernel":<String_value>,
      "comment":<String_value>,
      "size":<Double_value>,
      "uselocaltimezone":<Boolean_value>,
      "creationtime":<String_value>,
      "version":<String_value>,
      "createdby":<String_value>,
      "ipaddress":<String_value>
}]}

count

URL: http:// <netscaler-ip-address> /nitro/v1/config/systembackup? count=yes

HTTP Method: GET

Request Headers:

Cookie:NITRO_AUTH_TOKEN= <tokenvalue>

Accept:application/json

Response:

HTTP Status Code on Success: 200 OK

HTTP Status Code on Failure: 4xx <string> (for general HTTP errors) or 5xx <string> (for NetScaler-specific errors). The response payload provides details of the error

Response Header:

Content-Type:application/json

Response Payload:

{ "systembackup": [ { "__count": "#no"} ] }