ADM NITRO APIs

filter_criteria

Configuration for event filter criteria properties resource.

Properties

(click to see Operations )

Name Data Type Permissions Description
source <String> Read-write Source Ip Address of the device which sent the trap.
cmd_exec_status <String> Read-write Command Execution Status if the event is generated for any config change or config save in device.
device_family <String> Read-write Family of device for which we have received the event.
parent_name <String> Read-write Name of the parent resource.
message <String> Read-write Event Message.
parent_id <String> Read-write Id of the parent resource.
cmd_auth_status <String> Read-write Command Authorization Status if the event is generated for any config change or config save in device.
config_cmd <String> Read-write Config Command if the event is generated for any config change in device.
id <String> Read-write Id is system generated key.
category <String> Read-write Category of Event.
severity <String> Read-write Severity of Event.
failureobj <String> Read-write Failure objects are entity instances or counters for which an event has been generated.
category_array <String[]> Read-write Category list.
failureobj_array <String[]> Read-write Failure Object list.
source_array <String[]> Read-write Source list.
severity_array <String[]> Read-write Severity list.

Operations

(click to see Properties )

    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

    filter_criteria