contentInspection-callout¶
The following operations can be performed on "contentInspection-callout":
add contentInspection callout¶
Adds an expression element that, when evaluated, sends a request to Content Inspection service and receives a response from the service. Can be used to obtain additional information for use in evaluating policy rules and other expressions. The expression prefix SYS.CI_CALLOUT invokes a Content Inspection callout.
Synopsis¶
add contentInspection callout <name> -type ICAP [-profileName <string>] (-serverName <string> | (-serverip <ip_addr|ipv6_addr> [-serverport <positive_integer>])) -returnType <returnType> -resultExpr <string> [-comment <string>]
Arguments¶
name
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.
type
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
Name of the Content Inspection profile. The type of the configured profile must match the type specified using -type argument.
serverName
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.
serverip
IP address of Content Inspection server. Mutually exclusive with the server name parameter.
serverport
Port of the Content Inspection server. Default value: 1344 Minimum value: 1 Maximum value: 65535
returnType
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
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")
comment
Any comments to preserve information about this Content Inspection callout.
Example¶
add contentInspection callout cic
rm contentInspection callout¶
Removes a Content Inspection callout. You cannot remove a Content Inspection callout that is used in any part of policy, action, or expression.
Synopsis¶
rm contentInspection callout <name>
Arguments¶
name
Name of the Content Inspection callout to remove.
Example¶
rm contentInspection callout cic
set contentInspection callout¶
Modifies the attributes of an existing Content Inspection callout element.
Synopsis¶
set contentInspection callout <name> [-serverName <string>] [-serverip <ip_addr|ipv6_addr>] [-serverport <positive_integer>] [-profileName <string>] [-returnType <returnType>] [-resultExpr <string>] [-comment <string>]
Arguments¶
name
Name of the Content Inspection callout to configure.
serverName
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.
serverip
IP address of Content Inspection server. Mutually exclusive with the server name parameter.
serverport
Port of the Content Inspection server. Default value: 1344 Minimum value: 1 Maximum value: 65535
profileName
Name of the Content Inspection profile. The type of the configured profile must match the type specified using -type argument.
returnType
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
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")
comment
Any comments to preserve information about this Content Inspection callout.
Example¶
set contentInspection callout cic -profileName NewProfileName
unset contentInspection callout¶
Use this command to remove contentInspection callout settings.Refer to the set contentInspection callout command for meanings of the arguments.
Synopsis¶
unset contentInspection callout <name> [-serverport] [-comment]
show contentInspection callout¶
Displays information about the configured Content Inspection callouts.
Synopsis¶
show contentInspection callout [<name>]
Arguments¶
name
Name of the Content Inspection callout to display. If a name is not provided, information about all configured Content Inspection callouts is shown.
Output¶
stateflag
type
Type
profileName
Profile name
serverName
Vserver/Server name
serverip
Server IP address.
serverport
Server port.
returnType
Return type of the callout
resultExpr
String expression for callout response
hits
Total hits
undefHits
Total undefs
undefReason
Reason for last undef
comment
Any comments to preserve information about this Content Inspection callout.
devno
count
Example¶
show contentInspection callout cic