Developer Documentation
ADC NITRO APIs
Current Release 13.1 13

contentinspectionaction

May 23, 2024
Contributed by: 
C

Configuration for Content Inspection action resource.

Properties

(click to see Operations )

Name Data Type Permissions Description
name Read-write Name of the remote service action. Must begin with an ASCII alphabetic or underscore (_) character, and must contain only ASCII alphanumeric, underscore, hash (#), period (.), space, colon (:), at (@), equals (=), and hyphen (-) characters.
type Read-write Type of operation this action is going to perform. following actions are available to configure
  • ICAP - forward the incoming request or response to an ICAP server for modification.
  • INLINEINSPECTION - forward the incoming or outgoing packets to IPS server for Intrusion Prevention.
  • MIRROR - Forwards cloned packets for Intrusion Detection.
  • NOINSPECTION - This does not forward incoming and outgoing packets to the Inspection device.
  • NSTRACE - capture current and further incoming packets on this transaction. Possible values = ICAP, INLINEINSPECTION, MIRROR, NOINSPECTION
    		•
    servername Read-write Name of the LB vserver or service.

    Minimum length = 1

    Maximum length = 127
    serverip Read-write IP address of remoteService.

    Minimum length = 1
    serverport Read-write Port of remoteService.

    Default value: 1344

    Minimum value = 1

    Maximum value = 65535
    icapprofilename Read-write Name of the ICAP profile to be attached to the contentInspection action.

    Minimum length = 1

    Maximum length = 127
    ifserverdown Read-write Name of the action to perform if the Vserver representing the remote service is not UP. This is not supported for NOINSPECTION Type. The Supported actions are
  • RESET - Reset the client connection by closing it. The client program, such as a browser, will handle this and may inform the user. The client may then resend the request if desired.
  • DROP - Drop the request without sending a response to the user.
  • CONTINUE - It bypasses the ContentIsnpection and Continues/resumes the Traffic-Flow to Client/Server. Default value: RESET Possible values = CONTINUE, DROP, RESET
    		•
    reqtimeout Read-only Time, in seconds, within which the remote service request must complete. This is not supported for NOINSPECTION action type. If the request does not complete within this time, the specified request timeout action is executed. Zero disables the timeout.

    Default value: 0

    Minimum value = 0

    Maximum value = 86400
    reqtimeoutaction Read-only Name of the action to perform if the Vserver representing the remote service does not respond. This is not supported for NOINSPECTION action type. There are also some built-in actions which can be used. These are
  • RESET - Reset the client connection by closing it. The client program, such as a browser, will handle this and may inform the user. The client may then resend the request if desired.
  • DROP - Drop the request without sending a response to the user. Default value: BYPASS Possible values = BYPASS, DROP, RESET
    		•
    hits Read-only The number of times the action has been taken.
    referencecount Read-only The number of references to the action.
    undefhits Read-only The number of times the action resulted in UNDEF.
    builtin <String[]> Read-only Flag to determine whether contentinspection action is built-in or not.

    Possible values = MODIFIABLE, DELETABLE, IMMUTABLE, PARTITION_ALL
    feature Read-only The feature to be checked while applying this config.
    __count Read-only count parameter

    Operations

    (click to see Properties )

    • ADD
    • GET (ALL)
    • GET
    • COUNT
    • UPDATE
    • UNSET
    • DELETE

    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

    add

    URL: http:// <netscaler-ip-address> /nitro/v1/config/contentinspectionaction HTTP Method: POST

    Request Headers:

    Cookie:NITRO_AUTH_TOKEN= <tokenvalue>

    Content-Type:application/json

    Request Payload: 

    {"contentinspectionaction":{
<b>"name":<String_value>,
</b><b>"type":<String_value>,
</b>"servername":<String_value>,
"serverip":<String_value>,
"serverport":<Double_value>,
"icapprofilename":<String_value>,
"ifserverdown":<String_value>
}}

<!--NeedCopy-->

    Response: HTTP Status Code on Success: 201 Created

    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

    update

    URL: http:// <netscaler-ip-address> /nitro/v1/config/contentinspectionaction HTTP Method: PUT

    Request Headers:

    Cookie:NITRO_AUTH_TOKEN= <tokenvalue>

    Content-Type:application/json

    Request Payload: 

    {"contentinspectionaction":{
<b>"name":<String_value>,
</b>"servername":<String_value>,
"serverip":<String_value>,
"serverport":<Double_value>,
"icapprofilename":<String_value>,
"ifserverdown":<String_value>
}}

<!--NeedCopy-->

    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

    unset

    URL: http:// <netscaler-ip-address> /nitro/v1/config/contentinspectionaction? action=unset HTTP Method: POST

    Request Headers:

    Cookie:NITRO_AUTH_TOKEN= <tokenvalue>

    Content-Type:application/json

    Request Payload: 

    {"contentinspectionaction":{
<b>"name":<String_value>,
</b>"serverport":true,
"ifserverdown":true
}}

<!--NeedCopy-->

    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

    delete

    URL: http:// <netscaler-ip-address> /nitro/v1/config/contentinspectionaction/ name_value<String> HTTP Method: DELETE

    Request Headers:

    Cookie:NITRO_AUTH_TOKEN= <tokenvalue>

    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

    get (all)

    URL: http:// <netscaler-ip-address> /nitro/v1/config/contentinspectionaction Query-parameters: attrs http:// <netscaler-ip-address> /nitro/v1/config/contentinspectionaction? 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/contentinspectionaction? filter=property-name1:property-val1,property-name2:property-val2

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

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

    Use this query-parameter to get the summary output of contentinspectionaction 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/contentinspectionaction? pagesize=#no;pageno=#no

    Use this query-parameter to get the contentinspectionaction 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: 

    { "contentinspectionaction": [ {
"name":<String_value>,
"type":<String_value>,
"servername":<String_value>,
"serverip":<String_value>,
"serverport":<Double_value>,
"icapprofilename":<String_value>,
"ifserverdown":<String_value>,
"reqtimeout":<Double_value>,
"reqtimeoutaction":<String_value>,
"hits":<Double_value>,
"referencecount":<Double_value>,
"undefhits":<Double_value>,
"builtin":<String[]_value>,
"feature":<String_value>
}]}

<!--NeedCopy-->

    get

    URL: http:// <netscaler-ip-address> /nitro/v1/config/contentinspectionaction/ name_value<String> Query-parameters: attrs http:// <netscaler-ip-address> /nitro/v1/config/contentinspectionaction/ name_value<String> ? attrs=property-name1,property-name2

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

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

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

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

    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: 

    {  "contentinspectionaction": [ {
"name":<String_value>,
"type":<String_value>,
"servername":<String_value>,
"serverip":<String_value>,
"serverport":<Double_value>,
"icapprofilename":<String_value>,
"ifserverdown":<String_value>,
"reqtimeout":<Double_value>,
"reqtimeoutaction":<String_value>,
"hits":<Double_value>,
"referencecount":<Double_value>,
"undefhits":<Double_value>,
"builtin":<String[]_value>,
"feature":<String_value>
}]}

<!--NeedCopy-->

    count

    URL: http:// <netscaler-ip-address> /nitro/v1/config/contentinspectionaction? 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: 

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

<!--NeedCopy-->
    contentinspectionaction
    May 23, 2024
    Contributed by: 
    C
    May 23, 2024
    Contributed by: 
    C

    In this article

    Site feedback | Your privacy choices footer linkYour Privacy Choices | Privacy and legal terms | Cookie preferences | Consent settings | docs.cloud.com
    © 1999- Cloud Software Group, Inc. All rights reserved.