ns_conf

Configuration for Configuration diff resource for NetScaler resource.

Read/write properties

ns_ip_address<String>

List of NetScaler IP Address.
Minimum length = 1
Maximum length = 64

id<String>

Id is system generated key for all ns.conf files.

Read only properties

templatediff_reportname<String>

Name of the Template diff reports.

diff_status<String>

Tells whether a diff exists between running and saved configuration on NS.

display_name<String>

Display Name of the device.

templatediff_status<String>

Tells whether a diff exists between templates associated to NetScaler and the running configuration.

diff_reportname<String>

Name of the SavedVsRunning diff reportname.

hostname<String>

Host Name of the device.

last_updated_time<Integer>

Last Updated Time.

Operations

NOTE: In request payload, Mandatory parameters are marked red and bold.

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)download_conf inventory

get (all)

URL:https://<MGMT-IP>/nitro/v2/config/ns_conf

Query-parameters:

filter

https://<MGMT-IP>/nitro/v2/config/ns_conf?filter=property-name1:property-value1,property-name2:property-value2

Use this query-parameter to get the filtered set of ns_conf 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_conf?pagesize=#no&pageno=#no

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

count

https://<MGMT-IP>/nitro/v2/config/ns_conf?count=yes

Use this query-parameter to get the count of ns_conf resources.

HTTPS Method:GET

Request Headers:

Accept:application/json

X-NITRO-USER:username_value<String>

X-NITRO-PASS:password_value<String>

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:JSON

{ "errorcode": 0, "message": "Done", "severity": <String_value>, "ns_conf":[{
      "templatediff_reportname":<String_value>,
      "ns_ip_address":<String_value>,
      "diff_status":<String_value>,
      "display_name":<String_value>,
      "id":<String_value>,
      "templatediff_status":<String_value>,
      "diff_reportname":<String_value>,
      "hostname":<String_value>,
      "last_updated_time":<Integer_value>,
      "last_updated_times":<String_value>}]}

download_conf

URL:https://<MGMT-IP>/nitro/v2/config/ns_conf?action=download_conf&onerror=<String_value>

HTTPS Method:POST

Request Headers:

Content-Type:application/json

X-NITRO-USER:username_value<String>

X-NITRO-PASS:password_value<String>

Cookie:NITRO_AUTH_TOKEN=token_value<String>

Request Payload:JSON

{"ns_conf": {
"id":<String_value>,
"ns_ip_address":<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:JSON

inventory

URL:https://<MGMT-IP>/nitro/v2/config/ns_conf?action=inventory&onerror=<String_value>

HTTPS Method:POST

Request Headers:

Content-Type:application/json

X-NITRO-USER:username_value<String>

X-NITRO-PASS:password_value<String>

Cookie:NITRO_AUTH_TOKEN=token_value<String>

Request Payload:JSON

{"ns_conf": {
"ns_ip_address":<String_value>,
"id":<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:JSON