ADC NITRO APIs

nsevents

Configuration for events resource.

Properties

(click to see Operations )

Name Data Type Permissions Description
eventno Read-write Event number starting from which events must be shown.
time Read-only Event no.
eventcode Read-only event Code.
devid Read-only Device Name.
devname Read-only Device Name.
text Read-only Event no.
data0 Read-only additional event information.
data1 Read-only additional event information.
data2 Read-only additional event information.
data3 Read-only additional event information.
__count Read-only count parameter

Operations

(click to see Properties )

  • GET (ALL)
  • COUNT

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

get (all)

URL: http:// <netscaler-ip-address> /nitro/v1/config/nsevents Query-parameters: args http:// <netscaler-ip-address> /nitro/v1/config/nsevents? args=eventno: <Double_value>

Use this query-parameter to get nsevents resources based on additional properties.

attrs http:// <netscaler-ip-address> /nitro/v1/config/nsevents? attrs=property-name1,property-name2

Use this query parameter to specify the resource details that you want to retrieve.

filter http:// <netscaler-ip-address> /nitro/v1/config/nsevents? filter=property-name1:property-val1,property-name2:property-val2

Use this query-parameter to get the filtered set of nsevents resources configured on NetScaler.Filtering can be done on any of the properties of the resource.

view http:// <netscaler-ip-address> /nitro/v1/config/nsevents? view=summary

Use this query-parameter to get the summary output of nsevents resources configured on NetScaler.

Note: By default, the retrieved results are displayed in detail view (?view=detail).

pagination http:// <netscaler-ip-address> /nitro/v1/config/nsevents? pagesize=#no;pageno=#no

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

HTTP Method: GET

Request Headers:

Cookie:NITRO_AUTH_TOKEN= <tokenvalue>

Accept:application/json

Response: HTTP Status Code on Success: 200 OK

HTTP Status Code on Failure: 4xx <string> (for general HTTP errors) or 5xx <string> (for NetScaler-specific errors). The response payload provides details of the error

Response Header:

Content-Type:application/json

Response Payload:

{ "nsevents": [ {
eventno:<Double_value>"time":<Double_value>,
"eventcode":<Double_value>,
"devid":<Double_value>,
"devname":<String_value>,
"text":<String_value>,
"data0":<Double_value>,
"data1":<Double_value>,
"data2":<Double_value>,
"data3":<Double_value>
}]}

<!--NeedCopy-->

count

URL: http:// <netscaler-ip-address> /nitro/v1/config/nsevents? count=yes HTTP Method: GET

Request Headers:

Cookie:NITRO_AUTH_TOKEN= <tokenvalue>

Accept:application/json

Response: HTTP Status Code on Success: 200 OK

HTTP Status Code on Failure: 4xx <string> (for general HTTP errors) or 5xx <string> (for NetScaler-specific errors). The response payload provides details of the error

Response Header:

Content-Type:application/json

Response Payload:

{ "nsevents": [ { "__count": "#no"} ] }

<!--NeedCopy-->
nsevents