Developer Documentation
ADC NITRO APIs
Current Release 13.1 13

contentinspectioncallout

August 17, 2023
Contributed by: 
C

Configuration for Content Inspection callout resource.

Properties

(click to see Operations )

Name Data Type Permissions Description
name Read-write Name for the Content Inspection callout. Not case sensitive. Must begin with an ASCII letter or underscore (_) character, and must consist only of ASCII alphanumeric or underscore characters. Must not begin with ‘re’ or ‘xp’ or be a word reserved for use as an expression qualifier prefix (such as HTTP) or enumeration value (such as ASCII). Must not be the name of an existing named expression, pattern set, dataset, stringmap, or callout.

Minimum length = 1
type Read-write Type of the Content Inspection callout. It must be one of the following
  • ICAP - Sends ICAP request to the configured ICAP server. Possible values = ICAP
    		•
    profilename Read-write Name of the Content Inspection profile. The type of the configured profile must match the type specified using -type argument.

    Minimum length = 1

    Maximum length = 127
    servername Read-write Name of the load balancing or content switching virtual server or service to which the Content Inspection request is issued. Mutually exclusive with server IP address and port parameters. The service type must be TCP or SSL_TCP. If there are vservers and services with the same name, then vserver is selected.

    Minimum length = 1

    Maximum length = 127
    serverip Read-write IP address of Content Inspection server. Mutually exclusive with the server name parameter.

    Minimum length = 1
    serverport Read-write Port of the Content Inspection server.

    Default value: 1344

    Minimum value = 1

    Maximum value = 65535
    returntype Read-write Type of data that the target callout agent returns in response to the callout. Available settings function as follows
  • TEXT - Treat the returned value as a text string.
  • NUM - Treat the returned value as a number.
  • BOOL - Treat the returned value as a Boolean value. Note: You cannot change the return type after it is set. Possible values = BOOL, NUM, TEXT
    		•
    resultexpr Read-write Expression that extracts the callout results from the response sent by the CI callout agent. Must be a response based expression, that is, it must begin with ICAP.RES. The operations in this expression must match the return type. For example, if you configure a return type of TEXT, the result expression must be a text based expression, as in the following example: icap.res.header(“ISTag”).

    Minimum length = 1
    comment Read-write Any comments to preserve information about this Content Inspection callout.
    hits Read-only Total hits.
    undefhits Read-only Total undefs.
    undefreason Read-only Reason for last undef.

    Possible values = Failed to add service, Vserver not found, Not a HTTP or SSL vserver, Generated callout request is invalid, Content-Length header not found in callout request, Not enough space to put Content-Length value, Config incomplete, Server is DOWN, Creating callout connection failed, No memory to generate callout request packets, No memory to create callout task, No memory to create callout async, Callout request expression undef, No callout response expression, Skipped callout response eval, Callout response pixl init undef, Callout response expression undef
    __count Read-only count parameter

    Operations

    (click to see Properties )

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

    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/contentinspectioncallout

    HTTP Method: POST

    Request Headers:

    Cookie:NITRO_AUTH_TOKEN= <tokenvalue>

    Content-Type:application/json

    Request Payload: 

    
{"contentinspectioncallout":{
<b>      "name":<String_value>,
</b><b>      "type":<String_value>,
</b>      "profilename":<String_value>,
      "servername":<String_value>,
      "serverip":<String_value>,
      "serverport":<Double_value>,
<b>      "returntype":<String_value>,
</b><b>      "resultexpr":<String_value>,
</b>      "comment":<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

    delete

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

    update

    URL: http:// <netscaler-ip-address> /nitro/v1/config/contentinspectioncallout

    HTTP Method: PUT

    Request Headers:

    Cookie:NITRO_AUTH_TOKEN= <tokenvalue>

    Content-Type:application/json

    Request Payload: 

    
{"contentinspectioncallout":{
<b>      "name":<String_value>,
</b>      "servername":<String_value>,
      "serverip":<String_value>,
      "serverport":<Double_value>,
      "profilename":<String_value>,
      "returntype":<String_value>,
      "resultexpr":<String_value>,
      "comment":<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/contentinspectioncallout? action=unset

    HTTP Method: POST

    Request Headers:

    Cookie:NITRO_AUTH_TOKEN= <tokenvalue>

    Content-Type:application/json

    Request Payload: 

    
{"contentinspectioncallout":{
<b>      "name":<String_value>,
</b>      "serverport":true,
      "comment":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

    get (all)

    URL: http:// <netscaler-ip-address> /nitro/v1/config/contentinspectioncallout

    Query-parameters:

    attrs

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

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

    view

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

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

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

    
{ "contentinspectioncallout": [ {
      "name":<String_value>,
      "type":<String_value>,
      "profilename":<String_value>,
      "servername":<String_value>,
      "serverip":<String_value>,
      "serverport":<Double_value>,
      "returntype":<String_value>,
      "resultexpr":<String_value>,
      "hits":<Double_value>,
      "undefhits":<Double_value>,
      "undefreason":<String_value>,
      "comment":<String_value>
}]}

<!--NeedCopy-->

    get

    URL: http:// <netscaler-ip-address> /nitro/v1/config/contentinspectioncallout/ name_value<String>

    Query-parameters:

    attrs

    http:// <netscaler-ip-address> /nitro/v1/config/contentinspectioncallout/ 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/contentinspectioncallout/ name_value<String> ? view=summary

    Use this query-parameter to get the summary output of contentinspectioncallout 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: 

    
{  "contentinspectioncallout": [ {
      "name":<String_value>,
      "type":<String_value>,
      "profilename":<String_value>,
      "servername":<String_value>,
      "serverip":<String_value>,
      "serverport":<Double_value>,
      "returntype":<String_value>,
      "resultexpr":<String_value>,
      "hits":<Double_value>,
      "undefhits":<Double_value>,
      "undefreason":<String_value>,
      "comment":<String_value>
}]}

<!--NeedCopy-->

    count

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

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

<!--NeedCopy-->
    contentinspectioncallout
    August 17, 2023
    Contributed by: 
    C
    August 17, 2023
    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.