Skip to content

ns_conf

Configuration for ns.conf file on NetScaler resource.

(click to see Operations)

Properties

(click to see Operations)

NameData TypePermissionsDescription
diff_status<String>Read-writeTells whether a diff exists between running and saved configuration on NS.
ns_ip_address<String>Read-writeList of NetScaler IP Address.
Minimum length = 1
Maximum length = 64
last_updated_time<Integer>Read-writeLast Updated Time.
id<String>Read-writeId is system generated key for all ns.conf files.
templatediff_status<String>Read-writeTells whether a diff exists between templates associated to the NS and the running configuration.
last_updated_times<String[]>Read-writeList of last updated times for templates.
diff_reportname<String>Read-onlyName of the SavedVsRunning diff reportname.
hostname<String>Read-onlyHost Name of the device.
display_name<String>Read-onlyDisplay Name of the device.
device_name<String>Read-onlyName of the device.
templatediff_reportname<String>Read-onlyName of the Template diff reports.

Operations

(click to see Properties)

INVENTORY| DOWNLOAD_CONF| DELETE| 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>.

inventory

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

HTTP Method: null

Request Payload:

{ns_conf: {
"last_updated_times":<String_value[]>,
"diff_status":<String_value>,
"ns_ip_address":<String_value>,
"last_updated_time":<Integer_value>,
"id":<String_value>,
"templatediff_status":<String_value>}}

Response Payload:

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

download_conf

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

HTTP Method: null

Request Payload:

{ns_conf: {
"last_updated_times":<String_value[]>,
"diff_status":<String_value>,
"ns_ip_address":<String_value>,
"last_updated_time":<Integer_value>,
"id":<String_value>,
"templatediff_status":<String_value>}}

Response Payload:

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

delete

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

HTTP Method: null

Request Payload:

{ns_conf: {
<b>"id":<String_value></b>,
"last_updated_times":<String_value[]>,
"diff_status":<String_value>,
"ns_ip_address":<String_value>,
"last_updated_time":<Integer_value>,
"templatediff_status":<String_value>}}

Response Payload:

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

get (all)

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

HTTP Method: null

Response Payload:

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