:source: fmgd_antivirus_profile.py :orphan: .. _fmgd_antivirus_profile: fmgd_antivirus_profile -- Configure AntiVirus profiles. +++++++++++++++++++++++++++++++++++++++++++++++++++++++ .. versionadded:: 1.1.0 .. contents:: :local: :depth: 1 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 v7.x. Requirements ------------ The below requirements are needed on the host that executes this module. - ansible-core>=2.16.0 FortiManager Version Compatibility ---------------------------------- .. raw:: html

Supported Version Ranges: v7.4.8 -> v7.4.10, v7.6.4 -> latest

Parameters ---------- .. raw:: html 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 -------- .. code-block:: yaml+jinja - name: Example playbook (generated based on argument schema) hosts: fortimanagers connection: httpapi gather_facts: false vars: ansible_httpapi_use_ssl: true ansible_httpapi_validate_certs: false ansible_httpapi_port: 443 tasks: - name: Configure AntiVirus profiles. fortinet.fmgdevice.fmgd_antivirus_profile: # bypass_validation: false # workspace_locking_adom: # workspace_locking_timeout: 300 # rc_succeeded: [0, -2, -3, ...] # rc_failed: [-2, -3, ...] device: vdom: state: present # antivirus_profile: name: "your value" # Required variable, string # analytics_accept_filetype: # analytics_db: # analytics_ignore_filetype: # av_block_log: # av_virus_log: # cifs: # archive_block: # - "encrypted" # - "corrupted" # - "multipart" # - "nested" # - "mailbomb" # - "unhandled" # - "partiallycorrupted" # - "timeout" # - "fileslimit" # archive_log: # - "encrypted" # - "corrupted" # - "multipart" # - "nested" # - "mailbomb" # - "unhandled" # - "partiallycorrupted" # - "timeout" # - "fileslimit" # av_scan: # emulator: # external_blocklist: # fortindr: # fortisandbox: # outbreak_prevention: # quarantine: # fortiai: # options: # - "scan" # - "quarantine" # - "avmonitor" # malware_stream: # comment: # content_disarm: # cover_page: # detect_only: # error_action: # office_action: # office_dde: # office_embed: # office_hylink: # office_linked: # office_macro: # original_file_destination: # pdf_act_form: # pdf_act_gotor: # pdf_act_java: # pdf_act_launch: # pdf_act_movie: # pdf_act_sound: # pdf_embedfile: # pdf_hyperlink: # pdf_javacode: # analytics_suspicious: # ems_threat_feed: # external_blocklist: # external_blocklist_enable_all: # fortindr_error_action: # fortindr_timeout_action: # fortisandbox_error_action: # fortisandbox_max_upload: # fortisandbox_mode: # fortisandbox_timeout_action: # ftp: # archive_block: # - "encrypted" # - "corrupted" # - "multipart" # - "nested" # - "mailbomb" # - "unhandled" # - "partiallycorrupted" # - "timeout" # - "fileslimit" # archive_log: # - "encrypted" # - "corrupted" # - "multipart" # - "nested" # - "mailbomb" # - "unhandled" # - "partiallycorrupted" # - "timeout" # - "fileslimit" # av_scan: # emulator: # external_blocklist: # fortindr: # fortisandbox: # outbreak_prevention: # quarantine: # fortiai: # options: # - "scan" # - "quarantine" # - "avmonitor" # malware_stream: # http: # archive_block: # - "encrypted" # - "corrupted" # - "multipart" # - "nested" # - "mailbomb" # - "unhandled" # - "partiallycorrupted" # - "timeout" # - "fileslimit" # archive_log: # - "encrypted" # - "corrupted" # - "multipart" # - "nested" # - "mailbomb" # - "unhandled" # - "partiallycorrupted" # - "timeout" # - "fileslimit" # av_scan: # content_disarm: # emulator: # external_blocklist: # fortindr: # fortisandbox: # outbreak_prevention: # quarantine: # unknown_content_encoding: # fortiai: # options: # - "scan" # - "quarantine" # - "avmonitor" # av_optimize: # malware_stream: # imap: # archive_block: # - "encrypted" # - "corrupted" # - "multipart" # - "nested" # - "mailbomb" # - "unhandled" # - "partiallycorrupted" # - "timeout" # - "fileslimit" # archive_log: # - "encrypted" # - "corrupted" # - "multipart" # - "nested" # - "mailbomb" # - "unhandled" # - "partiallycorrupted" # - "timeout" # - "fileslimit" # av_scan: # content_disarm: # emulator: # executables: # external_blocklist: # fortindr: # fortisandbox: # outbreak_prevention: # quarantine: # fortiai: # options: # - "scan" # - "quarantine" # - "avmonitor" # malware_stream: # mapi: # archive_block: # - "encrypted" # - "corrupted" # - "multipart" # - "nested" # - "mailbomb" # - "unhandled" # - "partiallycorrupted" # - "timeout" # - "fileslimit" # archive_log: # - "encrypted" # - "corrupted" # - "multipart" # - "nested" # - "mailbomb" # - "unhandled" # - "partiallycorrupted" # - "timeout" # - "fileslimit" # av_scan: # emulator: # executables: # external_blocklist: # fortindr: # fortisandbox: # outbreak_prevention: # quarantine: # fortiai: # options: # - "scan" # - "quarantine" # - "avmonitor" # malware_stream: # mobile_malware_db: # nac_quar: # expiry: # infected: # log: # nntp: # archive_block: # - "encrypted" # - "corrupted" # - "multipart" # - "nested" # - "mailbomb" # - "unhandled" # - "partiallycorrupted" # - "timeout" # - "fileslimit" # archive_log: # - "encrypted" # - "corrupted" # - "multipart" # - "nested" # - "mailbomb" # - "unhandled" # - "partiallycorrupted" # - "timeout" # - "fileslimit" # av_scan: # emulator: # external_blocklist: # fortindr: # fortisandbox: # outbreak_prevention: # quarantine: # fortiai: # options: # - "scan" # - "quarantine" # - "avmonitor" # malware_stream: # outbreak_prevention_archive_scan: # pop3: # archive_block: # - "encrypted" # - "corrupted" # - "multipart" # - "nested" # - "mailbomb" # - "unhandled" # - "partiallycorrupted" # - "timeout" # - "fileslimit" # archive_log: # - "encrypted" # - "corrupted" # - "multipart" # - "nested" # - "mailbomb" # - "unhandled" # - "partiallycorrupted" # - "timeout" # - "fileslimit" # av_scan: # content_disarm: # emulator: # executables: # external_blocklist: # fortindr: # fortisandbox: # outbreak_prevention: # quarantine: # fortiai: # options: # - "scan" # - "quarantine" # - "avmonitor" # malware_stream: # replacemsg_group: # scan_mode: # smtp: # archive_block: # - "encrypted" # - "corrupted" # - "multipart" # - "nested" # - "mailbomb" # - "unhandled" # - "partiallycorrupted" # - "timeout" # - "fileslimit" # archive_log: # - "encrypted" # - "corrupted" # - "multipart" # - "nested" # - "mailbomb" # - "unhandled" # - "partiallycorrupted" # - "timeout" # - "fileslimit" # av_scan: # content_disarm: # emulator: # executables: # external_blocklist: # fortindr: # fortisandbox: # outbreak_prevention: # quarantine: # fortiai: # options: # - "scan" # - "quarantine" # - "avmonitor" # malware_stream: # ssh: # archive_block: # - "encrypted" # - "corrupted" # - "multipart" # - "nested" # - "mailbomb" # - "unhandled" # - "partiallycorrupted" # - "timeout" # - "fileslimit" # archive_log: # - "encrypted" # - "corrupted" # - "multipart" # - "nested" # - "mailbomb" # - "unhandled" # - "partiallycorrupted" # - "timeout" # - "fileslimit" # av_scan: # emulator: # external_blocklist: # fortindr: # fortisandbox: # outbreak_prevention: # quarantine: # fortiai: # options: # - "avmonitor" # - "quarantine" # - "scan" # malware_stream: # feature_set: # extended_log: # ftgd_analytics: # analytics_max_upload: # fortiai_error_action: # fortiai_timeout_action: # external_blocklist_archive_scan: # outbreak_prevention: # external_blocklist: # ftgd_service: # analytics_bl_filetype: # analytics_wl_filetype: # fortisandbox_scan_timeout: 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: .. raw:: html
  • 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. Authors ------- - Xinwei Du (@dux-fortinet) - Xing Li (@lix-fortinet) - Jie Xue (@JieX19) - Link Zheng (@chillancezen) - Frank Shen (@fshen01) - Hongbin Lu (@fgtdev-hblu)