You are reading an unmaintained version of the Ansible documentation. Unmaintained Ansible versions can contain unfixed security vulnerabilities (CVE). Please upgrade to a maintained version. See the latest Ansible documentation.

fortinet.fortios.fortios_icap_profile – Configure ICAP profiles in Fortinet’s FortiOS and FortiGate.

Note

This plugin is part of the fortinet.fortios collection (version 2.1.3).

You might already have this collection installed if you are using the ansible package. It is not included in ansible-core. To check whether it is installed, run ansible-galaxy collection list.

To install it, use: ansible-galaxy collection install fortinet.fortios.

To use it in a playbook, specify: fortinet.fortios.fortios_icap_profile.

New in version 2.10: of fortinet.fortios

Synopsis

• This module is able to configure a FortiGate or FortiOS (FOS) device by allowing the user to set and modify icap feature and profile category. Examples include all parameters and values need to be adjusted to datasources before usage. Tested with FOS v6.0.0

Requirements

The below requirements are needed on the host that executes this module.

• ansible>=2.9.0

Parameters

Parameter	Comments
access_token string	Token-based authentication. Generated from GUI of Fortigate.
enable_log boolean	Enable/Disable logging for task. Choices: no ← (default) yes
icap_profile dictionary	Configure ICAP profiles.
icap_block_log string	Enable/disable UTM log when infection found . Choices: disable enable
icap_headers list / elements=string	Configure ICAP forwarded request headers.
base64_encoding string	Enable/disable use of base64 encoding of HTTP content. Choices: disable enable
content string	HTTP header content.
id integer / required	HTTP forwarded header ID.
name string	HTTP forwarded header name.
methods list / elements=string	The allowed HTTP methods that will be sent to ICAP server for further processing. Choices: delete get head options post put trace other
name string / required	ICAP profile name.
preview string	Enable/disable preview of data to ICAP server. Choices: disable enable
preview_data_length integer	Preview data length to be sent to ICAP server.
replacemsg_group string	Replacement message group. Source system.replacemsg-group.name.
request string	Enable/disable whether an HTTP request is passed to an ICAP server. Choices: disable enable
request_failure string	Action to take if the ICAP server cannot be contacted when processing an HTTP request. Choices: error bypass
request_path string	Path component of the ICAP URI that identifies the HTTP request processing service.
request_server string	ICAP server to use for an HTTP request. Source icap.server.name.
respmod_default_action string	Default action to ICAP response modification (respmod) processing. Choices: forward bypass
respmod_forward_rules list / elements=string	ICAP response mode forward rules.
action string	Action to be taken for ICAP server. Choices: forward bypass
header_group list / elements=string	HTTP header group.
case_sensitivity string	Enable/disable case sensitivity when matching header. Choices: disable enable
header string	HTTP header regular expression.
header_name string	HTTP header.
id integer / required	ID.
host string	Address object for the host. Source firewall.address.name firewall.addrgrp.name firewall.proxy-address.name.
http_resp_status_code integer	HTTP response status code.
code integer / required	HTTP response status code.
name string / required	Address name.
response string	Enable/disable whether an HTTP response is passed to an ICAP server. Choices: disable enable
response_failure string	Action to take if the ICAP server cannot be contacted when processing an HTTP response. Choices: error bypass
response_path string	Path component of the ICAP URI that identifies the HTTP response processing service.
response_req_hdr string	Enable/disable addition of req-hdr for ICAP response modification (respmod) processing. Choices: disable enable
response_server string	ICAP server to use for an HTTP response. Source icap.server.name.
streaming_content_bypass string	Enable/disable bypassing of ICAP server for streaming content. Choices: disable enable
member_path string	Member attribute path to operate on. Delimited by a slash character if there are more than one attribute. Parameter marked with member_path is legitimate for doing member operation.
member_state string	Add or delete a member under specified attribute path. When member_state is specified, the state option is ignored. Choices: present absent
state string / required	Indicates whether to create or remove the object. Choices: present absent
vdom string	Virtual domain, among those defined previously. A vdom is a virtual instance of the FortiGate that can be configured and used as a different unit. Default: “root”

Notes

Note

• Legacy fortiosapi has been deprecated, httpapi is the preferred way to run playbooks

Examples

- collections:
  - fortinet.fortios
  connection: httpapi
  hosts: fortigate01
  vars:
    ansible_httpapi_port: 443
    ansible_httpapi_use_ssl: true
    ansible_httpapi_validate_certs: false
    vdom: root
  tasks:
  - name: fortios_icap_profile
    fortios_icap_profile:
      vdom: root
      state: present
      icap_profile:
        icap_headers:
        - base64_encoding: disable
          content: $user
          id: 1
          name: X-Authenticated-User
        methods: delete
        name: '1'
        preview: disable
        preview_data_length: 0
        request: disable
        request_failure: error
        respmod_default_action: forward
        response: disable
        response_failure: error
        response_req_hdr: disable
        streaming_content_bypass: disable

Return Values

Common return values are documented here, the following are the fields unique to this module:

Key	Description
build string	Build number of the fortigate image Returned: always Sample: “1547”
http_method string	Last method used to provision the content into FortiGate Returned: always Sample: “PUT”
http_status string	Last result given by FortiGate on last operation applied Returned: always Sample: “200”
mkey string	Master key (id) used in the last call to FortiGate Returned: success Sample: “id”
name string	Name of the table used to fulfill the request Returned: always Sample: “urlfilter”
path string	Path of the table used to fulfill the request Returned: always Sample: “webfilter”
revision string	Internal revision number Returned: always Sample: “17.0.2.10658”
serial string	Serial number of the unit Returned: always Sample: “FGVMEVYYQT3AB5352”
status string	Indication of the operation’s result Returned: always Sample: “success”
vdom string	Virtual domain used Returned: always Sample: “root”
version string	Version of the FortiGate Returned: always Sample: “v5.6.3”

Authors

• Link Zheng (@chillancezen)

• Jie Xue (@JieX19)

• Hongbin Lu (@fgtdev-hblu)

• Frank Shen (@frankshen01)

• Miguel Angel Munoz (@mamunozgonzalez)

• Nicolas Thomas (@thomnico)