fmgr_filefilter_profile – Configure file-filter profiles.¶
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
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
- filefilter_profile - no description type: dict
- comment - Comment. type: str more...
- extended-log - Enable/disable file-filter extended logging. type: str choices: [disable, enable] more...
- feature-set - Flow/proxy feature set. type: str choices: [proxy, flow] more...
- log - Enable/disable file-filter logging. type: str choices: [disable, enable] more...
- name - Profile name. type: str more...
- replacemsg-group - Replacement message group type: str more...
- rules - Rules. type: array
more...
- action - Action taken for matched file. type: str choices: [log-only, block] more...
- comment - Comment. type: str more...
- direction - Traffic direction. type: str choices: [any, incoming, outgoing] more...
- file-type - Select file type. type: str more...
- name - File-filter rule name. type: str more...
- password-protected - Match password-protected files. type: str choices: [any, yes] more...
- protocol - Protocols to apply rule to. type: array choices: [imap, smtp, pop3, http, ftp, mapi, cifs, ssh] more...
- scan-archive-contents - Enable/disable archive contents scan. type: str choices: [disable, enable] 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_filefilter_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: <value in [present, absent]>
filefilter_profile:
comment: <value of string>
extended-log: <value in [disable, enable]>
feature-set: <value in [proxy, flow]>
log: <value in [disable, enable]>
name: <value of string>
replacemsg-group: <value of string>
rules:
-
action: <value in [log-only, block]>
comment: <value of string>
direction: <value in [any, incoming, outgoing]>
file-type: <value of string>
name: <value of string>
password-protected: <value in [any, yes]>
protocol:
- imap
- smtp
- pop3
- http
- ftp
- mapi
- cifs
- ssh
scan-archive-contents: <value in [disable, enable]>
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