| getnsicapprofileResult Structure Definition |
The getnsicapprofileResult structure defines the return type for getnsicapprofile API. |
Syntax |
Members |
rc |
If the method succeeds, rc is 0 else rc > 0. Values above 0x8000 indicate Warnings. |
message |
If the method succeeds, message is NULL else message contains Error/Warning message. |
nsicapprofileList |
List of nsicapprofiles |
| nsicapprofile Structure Definition |
The nsicapprofile structure defines the actual return type values for getnsicapprofile API. |
Syntax |
Members |
name |
Name of the ICAP profile to be displayed |
preview |
Enable or Disable preview header with ICAP request. This feature allows an ICAP server to see the beginning of a transaction, then decide if it wants to opt-out of the transaction early instead of receiving the remainder of the request message. |
previewlength |
Value of Preview Header field. Citrix ADC uses the minimum of this set value and the preview size received on OPTIONS response. |
uri |
URI representing icap service. It is a mandatory argument while creating an icapprofile. |
hostheader |
ICAP Host Header |
useragent |
ICAP User Agent Header String |
mode |
ICAP Mode of operation. It is a mandatory argument while creating an icapprofile. |
queryparams |
Query parameters to be included with ICAP request URI. Entered values should be in arg=value format. For more than one parameters, add & separated values. e.g.: arg1=val1&arg2=val2. |
connectionkeepalive |
If enabled, Citrix ADC keeps the ICAP connection alive after a transaction to reuse it to send next ICAP request. |
allow204 |
Enable or Disable sending Allow: 204 header in ICAP request. |
inserticapheaders |
Insert custom ICAP headers in the ICAP request to send to ICAP server. The headers can be static or can be dynamically constructed using PI Policy Expression. For example, to send static user agent and Client's IP address, the expression can be specified as "User-Agent: NS-ICAP-Client/V1.0\r\nX-Client-IP: "+CLIENT.IP.SRC+"\r\n".
The Citrix ADC does not check the validity of the specified header name-value. You must manually validate the specified header syntax. |
inserthttprequest |
Exact HTTP request, in the form of an expression, which the Citrix ADC encapsulates and sends to the ICAP server. If you set this parameter, the ICAP request is sent using only this header. This can be used when the HTTP header is not available to send or ICAP server only needs part of the incoming HTTP request. The request expression is constrained by the feature for which it is used.
The Citrix ADC does not check the validity of this request. You must manually validate the request. |
reqtimeout |
Time, in seconds, within which the remote server should respond to the ICAP-request. If the Netscaler does not receive full response with this time, the specified request timeout action is performed. Zero value disables this timeout functionality. |
reqtimeoutaction |
Name of the action to perform if the Vserver/Server representing the remote service does not respond with any response within the timeout value configured. The Supported actions are
* BYPASS - This Ignores the remote server response and sends the request/response to Client/Server.
* If the ICAP response with Encapsulated headers is not received within the request-timeout value configured, this Ignores the remote ICAP server response and sends the Full request/response to Server/Client.
* 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. |
logaction |
Name of the audit message action which would be evaluated on receiving the ICAP response to emit the logs. |
inspecthttp2 |
Enable or Disable ICAP inspection for HTTP/2 traffic. |
_nextgenapiresource |
See Also |