ADC NITRO APIs

contentinspection

Statistics for contentinspection.

Properties

(click to see Operations )

Name Data Type Permissions Description
clearstats Read-write Clear the statsistics / counters.

Possible values = basic, full
inlinerequestssent Read-only HTTP/HTTPS requests sent for ContentInspection.
inlineresponsessent Read-only HTTP/HTTPS responses sent for ContentInspection.
inlinereqbytessent Read-only Number of bytes transfered for requests to IPS
inlinereqbytesrecv Read-only Number of bytes received for requests from IPS
inlinerespbytessent Read-only Number of bytes transfered for responses to IPS
inlinerespbytesrecv Read-only Number of bytes received for responses from IPS
inlineserverdownreset Read-only Number of requests Reset when Inline device is down
inlineserverdowndrop Read-only Number of requests Dropped when Inline device is down
inlineserverdownbypass Read-only Number of requests bypass content Inspection Module when Inline device is down
inlinegeneratedresponses Read-only Number of Inline device generated Responses
mirrorrequestssent Read-only Number of requests sent for Intrusion Detection
mirrorresponsessent Read-only Number of responses sent for Intrusion Detection
mirrorreqbytessent Read-only Number of request Bytes sent for Intrusion Detection
mirrorrespbytessent Read-only Number of response Bytes sent for Intrusion Detection
mirrorserverdownreset Read-only Number of requests Reset when Mirror device is down
mirrorserverdowndrop Read-only Number of requests Dropped when Mirror device is down
mirrorserverdownbypass Read-only Number of requests bypass ContentInspection module when Mirror device is down
icapreqmodrequests Read-only Number of requests sent to ICAP Server
icaprespmodrequests Read-only Number of responses sent for Intrusion DEtection
icappreviewenabledrequests Read-only Number of preview requests for ICAP
icap204enabledrequests Read-only Number of 204 Rquests
icap100contrecv Read-only Number of 100-continue responses received
icap204nocontentrecv Read-only Number of 204 No content responses received
icapadaptiverequests Read-only Number of Adaptive requests
icapadaptiveresponses Read-only Number of Adaptive Responses
icapcalloutinitiated Read-only Number of callout Requests started
icapcalloutcompleted Read-only Number of callout requests finished
icaperrorshandled Read-only Number of errors sent
icapserverdownreset Read-only Number of requests for which serverdown Reset Action is taken
icapserverdowndrop Read-only Number of requests for which serverdown Drop Action is taken
icapserverdownbypass Read-only Number of requests for which serverdown Bypass Action is taken

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: http:// <netscaler-ip-address> /nitro/v1/stat/contentinspection Query-parameters: args http:// <netscaler-ip-address> /nitro/v1/stat/contentinspection? args=detail: <Boolean_value> ,fullvalues: <Boolean_value> ,ntimes: <Double_value> ,logfile: <String_value> ,clearstats: <String_value>

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

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

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

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:

{  "contentinspection": [ {
"icaperrorshandled":<Double_value>,
"icapserverdowndrop":<Double_value>,
"icapserverdownreset":<Double_value>,
"icapcalloutcompleted":<Double_value>,
"mirrorresponsessent":<Double_value>,
"inlineresponsessent":<Double_value>,
"mirrorserverdownreset":<Double_value>,
"icap100contrecv":<Double_value>,
"icapadaptiveresponses":<Double_value>,
"inlineserverdownbypass":<Double_value>,
"mirrorrespbytessent":<Double_value>,
"inlineserverdownreset":<Double_value>,
"icappreviewenabledrequests":<Double_value>,
"icap204enabledrequests":<Double_value>,
"inlinerequestssent":<Double_value>,
"icapreqmodrequests":<Double_value>,
"icapcalloutinitiated":<Double_value>,
"inlinereqbytesrecv":<Double_value>,
"mirrorreqbytessent":<Double_value>,
"mirrorrequestssent":<Double_value>,
"mirrorserverdownbypass":<Double_value>,
"inlinerespbytesrecv":<Double_value>,
"inlinereqbytessent":<Double_value>,
"icaprespmodrequests":<Double_value>,
"icap204nocontentrecv":<Double_value>,
"icapadaptiverequests":<Double_value>,
"inlinegeneratedresponses":<Double_value>,
"icapserverdownbypass":<Double_value>,
"inlinerespbytessent":<Double_value>,
"inlineserverdowndrop":<Double_value>,
"mirrorserverdowndrop":<Double_value>
}]}

<!--NeedCopy-->
contentinspection