12.10.10. Configuring ICAP servers

You configure ICAP servers at the security-policy icap-server level.

To create an ICAP server, use the following command:

Admin@UGOS# create security-policy icap-server

Available parameters:

Parameter

Description

name

ICAP server name.

description

ICAP server description.

ip

ICAP server IP address.

port

TCP port of the ICAP server. Default value: 1344.

max-msg-size

Maximum message size sent to the ICAP server (in kilobytes). The default is 0 (the request body will not be passed to the ICAP server).

check-icap

Period to check ICAP server availability.

bypass

If enabled, UserGate will not send data to the ICAP server when the server is unavailable.

reqmod-service

Use Reqmod:

  • <text>: set the directory path on the ICAP server.

  • off: disable Reqmod.

respmod-service

Use Respmod:

  • <text>: set the directory path on the ICAP server.

  • off: disable Respmod.

user-header

Set sending of the user name to the ICAP server:

  • <text>: specify the header name in which the username will be sent to the ICAP server.

  • off: do not send the username to the ICAP server.

user-encode

Specify if the username is in Base64 encoding:

  • on.

  • off.

ip-header

Specify whether the user's IP address should be sent to the ICAP server:

  • <text>: specify the header name in which the IP address will be sent to the ICAP server.

  • off: do not send the user's IP address to the ICAP server.

mac-header

Specify whether the user's MAC address should be sent to the ICAP server:

  • <text>: specify the header name in which the user's MAC address will be sent to the ICAP server.

  • off: do not send the user's MAC address to the ICAP server.

To update an existing ICAP server, use the following command:

Admin@UGOS# set security-policy icap-server <server-name>

The parameters available to update are the same as those used to create an ICAP server.

To delete an ICAP server, use the following command:

Admin@UGOS# delete security-policy icap-server <server-name>

To display information about an ICAP server, use the following command:

Admin@UGOS# show security-policy icap-server <server-name>