source: | fortios_icap_server.py |
---|---|
orphan: |
.. versionadded:: 2.0.0
- 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
The below requirements are needed on the host that executes this module.
- ansible>=2.14
Using member operation to add an element to an existing object.
Supported Version Ranges | |
fortios_icap_server | v6.0.0 -> latest |
- access_token - Token-based authentication. Generated from GUI of Fortigate. type: str required: false
- enable_log - Enable/Disable logging for task. type: bool required: false default: False
- vdom - 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. type: str default: root
- member_path - Member attribute path to operate on. type: str
- member_state - Add or delete a member under specified attribute path. type: str choices: present, absent
- state - Indicates whether to create or remove the object. type: str required: true choices: present, absent
- icap_server - Configure ICAP servers. type: dict
more...
Supported Version Ranges icap_server v6.0.0 -> latest
- addr_type - Address type of the remote ICAP server: IPv4, IPv6 or FQDN. type: str choices: ip4, ip6, fqdn
more...
Supported Version Ranges addr_type v7.2.0 -> latest
[ip4] v6.0.0 -> latest
[ip6] v6.0.0 -> latest
[fqdn] v6.0.0 -> latest
- fqdn - ICAP remote server Fully Qualified Domain Name (FQDN). type: str
more...
Supported Version Ranges fqdn v7.2.0 -> latest
- healthcheck - Enable/disable ICAP remote server health checking. Attempts to connect to the remote ICAP server to verify that the server is operating normally. type: str choices: disable, enable
more...
Supported Version Ranges healthcheck v7.2.0 -> latest
[disable] v6.0.0 -> latest
[enable] v6.0.0 -> latest
- healthcheck_service - ICAP Service name to use for health checks. type: str
more...
Supported Version Ranges healthcheck_service v7.2.0 -> latest
- ip_address - IPv4 address of the ICAP server. type: str
more...
Supported Version Ranges ip_address v6.0.0 -> latest
- ip_version - IP version. type: str choices: 4, 6
more...
Supported Version Ranges ip_version v6.0.0 -> v7.0.12
[4] v6.0.0 -> latest
[6] v6.0.0 -> latest
- ip6_address - IPv6 address of the ICAP server. type: str
more...
Supported Version Ranges ip6_address v6.0.0 -> latest
- max_connections - Maximum number of concurrent connections to ICAP server (unlimited = 0). Must not be less than wad-worker-count. type: int
more...
Supported Version Ranges max_connections v6.0.0 -> latest
- name - Server name. type: str required: true
more...
Supported Version Ranges name v6.0.0 -> latest
- port - ICAP server port. type: int
more...
Supported Version Ranges port v6.0.0 -> latest
- secure - Enable/disable secure connection to ICAP server. type: str choices: disable, enable
more...
Supported Version Ranges secure v7.0.0 -> latest
[disable] v6.0.0 -> latest
[enable] v6.0.0 -> latest
- ssl_cert - CA certificate name. Source certificate.ca.name. type: str
more...
Supported Version Ranges ssl_cert v7.0.0 -> latest
Note
- Legacy fortiosapi has been deprecated, httpapi is the preferred way to run playbooks
- 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)"
Common return values are documented: https://docs.ansible.com/ansible/latest/reference_appendices/common_return_values.html#common-return-values, the following are the fields unique to this module:
- build - Build number of the fortigate image returned: always type: str sample: 1547
- http_method - Last method used to provision the content into FortiGate returned: always type: str sample: PUT
- http_status - Last result given by FortiGate on last operation applied returned: always type: str sample: 200
- mkey - Master key (id) used in the last call to FortiGate returned: success type: str sample: id
- name - Name of the table used to fulfill the request returned: always type: str sample: urlfilter
- path - Path of the table used to fulfill the request returned: always type: str sample: webfilter
- revision - Internal revision number returned: always type: str sample: 17.0.2.10658
- serial - Serial number of the unit returned: always type: str sample: FGVMEVYYQT3AB5352
- status - Indication of the operation's result returned: always type: str sample: success
- vdom - Virtual domain used returned: always type: str sample: root
- version - Version of the FortiGate returned: always type: str sample: v5.6.3
- This module is not guaranteed to have a backwards compatible interface.
- Link Zheng (@chillancezen)
- Jie Xue (@JieX19)
- Hongbin Lu (@fgtdev-hblu)
- Frank Shen (@frankshen01)
- Miguel Angel Munoz (@mamunozgonzalez)
- Nicolas Thomas (@thomnico)
Hint
If you notice any issues in this documentation, you can create a pull request to improve it.