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.2).
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 | Choices/Defaults | Comments | |||
---|---|---|---|---|---|
access_token string | Token-based authentication. Generated from GUI of Fortigate. | ||||
enable_log boolean |
| Enable/Disable logging for task. | |||
icap_profile dictionary | Configure ICAP profiles. | ||||
icap_headers list / elements=string | Configure ICAP forwarded request headers. | ||||
base64_encoding string |
| Enable/disable use of base64 encoding of HTTP content. | |||
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. | |||
name string / required | ICAP profile name. | ||||
preview string |
| Enable/disable preview of data to ICAP server. | |||
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. | |||
request_failure string |
| Action to take if the ICAP server cannot be contacted when processing an HTTP request. | |||
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. | |||
respmod_forward_rules list / elements=string | ICAP response mode forward rules. | ||||
action string |
| Action to be taken for ICAP server. | |||
header_group list / elements=string | HTTP header group. | ||||
case_sensitivity string |
| Enable/disable case sensitivity when matching header. | |||
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. | |||
response_failure string |
| Action to take if the ICAP server cannot be contacted when processing an HTTP response. | |||
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. | |||
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. | |||
state string / required |
| Indicates whether to create or remove the object. | |||
vdom string | Default: "root" | 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. |
Notes
Note
- Legacy fortiosapi has been deprecated, httpapi is the preferred way to run playbooks
Examples
- hosts: fortigates collections: - fortinet.fortios connection: httpapi vars: vdom: "root" ansible_httpapi_use_ssl: yes ansible_httpapi_validate_certs: no ansible_httpapi_port: 443 tasks: - name: Configure ICAP profiles. fortios_icap_profile: vdom: "{{ vdom }}" state: "present" access_token: "<your_own_value>" icap_profile: icap_headers: - base64_encoding: "disable" content: "<your_own_value>" id: "6" name: "default_name_7" methods: "delete" name: "default_name_9" preview: "disable" preview_data_length: "11" 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)" respmod_default_action: "forward" respmod_forward_rules: - action: "forward" header_group: - case_sensitivity: "disable" header: "<your_own_value>" header_name: "<your_own_value>" id: "24" host: "myhostname (source firewall.address.name firewall.addrgrp.name firewall.proxy-address.name)" http_resp_status_code: - code: "27" name: "default_name_28" response: "disable" response_failure: "error" response_path: "<your_own_value>" response_req_hdr: "disable" response_server: "<your_own_value> (source icap.server.name)" streaming_content_bypass: "disable"
Return Values
Common return values are documented here, the following are the fields unique to this module:
Key | Returned | Description |
---|---|---|
build string | always | Build number of the fortigate image Sample: 1547 |
http_method string | always | Last method used to provision the content into FortiGate Sample: PUT |
http_status string | always | Last result given by FortiGate on last operation applied Sample: 200 |
mkey string | success | Master key (id) used in the last call to FortiGate Sample: id |
name string | always | Name of the table used to fulfill the request Sample: urlfilter |
path string | always | Path of the table used to fulfill the request Sample: webfilter |
revision string | always | Internal revision number Sample: 17.0.2.10658 |
serial string | always | Serial number of the unit Sample: FGVMEVYYQT3AB5352 |
status string | always | Indication of the operation's result Sample: success |
vdom string | always | Virtual domain used Sample: root |
version string | always | Version of the FortiGate 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)
© 2012–2018 Michael DeHaan
© 2018–2021 Red Hat, Inc.
Licensed under the GNU General Public License version 3.
https://docs.ansible.com/ansible/latest/collections/fortinet/fortios/fortios_icap_profile_module.html