fmgr_icap_profile – Configure ICAP profiles.
Added in version 2.0.0.
Warning
Starting in version 3.0.0, all input arguments will be named using the underscore naming convention (snake_case).
Argument name before 3.0.0:
var-name,var name,var.nameNew argument name starting in 3.0.0:
var_name
FortiManager Ansible v2.4+ supports both previous argument name and new underscore name. You will receive deprecation warnings if you keep using the previous argument name. You can ignore the warning by setting deprecation_warnings=False in ansible.cfg.
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.
Tested with FortiManager v6.x and v7.x.
Requirements
The below requirements are needed on the host that executes this module.
ansible>=2.15.0
FortiManager Version Compatibility
Supported Version Ranges: v6.0.0 -> latest
Parameters
- access_token -The token to access FortiManager without using username and password. type: str required: false
- 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
- 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
- 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
- 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
- adom - The parameter in requested url type: str required: true
- icap_profile - Configure ICAP profiles. type: dict
- methods The allowed http methods that will be sent to icap server for further processing. type: list choices: [delete, get, head, options, post, put, trace, other, connect] more...
- name Icap profile name. type: str more...
- replacemsg_group (Alias name: replacemsg-group) Replacement message group. type: str more...
- request Enable/disable whether an http request is passed to an icap server. type: str choices: [disable, enable] more...
- request_failure (Alias name: request-failure) Action to take if the icap server cannot be contacted when processing an http request. type: str choices: [error, bypass] more...
- request_path (Alias name: request-path) Path component of the icap uri that identifies the http request processing service. type: str more...
- request_server (Alias name: request-server) Icap server to use for an http request. type: str more...
- response Enable/disable whether an http response is passed to an icap server. type: str choices: [disable, enable] more...
- response_failure (Alias name: response-failure) Action to take if the icap server cannot be contacted when processing an http response. type: str choices: [error, bypass] more...
- response_path (Alias name: response-path) Path component of the icap uri that identifies the http response processing service. type: str more...
- response_server (Alias name: response-server) Icap server to use for an http response. type: str more...
- streaming_content_bypass (Alias name: streaming-content-bypass) Enable/disable bypassing of icap server for streaming content. type: str choices: [disable, enable] more...
- icap_headers (Alias name: icap-headers) Icap-headers. type: list more...
- preview Enable/disable preview of data to icap server. type: str choices: [disable, enable] more...
- preview_data_length (Alias name: preview-data-length) Preview data length to be sent to icap server. type: int more...
- response_req_hdr (Alias name: response-req-hdr) Enable/disable addition of req-hdr for icap response modification (respmod) processing. type: str choices: [disable, enable] more...
- respmod_default_action (Alias name: respmod-default-action) Default action to icap response modification (respmod) processing. type: str choices: [bypass, forward] more...
- respmod_forward_rules (Alias name: respmod-forward-rules) Respmod-forward-rules. type: list
more...
- action Action to be taken for icap server. type: str choices: [bypass, forward] more...
- header_group (Alias name: header-group) Header-group. type: list more...
- host Address object for the host. type: str more...
- http_resp_status_code (Alias name: http-resp-status-code) Http response status code. type: list more...
- name Address name. type: str more...
- 204_response (Alias name: 204-response) Enable/disable allowance of 204 response from icap server. type: str choices: [disable, enable] more...
- 204_size_limit (Alias name: 204-size-limit) 204 response size limit to be saved by icap client in megabytes (1 - 10, default = 1 mb). type: int more...
- chunk_encap (Alias name: chunk-encap) Enable/disable chunked encapsulation (default = disable). type: str choices: [disable, enable] more...
- extension_feature (Alias name: extension-feature) type: list choices: [scan-progress] more...
- file_transfer (Alias name: file-transfer) type: list choices: [ssh, ftp] more...
- file_transfer_failure (Alias name: file-transfer-failure) Action to take if the icap server cannot be contacted when processing a file transfer. type: str choices: [error, bypass] more...
- file_transfer_path (Alias name: file-transfer-path) Path component of the icap uri that identifies the file transfer processing service. type: str more...
- file_transfer_server (Alias name: file-transfer-server) Icap server to use for a file transfer. type: str more...
- icap_block_log (Alias name: icap-block-log) Enable/disable utm log when infection found (default = disable). type: str choices: [disable, enable] more...
- scan_progress_interval (Alias name: scan-progress-interval) Scan progress interval value. type: int more...
- timeout Time (in seconds) that icap client waits for the response from icap server. type: int more...
- comment Comment. 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
- name: Example playbook (generated based on argument schema)
hosts: fortimanagers
connection: httpapi
vars:
ansible_httpapi_use_ssl: true
ansible_httpapi_validate_certs: false
ansible_httpapi_port: 443
tasks:
- name: Configure ICAP profiles.
fortinet.fortimanager.fmgr_icap_profile:
# 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: present # <value in [present, absent]>
icap_profile:
methods:
- delete
- get
- head
- options
- post
- put
- trace
- other
- connect
name: <string>
replacemsg_group: <string>
request: <value in [disable, enable]>
request_failure: <value in [error, bypass]>
request_path: <string>
request_server: <string>
response: <value in [disable, enable]>
response_failure: <value in [error, bypass]>
response_path: <string>
response_server: <string>
streaming_content_bypass: <value in [disable, enable]>
icap_headers:
-
base64_encoding: <value in [disable, enable]>
content: <string>
id: <integer>
name: <string>
preview: <value in [disable, enable]>
preview_data_length: <integer>
response_req_hdr: <value in [disable, enable]>
respmod_default_action: <value in [bypass, forward]>
respmod_forward_rules:
-
action: <value in [bypass, forward]>
header_group:
-
case_sensitivity: <value in [disable, enable]>
header: <string>
header_name: <string>
id: <integer>
host: <string>
http_resp_status_code: <list or integer>
name: <string>
204_response: <value in [disable, enable]>
204_size_limit: <integer>
chunk_encap: <value in [disable, enable]>
extension_feature:
- scan-progress
file_transfer:
- ssh
- ftp
file_transfer_failure: <value in [error, bypass]>
file_transfer_path: <string>
file_transfer_server: <string>
icap_block_log: <value in [disable, enable]>
scan_progress_interval: <integer>
timeout: <integer>
comment: <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:
- meta - The result of the request.returned: always type: dict
- 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_data - The data body of the api response. returned: optional type: list or dict
- response_message - The descriptive message of the api response. returned: always type: str sample: OK
- system_information - The information of the target system. returned: always type: dict
- rc - The status the request. returned: always type: int sample: 0
- version_check_warning - Warning if the parameters used in the playbook are not supported by the current FortiManager version. returned: if at least one parameter not supported by the current FortiManager version type: list
Status
This module is not guaranteed to have a backwards compatible interface.