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

New in version 2.8.

Synopsis
Requirements
Parameters
Notes
Examples
Return Values
Status

Synopsis

This module is able to configure a FortiGate or FortiOS by allowing the user to configure icap feature and profile category. Examples includes all options and need to be adjusted to datasources before usage. Tested with FOS v6.0.2

Requirements

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

fortiosapi>=0.9.8

Parameters

Parameter		Choices/Defaults	Comments
host - / required			FortiOS or FortiGate ip adress.
https boolean		no yes ←	Indicates if the requests towards FortiGate must use HTTPS protocol
icap_profile -		Default: null	Configure ICAP profiles.
	methods -	delete get head options post put trace other	The allowed HTTP methods that will be sent to ICAP server for further processing.
	name - / required		ICAP profile name.
	replacemsg-group -		Replacement message group. Source system.replacemsg-group.name.
	request -	disable enable	Enable/disable whether an HTTP request is passed to an ICAP server.
	request-failure -	error bypass	Action to take if the ICAP server cannot be contacted when processing an HTTP request.
	request-path -		Path component of the ICAP URI that identifies the HTTP request processing service.
	request-server -		ICAP server to use for an HTTP request. Source icap.server.name.
	response -	disable enable	Enable/disable whether an HTTP response is passed to an ICAP server.
	response-failure -	error bypass	Action to take if the ICAP server cannot be contacted when processing an HTTP response.
	response-path -		Path component of the ICAP URI that identifies the HTTP response processing service.
	response-server -		ICAP server to use for an HTTP response. Source icap.server.name.
	state -	present absent	Indicates whether to create or remove the object
	streaming-content-bypass -	disable enable	Enable/disable bypassing of ICAP server for streaming content.
password -		Default: ""	FortiOS or FortiGate password.
username - / required			FortiOS or FortiGate username.
vdom -		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

Requires fortiosapi library developed by Fortinet
Run as a local_action in your playbook

Examples

- hosts: localhost
  vars:
   host: "192.168.122.40"
   username: "admin"
   password: ""
   vdom: "root"
  tasks:
  - name: Configure ICAP profiles.
    fortios_icap_profile:
      host:  "{{ host }}"
      username: "{{ username }}"
      password: "{{ password }}"
      vdom:  "{{ vdom }}"
      https: "False"
      icap_profile:
        state: "present"
        methods: "delete"
        name: "default_name_4"
        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)"
        response: "disable"
        response-failure: "error"
        response-path: "<your_own_value>"
        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

Status

This module is not guaranteed to have a backwards compatible interface. [preview]
This module is maintained by the Ansible Community. [community]

Authors

Miguel Angel Munoz (@mamunozgonzalez)
Nicolas Thomas (@thomnico)

Hint

If you notice any issues in this documentation you can edit this document to improve it.

© 2012–2018 Michael DeHaan
© 2018–2019 Red Hat, Inc.
Licensed under the GNU General Public License version 3.
https://docs.ansible.com/ansible/2.8/modules/fortios_icap_profile_module.html