fmgr_antivirus_profile_pop3 – Configure POP3 AntiVirus options.¶
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 |
|
| antivirus_profile_pop3 | 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
- adom - The parameter in requested url type: str required: true
- profile - The parameter in requested url type: str required: true
- antivirus_profile_pop3 - no description type: dict
- archive-block - No description for the parameter type: array choices: [encrypted, corrupted, multipart, nested, mailbomb, unhandled, partiallycorrupted, fileslimit, timeout] more...
- archive-log - No description for the parameter type: array choices: [encrypted, corrupted, multipart, nested, mailbomb, unhandled, partiallycorrupted, fileslimit, timeout] more...
- content-disarm - Enable Content Disarm and Reconstruction for this protocol. type: str choices: [disable, enable] more...
- emulator - Enable/disable the virus emulator. type: str choices: [disable, enable] more...
- executables - Treat Windows executable files as viruses for the purpose of blocking or monitoring. type: str choices: [default, virus] more...
- options - No description for the parameter type: array choices: [scan, file-filter, quarantine, avquery, avmonitor] more...
- outbreak-prevention - Enable FortiGuard Virus Outbreak Prevention service. type: str choices: [disabled, files, full-archive, disable, block, monitor] more...
- av-scan - Enable AntiVirus scan service. type: str choices: [disable, monitor, block] more...
- external-blocklist - Enable external-blocklist. type: str choices: [disable, monitor, block] more...
- quarantine - Enable/disable quarantine for infected files. type: str choices: [disable, enable] more...
- fortindr - Enable scanning of files by FortiNDR. type: str choices: [disable, block, monitor] more...
- fortisandbox - Enable scanning of files by FortiSandbox. type: str choices: [disable, block, monitor] 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_antivirus_profile_pop3:
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>
profile: <your own value>
antivirus_profile_pop3:
archive-block:
- encrypted
- corrupted
- multipart
- nested
- mailbomb
- unhandled
- partiallycorrupted
- fileslimit
- timeout
archive-log:
- encrypted
- corrupted
- multipart
- nested
- mailbomb
- unhandled
- partiallycorrupted
- fileslimit
- timeout
content-disarm: <value in [disable, enable]>
emulator: <value in [disable, enable]>
executables: <value in [default, virus]>
options:
- scan
- file-filter
- quarantine
- avquery
- avmonitor
outbreak-prevention: <value in [disabled, files, full-archive, ...]>
av-scan: <value in [disable, monitor, block]>
external-blocklist: <value in [disable, monitor, block]>
quarantine: <value in [disable, enable]>
fortindr: <value in [disable, block, monitor]>
fortisandbox: <value in [disable, block, monitor]>
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