Skip to content

ns_config_diff

Configuration for NetScaler Configuration Diff resource.

(click to see Operations)

Properties

(click to see Operations)

NameData TypePermissionsDescription
diff_data<String>Read-writeDiff data in XML format..
diff_file<String>Read-writeName of the file containing diff between source and target file generated by a schedule diff operation..
source_file<String>Read-writeNS configuration source file.
ns_ip_address<String>Read-writeNS IP Address.
Minimum length = 1
Maximum length = 64
target_file<String>Read-writeNS configuration target file.
params_targetvalue<String>Read-onlyParams target value seen in the diff output.
params_value<String>Read-onlyParams value seen in the diff output.
diff_response<String>Read-onlyDiff between source and target file.
source_command<String>Read-onlyDiff command ouput present in source.
corrective_command<String>Read-onlyCorrective command.
target_command<String>Read-onlyDiff command ouput present in target.
params_name<String>Read-onlyParams 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>.

diff_table_report

URL: https://<MGMT-IP>/nitro/v1/config/ns_config_diff?action=diff_table_report;onerror=<String_value>

HTTP Method: null

Request Payload:

{ns_config_diff: {
"ns_ip_address":<String_value>,
"diff_data":<String_value>,
"diff_file":<String_value>,
"source_file":<String_value>,
"target_file":<String_value>}}

Response Payload:

{ "errorcode": 0, "message": "Done", "severity": ;ltString_value>, "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>,
"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/v1/config/ns_config_diff?action=diff_table;onerror=<String_value>

HTTP Method: null

Request Payload:

{ns_config_diff: {
"ns_ip_address":<String_value>,
"diff_data":<String_value>,
"diff_file":<String_value>,
"source_file":<String_value>,
"target_file":<String_value>}}

Response Payload:

{ "errorcode": 0, "message": "Done", "severity": ;ltString_value>, "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>,
"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/v1/config/ns_config_diff?action=do_diff;onerror=<String_value>

HTTP Method: null

Request Payload:

{ns_config_diff: {
"ns_ip_address":<String_value>,
"diff_data":<String_value>,
"diff_file":<String_value>,
"source_file":<String_value>,
"target_file":<String_value>}}

Response Payload:

{ "errorcode": 0, "message": "Done", "severity": ;ltString_value>, "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>,
"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/v1/config/ns_config_diff?action=gen_batch;onerror=<String_value>

HTTP Method: null

Request Payload:

{ns_config_diff: {
"ns_ip_address":<String_value>,
"diff_data":<String_value>,
"diff_file":<String_value>,
"source_file":<String_value>,
"target_file":<String_value>}}

Response Payload:

{ "errorcode": 0, "message": "Done", "severity": ;ltString_value>, "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>,
"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>}]}