Developer Documentation
NetScaler SDX 13.1 NITRO API Reference

ns_filediff

March 20, 2024
Contributed by: 
C

Configuration for monitoring file list diff present in nsconfig folder of ADC instances resource.

Properties

(click to see Operations )

Name Data Type Permissions Description
previous_filelist_details Read-write Comma separated list of files under nsconfig folder found in previous poll.
diff_summary Read-write diff summary.
display_name Read-write display name .
latest_filelist_details Read-write Comma separated list of files under nsconfig folder found in latest poll.
host_name Read-write host name.
id Read-write Id is system generated key.
diff_exists Read-write Diff exists. Possible values No Diff,NA,Diff Exists.
filediff_na_count Read-write Total file diff not applicable count .
file_name Read-write file name.
last_modified Read-write last modified timestamp of the file.
filediff_count Read-write Total file diff count .
diff_status Read-write diff status of the file. Possible values: added,modified,deleted.
total_count Read-write Total count available .
latest_polled_timestamp Read-only Latest polled timestamp.
previous_polled_timestamp Read-only Previous polled timestamp.
ip_address Read-only IP Address of ADC device.

Operations

(click to see Properties )

  • GET (ALL)

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

get (all)

URL: https://<MGMT-IP>/nitro/v2/config/ns_filediff Query-parameters:

filter https://<MGMT-IP>/nitro/v2/config/ns_filediff ?filter=property-name1:property-value1,property-name2:property-value2 Use this query-parameter to get the filtered set of ns_filediff resources configured on the system. You can set a filter on any property of the resource.

pagesize=#no;pageno=#no https://<MGMT-IP>/nitro/v2/config/ns_filediff ?pagesize=#no;pageno=#no Use this query-parameter to get the ns_filediff resources in chunks.

count https://<MGMT-IP>/nitro/v2/config/ns_filediff ?count=yes Use this query-parameter to get the count of ns_filediff resources.

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, "ns_filediff":[{
"latest_polled_timestamp":<Double_value>,
"previous_filelist_details":<String_value>,
"diff_summary":<String_value>,
"display_name":<String_value>,
"latest_filelist_details":<String_value>,
"previous_polled_timestamp":<Double_value>,
"host_name":<String_value>,
"id":<String_value>,
"ip_address":<String_value>,
"diff_exists":<String_value>,
"filediff_na_count":<Integer_value>,
"file_name":<String_value>,
"last_modified":<Double_value>,
"filediff_count":<Integer_value>,
"diff_status":<String_value>,
"total_count":<Integer_value>}]}

<!--NeedCopy-->
ns_filediff
March 20, 2024
Contributed by: 
C
March 20, 2024
Contributed by: 
C

In this article

Site feedback | Your privacy choices footer linkYour Privacy Choices | Privacy and legal terms | Cookie preferences | Consent settings | docs.cloud.com
© 1999- Cloud Software Group, Inc. All rights reserved.