fortinet.fortios.fortios_icap_profile module – Configure ICAP profiles in Fortinet’s FortiOS and FortiGate.
Note
This module is part of the fortinet.fortios collection (version 2.3.7).
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
.
You need further requirements to be able to use this module,
see Requirements for details.
To use it in a playbook, specify: fortinet.fortios.fortios_icap_profile
.
New in fortinet.fortios 2.0.0
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.15
Parameters
Parameter |
Comments |
---|---|
Token-based authentication. Generated from GUI of Fortigate. |
|
Enable/Disable logging for task. Choices:
|
|
Configure ICAP profiles. |
|
Enable/disable chunked encapsulation . Choices:
|
|
Comment. |
|
Enable/disable ICAP extension features. Choices:
|
|
Configure the file transfer protocols to pass transferred files to an ICAP server as REQMOD. Choices:
|
|
Action to take if the ICAP server cannot be contacted when processing a file transfer. Choices:
|
|
Path component of the ICAP URI that identifies the file transfer processing service. |
|
ICAP server to use for a file transfer. Source icap.server.name icap.server-group.name. |
|
Enable/disable UTM log when infection found . Choices:
|
|
Configure ICAP forwarded request headers. |
|
Enable/disable use of base64 encoding of HTTP content. Choices:
|
|
HTTP header content. |
|
HTTP forwarded header ID. see <a href=’#notes’>Notes</a>. |
|
HTTP forwarded header name. |
|
The allowed HTTP methods that will be sent to ICAP server for further processing. Choices:
|
|
ICAP profile name. |
|
Enable/disable preview of data to ICAP server. Choices:
|
|
Preview data length to be sent to ICAP server. |
|
Replacement message group. Source system.replacemsg-group.name. |
|
Enable/disable whether an HTTP request is passed to an ICAP server. Choices:
|
|
Action to take if the ICAP server cannot be contacted when processing an HTTP request. Choices:
|
|
Path component of the ICAP URI that identifies the HTTP request processing service. |
|
ICAP server to use for an HTTP request. Source icap.server.name icap.server-group.name. |
|
Default action to ICAP response modification (respmod) processing. Choices:
|
|
ICAP response mode forward rules. |
|
Action to be taken for ICAP server. Choices:
|
|
HTTP header group. |
|
Enable/disable case sensitivity when matching header. Choices:
|
|
HTTP header regular expression. |
|
HTTP header. |
|
ID. see <a href=’#notes’>Notes</a>. |
|
Address object for the host. Source firewall.address.name firewall.addrgrp.name firewall.proxy-address.name. |
|
HTTP response status code. |
|
HTTP response status code. see <a href=’#notes’>Notes</a>. |
|
Address name. |
|
Enable/disable whether an HTTP response is passed to an ICAP server. Choices:
|
|
Enable/disable allowance of 204 response from ICAP server. Choices:
|
|
Action to take if the ICAP server cannot be contacted when processing an HTTP response. Choices:
|
|
Path component of the ICAP URI that identifies the HTTP response processing service. |
|
Enable/disable addition of req-hdr for ICAP response modification (respmod) processing. Choices:
|
|
ICAP server to use for an HTTP response. Source icap.server.name icap.server-group.name. |
|
Scan progress interval value. |
|
204 response size limit to be saved by ICAP client in megabytes (1 - 10). |
|
Enable/disable bypassing of ICAP server for streaming content. Choices:
|
|
Time (in seconds) that ICAP client waits for the response from ICAP server. |
|
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. |
|
Add or delete a member under specified attribute path. When member_state is specified, the state option is ignored. Choices:
|
|
Indicates whether to create or remove the object. Choices:
|
|
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: |
Notes
Note
Legacy fortiosapi has been deprecated, httpapi is the preferred way to run playbooks
The module supports check_mode.
Examples
- name: Configure ICAP profiles.
fortinet.fortios.fortios_icap_profile:
vdom: "{{ vdom }}"
state: "present"
access_token: "<your_own_value>"
icap_profile:
response_204: "disable"
size_limit_204: "1"
chunk_encap: "disable"
comment: "Comment."
extension_feature: "scan-progress"
file_transfer: "ssh"
file_transfer_failure: "error"
file_transfer_path: "<your_own_value>"
file_transfer_server: "<your_own_value> (source icap.server.name icap.server-group.name)"
icap_block_log: "disable"
icap_headers:
-
base64_encoding: "disable"
content: "<your_own_value>"
id: "16"
name: "default_name_17"
methods: "delete"
name: "default_name_19"
preview: "disable"
preview_data_length: "0"
replacemsg_group: "<your_own_value> (source system.replacemsg-group.name)"
request: "disable"
request_failure: "error"
request_path: "<your_own_value>"
request_server: "<your_own_value> (source icap.server.name icap.server-group.name)"
respmod_default_action: "forward"
respmod_forward_rules:
-
action: "forward"
header_group:
-
case_sensitivity: "disable"
header: "<your_own_value>"
header_name: "<your_own_value>"
id: "34"
host: "myhostname (source firewall.address.name firewall.addrgrp.name firewall.proxy-address.name)"
http_resp_status_code:
-
code: "<you_own_value>"
name: "default_name_38"
response: "disable"
response_failure: "error"
response_path: "<your_own_value>"
response_req_hdr: "disable"
response_server: "<your_own_value> (source icap.server.name icap.server-group.name)"
scan_progress_interval: "10"
streaming_content_bypass: "disable"
timeout: "30"
Return Values
Common return values are documented here, the following are the fields unique to this module:
Key |
Description |
---|---|
Build number of the fortigate image Returned: always Sample: |
|
Last method used to provision the content into FortiGate Returned: always Sample: |
|
Last result given by FortiGate on last operation applied Returned: always Sample: |
|
Master key (id) used in the last call to FortiGate Returned: success Sample: |
|
Name of the table used to fulfill the request Returned: always Sample: |
|
Path of the table used to fulfill the request Returned: always Sample: |
|
Internal revision number Returned: always Sample: |
|
Serial number of the unit Returned: always Sample: |
|
Indication of the operation’s result Returned: always Sample: |
|
Virtual domain used Returned: always Sample: |
|
Version of the FortiGate Returned: always Sample: |