fortinet.fortimanager.fmgr_antivirus_profile 模块 – 配置防病毒配置文件。
注意
此模块是 fortinet.fortimanager 集合(版本 2.8.2)的一部分。
如果您正在使用 ansible
包,您可能已经安装了此集合。 它不包含在 ansible-core
中。 要检查它是否已安装,请运行 ansible-galaxy collection list
。
要安装它,请使用:ansible-galaxy collection install fortinet.fortimanager
。
要在 playbook 中使用它,请指定:fortinet.fortimanager.fmgr_antivirus_profile
。
fortinet.fortimanager 1.0.0 中的新增功能
概要
此模块能够配置 FortiManager 设备。
示例包括所有参数和值,这些参数和值在使用前需要调整为数据源。
参数
参数 |
注释 |
---|---|
用于在不使用用户名和密码的情况下访问 FortiManager 的令牌。 |
|
请求的 URL 中的参数 (adom)。 |
|
设置的顶层参数。 |
|
仅将与此 DLP 文件模式匹配的文件提交到 FortiSandbox。 |
|
仅将与此 DLP 文件模式匹配的文件提交到 FortiSandbox。 |
|
启用/禁用使用 FortiSandbox 签名数据库来补充 AV 签名数据库。 选项
|
|
不要将与此 DLP 文件模式匹配的文件提交到 FortiSandbox。 |
|
可以上传到 FortiSandbox 的文件的最大大小 |
|
不要将与此 DLP 文件模式匹配的文件提交到 FortiSandbox。 |
|
启用/禁用防病毒文件阻止的日志记录。 选项
|
|
启用/禁用防病毒日志记录。 选项
|
|
Cifs。 |
|
选择要阻止的存档类型。 选项
|
|
选择要记录的存档类型。 选项
|
|
启用防病毒扫描服务。 选项
|
|
启用/禁用病毒模拟器。 选项
|
|
启用外部阻止列表。 选项
|
|
启用/禁用 FortiAI 对文件的扫描。 选项
|
|
启用 FortiNDR 对文件的扫描。 选项
|
|
启用 FortiSandbox 对文件的扫描。 选项
|
|
启用/禁用 CIFS 防病毒扫描、监视和隔离。 选项
|
|
启用病毒爆发防护服务。 选项
|
|
启用/禁用对受感染文件的隔离。 选项
|
|
注释。 |
|
内容解除武装。 |
|
启用/禁用使用 CDR 作为确定可疑文件进行分析的辅助方法。 选项
|
|
启用/禁用在解除武装的文档中插入封面。 选项
|
|
启用/禁用仅检测可解除武装的文件,不修改内容。 选项
|
|
当 CDR 引擎遇到无法恢复的错误时要采取的操作。 选项
|
|
启用/禁用剥离 Microsoft Office 文档中的 PowerPoint 操作事件。 选项
|
|
启用/禁用剥离 Microsoft Office 文档中的动态数据交换事件。 选项
|
|
启用/禁用剥离 Microsoft Office 文档中的嵌入对象。 选项
|
|
启用/禁用剥离 Microsoft Office 文档中的超链接。 选项
|
|
启用/禁用剥离 Microsoft Office 文档中的链接对象。 选项
|
|
启用/禁用剥离 Microsoft Office 文档中的宏。 选项
|
|
如果删除了活动内容,则发送原始文件的目标位置。 选项
|
|
启用/禁用剥离将数据提交到其他目标的 PDF 文档操作。 选项
|
|
启用/禁用剥离访问其他 PDF 文档的 PDF 文档操作。 选项
|
|
启用/禁用剥离执行 JavaScript 代码的 PDF 文档操作。 选项
|
|
启用/禁用剥离启动其他应用程序的 PDF 文档操作。 选项
|
|
启用/禁用剥离播放电影的 PDF 文档操作。 选项
|
|
启用/禁用剥离播放声音的 PDF 文档操作。 选项
|
|
启用/禁用剥离 PDF 文档中的嵌入文件。 选项
|
|
启用/禁用剥离 PDF 文档中的超链接。 选项
|
|
启用/禁用剥离 PDF 文档中的 JavaScript 代码。 选项
|
|
启用/禁用在执行防病毒扫描时使用 EMS 威胁源。 选项
|
|
启用/禁用防病毒的扩展日志记录。 选项
|
|
(列表或字符串) 一个或多个外部恶意软件阻止列表。 |
|
启用/禁用外部阻止列表的存档扫描。 选项
|
|
启用/禁用所有外部阻止列表。 选项
|
|
流/代理功能集。 选项
|
|
如果 FortiAI 遇到错误,则要采取的操作。 选项
|
|
如果 FortiAI 遇到扫描超时,则要采取的操作。 选项
|
|
如果 FortiNDR 遇到错误,则要采取的操作。 选项
|
|
如果 FortiNDR 遇到扫描超时,则要采取的操作。 选项
|
|
如果 FortiSandbox 内联扫描遇到错误,则要采取的操作。 选项
|
|
可以上传到 FortiSandbox 的文件的最大大小。 |
|
FortiSandbox 扫描模式。 选项
|
|
如果 FortiSandbox 内联扫描遇到扫描超时,则要采取的操作。 选项
|
|
控制哪些文件上传到 FortiSandbox 的设置。 选项
|
|
Ftp。 |
|
选择要阻止的存档类型。 选项
|
|
选择要记录的存档类型。 选项
|
|
启用防病毒扫描服务。 选项
|
|
启用/禁用病毒模拟器。 选项
|
|
启用外部阻止列表。 选项
|
|
启用/禁用 FortiAI 对文件的扫描。 选项
|
|
启用 FortiNDR 对文件的扫描。 选项
|
|
启用 FortiSandbox 对文件的扫描。 选项
|
|
启用/禁用 FTP 防病毒扫描、监控和隔离。 选项
|
|
启用病毒爆发防护服务。 选项
|
|
启用/禁用对受感染文件的隔离。 选项
|
|
Http。 |
|
选择要阻止的存档类型。 选项
|
|
选择要记录的存档类型。 选项
|
|
Av 优化。 选项
|
|
启用防病毒扫描服务。 选项
|
|
为此协议启用内容解除和重建。 选项
|
|
启用/禁用病毒模拟器。 选项
|
|
启用外部阻止列表。 选项
|
|
启用/禁用 FortiAI 对文件的扫描。 选项
|
|
启用 FortiNDR 对文件的扫描。 选项
|
|
启用 FortiSandbox 对文件的扫描。 选项
|
|
启用/禁用 HTTP 防病毒扫描、监控和隔离。 选项
|
|
启用病毒爆发防护服务。 选项
|
|
启用/禁用对受感染文件的隔离。 选项
|
|
配置 FortiGate 设备对未知内容编码采取的操作。 选项
|
|
Imap。 |
|
选择要阻止的存档类型。 选项
|
|
选择要记录的存档类型。 选项
|
|
启用防病毒扫描服务。 选项
|
|
为此协议启用内容解除和重建。 选项
|
|
启用/禁用病毒模拟器。 选项
|
|
将 Windows 可执行文件视为病毒,以进行阻止或监控。 选项
|
|
启用外部阻止列表。 选项
|
|
启用/禁用 FortiAI 对文件的扫描。 选项
|
|
启用 FortiNDR 对文件的扫描。 选项
|
|
启用 FortiSandbox 对文件的扫描。 选项
|
|
启用/禁用 IMAP 防病毒扫描、监控和隔离。 选项
|
|
启用病毒爆发防护服务。 选项
|
|
启用/禁用对受感染文件的隔离。 选项
|
|
检查模式。 选项
|
|
Mapi。 |
|
选择要阻止的存档类型。 选项
|
|
选择要记录的存档类型。 选项
|
|
启用防病毒扫描服务。 选项
|
|
启用/禁用病毒模拟器。 选项
|
|
将 Windows 可执行文件视为病毒,以进行阻止或监控。 选项
|
|
启用外部阻止列表。 选项
|
|
启用/禁用 FortiAI 对文件的扫描。 选项
|
|
启用 FortiNDR 对文件的扫描。 选项
|
|
启用 FortiSandbox 对文件的扫描。 选项
|
|
启用/禁用 MAPI 防病毒扫描、监控和隔离。 选项
|
|
启用病毒爆发防护服务。 选项
|
|
启用/禁用对受感染文件的隔离。 选项
|
|
启用/禁用移动恶意软件签名数据库。 选项
|
|
Nac 隔离。 |
|
隔离的持续时间。 |
|
启用/禁用将受感染的主机隔离到禁用用户列表。 选项
|
|
启用/禁用反病毒隔离日志记录。 选项
|
|
配置文件名称。 |
|
Nntp。 |
|
选择要阻止的存档类型。 选项
|
|
选择要记录的存档类型。 选项
|
|
启用防病毒扫描服务。 选项
|
|
启用/禁用病毒模拟器。 选项
|
|
启用外部阻止列表。 选项
|
|
启用/禁用 FortiAI 对文件的扫描。 选项
|
|
启用 FortiNDR 对文件的扫描。 选项
|
|
启用 FortiSandbox 对文件的扫描。 选项
|
|
启用/禁用 NNTP 反病毒扫描、监控和隔离。 选项
|
|
启用病毒爆发防护服务。 选项
|
|
启用/禁用对受感染文件的隔离。 选项
|
|
爆发预防。 |
|
启用/禁用外部恶意软件阻止列表。 选项
|
|
启用/禁用 FortiGuard 病毒爆发预防服务。 选项
|
|
启用/禁用爆发预防存档扫描。 选项
|
|
Pop3。 |
|
选择要阻止的存档类型。 选项
|
|
选择要记录的存档类型。 选项
|
|
启用防病毒扫描服务。 选项
|
|
为此协议启用内容解除和重建。 选项
|
|
启用/禁用病毒模拟器。 选项
|
|
将 Windows 可执行文件视为病毒,以进行阻止或监控。 选项
|
|
启用外部阻止列表。 选项
|
|
启用/禁用 FortiAI 对文件的扫描。 选项
|
|
启用 FortiNDR 对文件的扫描。 选项
|
|
启用 FortiSandbox 对文件的扫描。 选项
|
|
启用/禁用 POP3 反病毒扫描、监控和隔离。 选项
|
|
启用病毒爆发防护服务。 选项
|
|
启用/禁用对受感染文件的隔离。 选项
|
|
为此配置文件自定义的替换消息组。 |
|
在全扫描模式和快速扫描模式之间选择。 选项
|
|
Smb。 |
|
选择要阻止的存档类型。 选项
|
|
选择要记录的存档类型。 选项
|
|
启用/禁用病毒模拟器。 选项
|
|
启用/禁用 SMB 反病毒扫描、监控和隔离。 选项
|
|
启用 FortiGuard 病毒爆发预防服务。 选项
|
|
Smtp。 |
|
选择要阻止的存档类型。 选项
|
|
选择要记录的存档类型。 选项
|
|
启用防病毒扫描服务。 选项
|
|
为此协议启用内容解除和重建。 选项
|
|
启用/禁用病毒模拟器。 选项
|
|
将 Windows 可执行文件视为病毒,以进行阻止或监控。 选项
|
|
启用外部阻止列表。 选项
|
|
启用/禁用 FortiAI 对文件的扫描。 选项
|
|
启用 FortiNDR 对文件的扫描。 选项
|
|
启用 FortiSandbox 对文件的扫描。 选项
|
|
启用/禁用 SMTP 反病毒扫描、监控和隔离。 选项
|
|
启用病毒爆发防护服务。 选项
|
|
启用/禁用对受感染文件的隔离。 选项
|
|
Ssh。 |
|
选择要阻止的存档类型。 选项
|
|
选择要记录的存档类型。 选项
|
|
启用防病毒扫描服务。 选项
|
|
启用/禁用病毒模拟器。 选项
|
|
启用外部阻止列表。 选项
|
|
启用/禁用 FortiAI 对文件的扫描。 选项
|
|
启用 FortiNDR 对文件的扫描。 选项
|
|
启用 FortiSandbox 对文件的扫描。 选项
|
|
启用/禁用 SFTP 和 SCP 反病毒扫描、监控和隔离。 选项
|
|
启用病毒爆发防护服务。 选项
|
|
启用/禁用对受感染文件的隔离。 选项
|
|
仅当模块模式与 FortiManager API 结构不同时设置为 True,模块将继续执行而不验证参数。 选项
|
|
启用/禁用任务日志记录。 选项
|
|
使用 forticloud API 访问令牌验证 Ansible 客户端。 |
|
用于底层 Json RPC 请求的覆盖方法。 选项
|
|
将覆盖失败条件的 rc 代码列表。 |
|
将覆盖成功条件的 rc 代码列表。 |
|
创建、更新或删除对象的指令。 选项
|
|
在工作区模式下运行的 FortiManager 要锁定的 ADOM,该值可以是 global 和其他包括 root 的值。 |
|
等待其他用户释放工作区锁定的最长时间(以秒为单位)。 默认值: |
备注
注意
从 2.4.0 版本开始,所有输入参数都使用下划线命名约定 (snake_case) 命名。请将 “var-name” 等参数更改为 “var_name”。旧的参数名称仍然可用,但您将收到弃用警告。您可以通过在 ansible.cfg 中设置 deprecation_warnings=False 来忽略此警告。
此 FortiManager 模块支持在工作区锁定模式下运行,顶层参数 workspace_locking_adom 和 workspace_locking_timeout 帮助完成这项工作。
要创建或更新对象,请使用 state present 指令。
要删除对象,请使用 state absent 指令。
通常,当返回非零 rc 时,运行一个模块可能会失败。您还可以使用参数 rc_failed 和 rc_succeeded 来覆盖失败或成功的条件
示例
- name: Example playbook
hosts: fortimanagers
connection: httpapi
vars:
ansible_httpapi_use_ssl: true
ansible_httpapi_validate_certs: false
ansible_httpapi_port: 443
tasks:
- name: Configure AntiVirus profiles.
fortinet.fortimanager.fmgr_antivirus_profile:
adom: ansible
state: present
antivirus_profile:
analytics-db: disable
analytics-max-upload: 20
av-block-log: disable
av-virus-log: disable
comment: "test comment"
extended-log: disable
ftgd-analytics: disable
inspection-mode: proxy
mobile-malware-db: disable
name: "antivirus-profile"
scan-mode: quick
- name: Gathering fortimanager facts
hosts: fortimanagers
gather_facts: false
connection: httpapi
vars:
ansible_httpapi_use_ssl: true
ansible_httpapi_validate_certs: false
ansible_httpapi_port: 443
tasks:
- name: Retrieve all the antivirus profiles
fortinet.fortimanager.fmgr_fact:
facts:
selector: "antivirus_profile"
params:
adom: "ansible"
profile: "your_value"
返回值
此处记录了常见返回值 这里,以下是此模块独有的字段
键 |
描述 |
---|---|
请求的结果。 返回: 总是 |
|
请求的完整 URL。 返回: 总是 示例: |
|
api 请求的状态。 返回: 总是 示例: |
|
api 响应。 返回: 总是 |
|
api 响应的描述性消息。 返回: 总是 示例: |
|
目标系统的信息。 返回: 总是 |
|
请求的状态。 返回: 总是 示例: |
|
如果 playbook 中使用的参数不受当前 FortiManager 版本支持,则会发出警告。 返回: 复杂 |