Skip to content

ns_config_diff

Configuration for Citrix ADC Configuration Diff resource.

Properties

(click to see Operations )

Name Data Type Permissions Description
diff_file <String> Read-write Name of the file containing diff between source and target file generated by a schedule diff operation..
source_file <String> Read-write Citrix ADC configuration source file.
ignoresysuserpassword <Boolean> Read-write When set to true, ignores password difference in diff command output.
ns_ip_address <String> Read-write Citrix ADC IP Address.

Minimum length = 1

Maximum length = 64
target_file <String> Read-write Citrix ADC configuration target file.
corrective_command <String> Read-write Corrective command.
diff_data <String> Read-only Diff data in XML format..
params_targetvalue <String> Read-only Params target value seen in the diff output.
params_value <String> Read-only Params value seen in the diff output.
diff_response <String> Read-only Diff between source and target file.
source_command <String> Read-only Diff command ouput present in source.
target_command <String> Read-only Diff command ouput present in target.
params_name <String> Read-only Params name seen in the diff output.

Operations

(click to see Properties )

  • DIFF_TABLE_REPORT
  • DIFF_TABLE
  • DO_DIFF
  • GEN_BATCH

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

diff_table_report

URL: https://<MGMT-IP>/nitro/v2/config/ns_config_diff?action=diff_table_report;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:

{"ns_config_diff": {
      "ns_ip_address":<String_value>,
      "corrective_command":<String_value>,
      "diff_file":<String_value>,
      "source_file":<String_value>,
      "ignoresysuserpassword":<Boolean_value>,
      "target_file":<String_value>}}

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, "ns_config_diff":[{
      "diff_data":<String_value>,
      "params_targetvalue":<String_value>,
      "diff_file":<String_value>,
      "source_file":<String_value>,
      "params_value":<String_value>,
      "diff_response":<String_value>,
      "ignoresysuserpassword":<Boolean_value>,
      "source_command":<String_value>,
      "ns_ip_address":<String_value>,
      "target_file":<String_value>,
      "corrective_command":<String_value>,
      "target_command":<String_value>,
      "params_name":<String_value>}]}

diff_table

URL: https://<MGMT-IP>/nitro/v2/config/ns_config_diff?action=diff_table;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:

{"ns_config_diff": {
      "ns_ip_address":<String_value>,
      "corrective_command":<String_value>,
      "diff_file":<String_value>,
      "source_file":<String_value>,
      "ignoresysuserpassword":<Boolean_value>,
      "target_file":<String_value>}}

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, "ns_config_diff":[{
      "diff_data":<String_value>,
      "params_targetvalue":<String_value>,
      "diff_file":<String_value>,
      "source_file":<String_value>,
      "params_value":<String_value>,
      "diff_response":<String_value>,
      "ignoresysuserpassword":<Boolean_value>,
      "source_command":<String_value>,
      "ns_ip_address":<String_value>,
      "target_file":<String_value>,
      "corrective_command":<String_value>,
      "target_command":<String_value>,
      "params_name":<String_value>}]}

do_diff

URL: https://<MGMT-IP>/nitro/v2/config/ns_config_diff?action=do_diff;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:

{"ns_config_diff": {
      "ns_ip_address":<String_value>,
      "corrective_command":<String_value>,
      "diff_file":<String_value>,
      "source_file":<String_value>,
      "ignoresysuserpassword":<Boolean_value>,
      "target_file":<String_value>}}

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, "ns_config_diff":[{
      "diff_data":<String_value>,
      "params_targetvalue":<String_value>,
      "diff_file":<String_value>,
      "source_file":<String_value>,
      "params_value":<String_value>,
      "diff_response":<String_value>,
      "ignoresysuserpassword":<Boolean_value>,
      "source_command":<String_value>,
      "ns_ip_address":<String_value>,
      "target_file":<String_value>,
      "corrective_command":<String_value>,
      "target_command":<String_value>,
      "params_name":<String_value>}]}

gen_batch

URL: https://<MGMT-IP>/nitro/v2/config/ns_config_diff?action=gen_batch;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:

{"ns_config_diff": {
      "ns_ip_address":<String_value>,
      "corrective_command":<String_value>,
      "diff_file":<String_value>,
      "source_file":<String_value>,
      "ignoresysuserpassword":<Boolean_value>,
      "target_file":<String_value>}}

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, "ns_config_diff":[{
      "diff_data":<String_value>,
      "params_targetvalue":<String_value>,
      "diff_file":<String_value>,
      "source_file":<String_value>,
      "params_value":<String_value>,
      "diff_response":<String_value>,
      "ignoresysuserpassword":<Boolean_value>,
      "source_command":<String_value>,
      "ns_ip_address":<String_value>,
      "target_file":<String_value>,
      "corrective_command":<String_value>,
      "target_command":<String_value>,
      "params_name":<String_value>}]}
Was this article helpful?