fortinet.fortios.fortios_icap_server module – Configure ICAP servers in Fortinet’s FortiOS and FortiGate.
Note
This module is part of the fortinet.fortios collection (version 2.3.8).
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_server
.
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 server 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 servers. |
|
Address type of the remote ICAP server: IPv4, IPv6 or FQDN. Choices:
|
|
ICAP remote server Fully Qualified Domain Name (FQDN). |
|
Enable/disable ICAP remote server health checking. Attempts to connect to the remote ICAP server to verify that the server is operating normally. Choices:
|
|
ICAP Service name to use for health checks. |
|
IPv6 address of the ICAP server. |
|
IPv4 address of the ICAP server. |
|
IP version. Choices:
|
|
Maximum number of concurrent connections to ICAP server (unlimited = 0). Must not be less than wad-worker-count. |
|
Server name. |
|
ICAP server port. |
|
Enable/disable secure connection to ICAP server. Choices:
|
|
CA certificate name. Source certificate.ca.name. |
|
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 servers.
fortinet.fortios.fortios_icap_server:
vdom: "{{ vdom }}"
state: "present"
access_token: "<your_own_value>"
icap_server:
addr_type: "ip4"
fqdn: "<your_own_value>"
healthcheck: "disable"
healthcheck_service: "<your_own_value>"
ip_address: "<your_own_value>"
ip_version: "4"
ip6_address: "<your_own_value>"
max_connections: "100"
name: "default_name_11"
port: "1344"
secure: "disable"
ssl_cert: "<your_own_value> (source certificate.ca.name)"
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: |