ADM NITRO APIs

aa_ind_details_l2

Configuration for Indicator Alert Details resource.

Properties

(click to see Operations )

Name Data Type Permissions Description
window_end_time Read-write Window End time..
ind_detection_msg Read-write Indicator Detection Message.

Maximum length = 512
rpt_sample_time Read-write Report Sample time..
window_start_time Read-write Window start time..
ind_detection_time Read-write Report Sample time..
ind_value Read-write Indicator Value.
svcname Read-write svcname.

Maximum length = 255
ctnsappname Read-write AppName.

Maximum length = 255
ind_id Read-write Indicator Rule Id.
confidence Read-write confidence.
ip_address Read-write IP Address.

Maximum length = 512
severity Read-write Severity of the alert [ CRITICAL/MEDIUM/LOW ].
ind_category_desc Read-write Indicator category description.
ind_weight_desc Read-write Indicator weight description.
ind_name_desc Read-write Indicator name description.

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/aa_ind_details_l2 Query-parameters:

filter https://<MGMT-IP>/nitro/v2/config/aa_ind_details_l2 ?filter=property-name1:property-value1,property-name2:property-value2 Use this query-parameter to get the filtered set of aa_ind_details_l2 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/aa_ind_details_l2 ?pagesize=#no;pageno=#no Use this query-parameter to get the aa_ind_details_l2 resources in chunks.

count https://<MGMT-IP>/nitro/v2/config/aa_ind_details_l2 ?count=yes Use this query-parameter to get the count of aa_ind_details_l2 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, "aa_ind_details_l2":[{
"window_end_time":<Double_value>,
"ind_detection_msg":<String_value>,
"rpt_sample_time":<Double_value>,
"window_start_time":<Double_value>,
"ind_detection_time":<Double_value>,
"ind_value":<Integer_value>,
"svcname":<String_value>,
"ctnsappname":<String_value>,
"ind_id":<Integer_value>,
"confidence":<Double_value>,
"ip_address":<String_value>,
"severity":<Integer_value>,
"ind_category_desc":<String_value>,
"ind_weight_desc":<Integer_value>,
"ind_name_desc":<String_value>}]}

<!--NeedCopy-->
aa_ind_details_l2