Skip to content

si_security_overview

Configuration for AF Data Report table resource.

(click to see Operations)

Properties

(click to see Operations)

NameData TypePermissionsDescription
total_compliant_count<Double>Read-writetotal_compliant_count.
severity_type<String>Read-writeseverity_type.
Maximum length = 255
__count<Double>Read-writecount..
name<String>Read-writeAppName.
Maximum length = 255
safety_index<Double>Read-writesafety_index.
total_attacks<Double>Read-writetotal attacks..
not_compliant_percentage<Double>Read-writenot_compliant_percentage.
not_compliant_count<Double>Read-writenot_compliant_count.
threat_index<Double>Read-writethreat_index.
id<String>Read-writeId is Security check violation name.
Maximum length = 255
si_app_unit_name<String>Read-writeAppName.
Maximum length = 255

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>.

get (all)

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

HTTP Method: null

Response Payload:

{ "errorcode": 0, "message": "Done", "severity": ;ltString_value>, "si_security_overview":[{
"total_compliant_count":<Double_value>,
"severity_type":<String_value>,
"__count":<Double_value>,
"name":<String_value>,
"safety_index":<Double_value>,
"total_attacks":<Double_value>,
"not_compliant_percentage":<Double_value>,
"not_compliant_count":<Double_value>,
"threat_index":<Double_value>,
"si_device_ip_address":<String_value>,
"id":<String_value>,
"si_app_unit_name":<String_value>}]}