fmgr_antivirus_profile – Configure AntiVirus 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.
- Tested with FortiManager v6.0.0.
Requirements¶
The below requirements are needed on the host that executes this module.
- ansible>=2.9.0
Parameters¶
- 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
- antivirus_profile - Configure AntiVirus profiles. type: dict
- analytics-bl-filetype - Only submit files matching this DLP file-pattern to FortiSandbox. type: str
- analytics-db - Enable/disable using the FortiSandbox signature database to supplement the AV signature databases. type: str choices: [disable, enable]
- analytics-max-upload - Maximum size of files that can be uploaded to FortiSandbox (1 - 395 MBytes, default = 10). type: int
- analytics-wl-filetype - Do not submit files matching this DLP file-pattern to FortiSandbox. type: str
- av-block-log - Enable/disable logging for AntiVirus file blocking. type: str choices: [disable, enable]
- av-virus-log - Enable/disable AntiVirus logging. type: str choices: [disable, enable]
- comment - Comment. type: str
- extended-log - Enable/disable extended logging for antivirus. type: str choices: [disable, enable]
- ftgd-analytics - Settings to control which files are uploaded to FortiSandbox. type: str choices: [disable, suspicious, everything]
- inspection-mode - Inspection mode. type: str choices: [proxy, flow-based]
- mobile-malware-db - Enable/disable using the mobile malware signature database. type: str choices: [disable, enable]
- name - Profile name. type: str
- replacemsg-group - Replacement message group customized for this profile. type: str
- scan-mode - Choose between full scan mode and quick scan mode. type: str choices: [quick, full]
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: Configure AntiVirus profiles.
fmgr_antivirus_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]>
antivirus_profile:
analytics-bl-filetype: <value of string>
analytics-db: <value in [disable, enable]>
analytics-max-upload: <value of integer>
analytics-wl-filetype: <value of string>
av-block-log: <value in [disable, enable]>
av-virus-log: <value in [disable, enable]>
comment: <value of string>
extended-log: <value in [disable, enable]>
ftgd-analytics: <value in [disable, suspicious, everything]>
inspection-mode: <value in [proxy, flow-based]>
mobile-malware-db: <value in [disable, enable]>
name: <value of string>
replacemsg-group: <value of string>
scan-mode: <value in [quick, full]>
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