fmgr_icap_server – Configure ICAP servers.¶
New in version 2.10.
Synopsis¶
- This module is able to configure a FortiManager device.
- Examples include all parameters and values need to be adjusted to data sources before usage.
Requirements¶
The below requirements are needed on the host that executes this module.
- ansible>=2.9.0
FortiManager Version Compatibility¶
6.0.0 |
6.2.1 |
6.2.3 |
6.2.5 |
6.4.0 |
6.4.2 |
6.4.5 |
7.0.0 |
7.2.0 |
|
| icap_server | yes | yes | yes | yes | yes | yes | yes | yes | yes |
Parameters¶
- enable_log - Enable/Disable logging for task type: bool required: false default: False
- forticloud_access_token - Access token of forticloud managed API users, this option is available with FortiManager later than 6.4.0 type: str required: false
- proposed_method - The overridden method for the underlying Json RPC request type: str required: false choices: set, update, add
- bypass_validation - Only set to True when module schema diffs with FortiManager API structure, module continues to execute without validating parameters type: bool required: false default: False
- workspace_locking_adom - Acquire the workspace lock if FortiManager is running in workspace mode type: str required: false choices: global, custom adom including root
- workspace_locking_timeout - The maximum time in seconds to wait for other users to release workspace lock type: integer required: false default: 300
- rc_succeeded - The rc codes list with which the conditions to succeed will be overriden type: list required: false
- rc_failed - The rc codes list with which the conditions to fail will be overriden type: list required: false
- state - The directive to create, update or delete an object type: str required: true choices: present, absent
- adom - The parameter in requested url type: str required: true
- icap_server - no description type: dict
- ip-address - IPv4 address of the ICAP server. type: str more...
- ip-version - IP version. type: str choices: [4, 6] more...
- ip6-address - IPv6 address of the ICAP server. type: str more...
- max-connections - Maximum number of concurrent connections to ICAP server. type: int more...
- name - Server name. type: str more...
- port - ICAP server port. type: int more...
- secure - Enable/disable secure connection to ICAP server. type: str choices: [disable, enable] more...
- ssl-cert - CA certificate name. type: str more...
- addr-type - Address type of the remote ICAP server: IPv4, IPv6 or FQDN. type: str choices: [fqdn, ip4, ip6] more...
- fqdn - ICAP remote server Fully Qualified Domain Name (FQDN). type: str more...
- healthcheck - Enable/disable ICAP remote server health checking. type: str choices: [disable, enable] more...
- healthcheck-service - ICAP Service name to use for health checks. type: str more...
Notes¶
Note
- Running in workspace locking mode is supported in this FortiManager module, the top level parameters workspace_locking_adom and workspace_locking_timeout help do the work.
- To create or update an object, use state: present directive.
- To delete an object, use state: absent directive
- Normally, running one module can fail when a non-zero rc is returned. you can also override the conditions to fail or succeed with parameters rc_failed and rc_succeeded
Examples¶
- hosts: fortimanager-inventory
collections:
- fortinet.fortimanager
connection: httpapi
vars:
ansible_httpapi_use_ssl: True
ansible_httpapi_validate_certs: False
ansible_httpapi_port: 443
tasks:
- name: no description
fmgr_icap_server:
bypass_validation: False
workspace_locking_adom: <value in [global, custom adom including root]>
workspace_locking_timeout: 300
rc_succeeded: [0, -2, -3, ...]
rc_failed: [-2, -3, ...]
adom: <your own value>
state: <value in [present, absent]>
icap_server:
ip-address: <value of string>
ip-version: <value in [4, 6]>
ip6-address: <value of string>
max-connections: <value of integer>
name: <value of string>
port: <value of integer>
secure: <value in [disable, enable]>
ssl-cert: <value of string>
addr-type: <value in [fqdn, ip4, ip6]>
fqdn: <value of string>
healthcheck: <value in [disable, enable]>
healthcheck-service: <value of string>
Return Values¶
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:
- request_url - The full url requested returned: always type: str sample: /sys/login/user
- response_code - The status of api request returned: always type: int sample: 0
- response_message - The descriptive message of the api response returned: always type: str sample: OK
- response_data - The data body of the api response returned: optional type: list or dict