Fortinet white logo
Fortinet white logo

CLI Reference

config icap profile

config icap profile

Configure ICAP profiles.

config icap profile
    Description: Configure ICAP profiles.
    edit <name>
        config icap-headers
            Description: Configure ICAP forwarded request headers.
            edit <id>
                set name {string}
                set content {string}
                set base64-encoding [disable|enable]
            next
        end
        set methods {option1}, {option2}, ...
        set preview [disable|enable]
        set preview-data-length {integer}
        set replacemsg-group {string}
        set request [disable|enable]
        set request-failure [error|bypass]
        set request-path {string}
        set request-server {string}
        set response [disable|enable]
        set response-failure [error|bypass]
        set response-path {string}
        set response-req-hdr [disable|enable]
        set response-server {string}
        set streaming-content-bypass [disable|enable]
    next
end

config icap profile

Parameter

Description

Type

Size

methods

The allowed HTTP methods that will be sent to ICAP server for further processing.

option

-

Option

Description

delete

Forward HTTP request or response with DELETE method to ICAP server for further processing.

get

Forward HTTP request or response with GET method to ICAP server for further processing.

head

Forward HTTP request or response with HEAD method to ICAP server for further processing.

options

Forward HTTP request or response with OPTIONS method to ICAP server for further processing.

post

Forward HTTP request or response with POST method to ICAP server for further processing.

put

Forward HTTP request or response with PUT method to ICAP server for further processing.

trace

Forward HTTP request or response with TRACE method to ICAP server for further processing.

other

Forward HTTP request or response with All other methods to ICAP server for further processing.

name

ICAP profile name.

string

Maximum length: 35

preview

Enable/disable preview of data to ICAP server.

option

-

Option

Description

disable

Disable preview of data to ICAP server.

enable

Enable preview of data to ICAP server.

preview-data-length

Preview data length to be sent to ICAP server.

integer

Minimum value: 0 Maximum value: 4096

replacemsg-group

Replacement message group.

string

Maximum length: 35

request

Enable/disable whether an HTTP request is passed to an ICAP server.

option

-

Option

Description

disable

Disable HTTP request passing to ICAP server.

enable

Enable HTTP request passing to ICAP server.

request-failure

Action to take if the ICAP server cannot be contacted when processing an HTTP request.

option

-

Option

Description

error

Error.

bypass

Bypass.

request-path

Path component of the ICAP URI that identifies the HTTP request processing service.

string

Maximum length: 127

request-server

ICAP server to use for an HTTP request.

string

Maximum length: 35

response

Enable/disable whether an HTTP response is passed to an ICAP server.

option

-

Option

Description

disable

Disable HTTP response passing to ICAP server.

enable

Enable HTTP response passing to ICAP server.

response-failure

Action to take if the ICAP server cannot be contacted when processing an HTTP response.

option

-

Option

Description

error

Error.

bypass

Bypass.

response-path

Path component of the ICAP URI that identifies the HTTP response processing service.

string

Maximum length: 127

response-req-hdr

Enable/disable addition of req-hdr for ICAP response modification (respmod) processing.

option

-

Option

Description

disable

Do not add req-hdr for response modification (respmod) processing.

enable

Add req-hdr for response modification (respmod) processing.

response-server

ICAP server to use for an HTTP response.

string

Maximum length: 35

streaming-content-bypass

Enable/disable bypassing of ICAP server for streaming content.

option

-

Option

Description

disable

Disable bypassing of ICAP server for streaming content.

enable

Enable bypassing of ICAP server for streaming content.

config icap-headers

Parameter

Description

Type

Size

id

HTTP forwarded header ID.

integer

Minimum value: 0 Maximum value: 4294967295

name

HTTP forwarded header name.

string

Maximum length: 79

content

HTTP header content.

string

Maximum length: 255

base64-encoding

Enable/disable use of base64 encoding of HTTP content.

option

-

Option

Description

disable

Disable use of base64 encoding of HTTP content.

enable

