fmgr_antivirus_profile_obj – Configure AntiVirus profiles.¶
New in version 2.10.
Synopsis¶
- This module is able to configure a FortiManager device by allowing the user to [clone, delete, get, set, update] the following FortiManager json-rpc urls.
- /pm/config/adom/{adom}/obj/antivirus/profile/{profile}
- /pm/config/global/obj/antivirus/profile/{profile}
- 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.10.0
Parameters¶
- loose_validation - Do parameter validation in a loose way 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 dom
- workspace_locking_timeout - The maximum time in seconds to wait for other users to release workspace lock type: integer required: false default: 300
- url_params - parameters in url path type: dict required: true
- adom - the domain prefix type: str choices: none, global, custom dom
- profile - the object name type: str
- parameters for method: [clone, set, update] - Configure AntiVirus profiles.
- data - No description for the parameter 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]
- parameters for method: [delete] - Configure AntiVirus profiles.
- parameters for method: [get] - Configure AntiVirus profiles.
- option - Set fetch option for the request. type: str choices: [object member, chksum, datasrc]
Notes¶
Note
- The module may supports multiple method, every method has different parameters definition
- One method may also have more than one parameter definition collection, each collection is dedicated to one API endpoint
- The module may include domain dependent urls, the domain can be specified in url_params as adom
- To run in workspace mode, the paremeter workspace_locking_adom must be included in the task
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: REQUESTING /PM/CONFIG/OBJ/ANTIVIRUS/PROFILE/{PROFILE}
fmgr_antivirus_profile_obj:
loose_validation: False
workspace_locking_adom: <value in [global, custom adom]>
workspace_locking_timeout: 300
method: <value in [clone, set, update]>
url_params:
adom: <value in [none, global, custom dom]>
profile: <value of string>
params:
-
data:
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]>
- name: REQUESTING /PM/CONFIG/OBJ/ANTIVIRUS/PROFILE/{PROFILE}
fmgr_antivirus_profile_obj:
loose_validation: False
workspace_locking_adom: <value in [global, custom adom]>
workspace_locking_timeout: 300
method: <value in [get]>
url_params:
adom: <value in [none, global, custom dom]>
profile: <value of string>
params:
-
option: <value in [object member, chksum, datasrc]>
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:
- return values for method: [clone, delete, set, update]
- status
- No description for the parameter type: dict
- code - No description for the parameter type: int
- message - No description for the parameter type: str
- url - No description for the parameter type: str example: /pm/config/adom/{adom}/obj/antivirus/profile/{profile}
- return values for method: [get]
- data
- No description for the parameter 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
- 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
- av-virus-log - Enable/disable AntiVirus logging. type: str
- comment - Comment. type: str
- extended-log - Enable/disable extended logging for antivirus. type: str
- ftgd-analytics - Settings to control which files are uploaded to FortiSandbox. type: str
- inspection-mode - Inspection mode. type: str
- mobile-malware-db - Enable/disable using the mobile malware signature database. type: str
- 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
- status
- No description for the parameter type: dict
- code - No description for the parameter type: int
- message - No description for the parameter type: str
- url - No description for the parameter type: str example: /pm/config/adom/{adom}/obj/antivirus/profile/{profile}