Fortinet Document Library

Version:


Table of Contents

CLI Reference

6.2.1
Copy Link

Configure ICAP profiles.

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

config icap profile

Parameter Name Description Type Size
replacemsg-group Replacement message group. string Maximum length: 35
request Enable/disable whether an HTTP request is passed to an ICAP server.
disable: Disable HTTP request passing to ICAP server.
enable: Enable HTTP request passing to ICAP server.
option -
response Enable/disable whether an HTTP response is passed to an ICAP server.
disable: Disable HTTP response passing to ICAP server.
enable: Enable HTTP response passing to ICAP server.
option -
streaming-content-bypass Enable/disable bypassing of ICAP server for streaming content.
disable: Disable bypassing of ICAP server for streaming content.
enable: Enable bypassing of ICAP server for streaming content.
option -
preview Enable/disable preview of data to ICAP server.
disable: Disable preview of data to ICAP server.
enable: Enable preview of data to ICAP server.
option -
preview-data-length Preview data length to be sent to ICAP server. integer Minimum value: 0 Maximum value: 4096
request-server ICAP server to use for an HTTP request. string Maximum length: 35
response-server ICAP server to use for an HTTP response. string Maximum length: 35
request-failure Action to take if the ICAP server cannot be contacted when processing an HTTP request.
error: Error.
bypass: Bypass.
option -
response-failure Action to take if the ICAP server cannot be contacted when processing an HTTP response.
error: Error.
bypass: Bypass.
option -
request-path Path component of the ICAP URI that identifies the HTTP request processing service. string Maximum length: 127
response-path Path component of the ICAP URI that identifies the HTTP response processing service. string Maximum length: 127
methods The allowed HTTP methods that will be sent to ICAP server for further processing.
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.
option -
response-req-hdr Enable/disable addition of req-hdr for ICAP response modification (respmod) processing.
disable: Do not add req-hdr for response modification (respmod) processing.
enable: Add req-hdr for response modification (respmod) processing.
option -

config icap-headers

Parameter Name Description Type Size
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.
disable: Disable use of base64 encoding of HTTP content.
enable: Enable use of base64 encoding of HTTP content.
option -

Configure ICAP profiles.

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

config icap profile

Parameter Name Description Type Size
replacemsg-group Replacement message group. string Maximum length: 35
request Enable/disable whether an HTTP request is passed to an ICAP server.
disable: Disable HTTP request passing to ICAP server.
enable: Enable HTTP request passing to ICAP server.
option -
response Enable/disable whether an HTTP response is passed to an ICAP server.
disable: Disable HTTP response passing to ICAP server.
enable: Enable HTTP response passing to ICAP server.
option -
streaming-content-bypass Enable/disable bypassing of ICAP server for streaming content.
disable: Disable bypassing of ICAP server for streaming content.
enable: Enable bypassing of ICAP server for streaming content.
option -
preview Enable/disable preview of data to ICAP server.
disable: Disable preview of data to ICAP server.
enable: Enable preview of data to ICAP server.
option -
preview-data-length Preview data length to be sent to ICAP server. integer Minimum value: 0 Maximum value: 4096
request-server ICAP server to use for an HTTP request. string Maximum length: 35
response-server ICAP server to use for an HTTP response. string Maximum length: 35
request-failure Action to take if the ICAP server cannot be contacted when processing an HTTP request.
error: Error.
bypass: Bypass.
option -
response-failure Action to take if the ICAP server cannot be contacted when processing an HTTP response.
error: Error.
bypass: Bypass.
option -
request-path Path component of the ICAP URI that identifies the HTTP request processing service. string Maximum length: 127
response-path Path component of the ICAP URI that identifies the HTTP response processing service. string Maximum length: 127
methods The allowed HTTP methods that will be sent to ICAP server for further processing.
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.
option -
response-req-hdr Enable/disable addition of req-hdr for ICAP response modification (respmod) processing.
disable: Do not add req-hdr for response modification (respmod) processing.
enable: Add req-hdr for response modification (respmod) processing.
option -

config icap-headers

Parameter Name Description Type Size
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.
disable: Disable use of base64 encoding of HTTP content.
enable: Enable use of base64 encoding of HTTP content.
option -