Enable use of base64 encoding of HTTP content.

config icap profile

config icap profile

Configure ICAP profiles.

config icap profile
    Description: Configure ICAP profiles.
    edit <name>
        config icap-headers
            Description: Configure ICAP forwarded request headers.
            edit <id>
                set name {string}
                set content {string}
                set base64-encoding [disable|enable]
            next
        end
        set methods {option1}, {option2}, ...
        set preview [disable|enable]
        set preview-data-length {integer}
        set replacemsg-group {string}
        set request [disable|enable]
        set request-failure [error|bypass]
        set request-path {string}
        set request-server {string}
        set response [disable|enable]
        set response-failure [error|bypass]
        set response-path {string}
        set response-req-hdr [disable|enable]
        set response-server {string}
        set streaming-content-bypass [disable|enable]
    next
end

config icap profile

Parameter

Description

Type

Size

methods

The allowed HTTP methods that will be sent to ICAP server for further processing.

option

-

Option

Description

delete

Forward HTTP request or response with DELETE method to ICAP server for further processing.

get

Forward HTTP request or response with GET method to ICAP server for further processing.

head

Forward HTTP request or response with HEAD method to ICAP server for further processing.

options

Forward HTTP request or response with OPTIONS method to ICAP server for further processing.

post

Forward HTTP request or response with POST method to ICAP server for further processing.

put

Forward HTTP request or response with PUT method to ICAP server for further processing.

trace

Forward HTTP request or response with TRACE method to ICAP server for further processing.

other

Forward HTTP request or response with All other methods to ICAP server for further processing.

name

ICAP profile name.

string

Maximum length: 35

preview

Enable/disable preview of data to ICAP server.

option

-

Option

Description

disable

Disable preview of data to ICAP server.

enable

Enable preview of data to ICAP server.

preview-data-length

Preview data length to be sent to ICAP server.

integer

Minimum value: 0 Maximum value: 4096

replacemsg-group

Replacement message group.

string

Maximum length: 35

request

Enable/disable whether an HTTP request is passed to an ICAP server.

option

-

Option

Description

disable

Disable HTTP request passing to ICAP server.

enable

Enable HTTP request passing to ICAP server.

request-failure

Action to take if the ICAP server cannot be contacted when processing an HTTP request.

option

-

Option

Description

error

Error.

bypass

Bypass.

request-path

Path component of the ICAP URI that identifies the HTTP request processing service.

string

Maximum length: 127

request-server

ICAP server to use for an HTTP request.

string

Maximum length: 35

response

Enable/disable whether an HTTP response is passed to an ICAP server.

option

-

Option

Description

disable

Disable HTTP response passing to ICAP server.

enable

Enable HTTP response passing to ICAP server.

response-failure

Action to take if the ICAP server cannot be contacted when processing an HTTP response.

option

-

Option

Description

error

Error.

bypass

Bypass.

response-path

Path component of the ICAP URI that identifies the HTTP response processing service.

string

Maximum length: 127

response-req-hdr

Enable/disable addition of req-hdr for ICAP response modification (respmod) processing.

option

-

Option

Description

disable

Do not add req-hdr for response modification (respmod) processing.

enable

Add req-hdr for response modification (respmod) processing.

response-server

ICAP server to use for an HTTP response.

string

Maximum length: 35

streaming-content-bypass

Enable/disable bypassing of ICAP server for streaming content.

option

-

Option

Description

disable

Disable bypassing of ICAP server for streaming content.

enable

Enable bypassing of ICAP server for streaming content.

config icap-headers

Parameter

Description

Type

Size

id

HTTP forwarded header ID.

integer

Minimum value: 0 Maximum value: 4294967295

name

HTTP forwarded header name.

string

Maximum length: 79

content

HTTP header content.

string

Maximum length: 255

base64-encoding

Enable/disable use of base64 encoding of HTTP content.

option

-

Option

Description

disable

Disable use of base64 encoding of HTTP content.

enable

Enable use of base64 encoding of HTTP content.