fortinet.fortimanager.fmgr_firewall_mmsprofile 模块 – 配置 MMS 配置文件。

注意

此模块是 fortinet.fortimanager 集合 (版本 2.8.2) 的一部分。

如果您使用的是 ansible 包，则可能已经安装了此集合。它不包含在 ansible-core 中。要检查是否已安装，请运行 ansible-galaxy collection list。

要安装它，请使用：ansible-galaxy collection install fortinet.fortimanager。

要在剧本中使用它，请指定：fortinet.fortimanager.fmgr_firewall_mmsprofile。

fortinet.fortimanager 2.0.0 中的新增功能

概要

• 此模块能够配置 FortiManager 设备。

• 示例包括所有需要在使用前根据数据源调整的参数和值。

参数

参数	注释
access_token 字符串	无需使用用户名和密码即可访问 FortiManager 的令牌。
adom 字符串 / 必需	请求 URL 中的参数 (adom)。
bypass_validation 布尔值	仅当模块模式与 FortiManager API 结构不同时设置为 True，模块将继续执行而无需验证参数。 选项 false ← (默认) true
enable_log 布尔值	启用/禁用任务日志记录。 选项 false ← (默认) true
firewall_mmsprofile 字典	设置的顶级参数。
avnotificationtable 字符串	防病毒通知表 ID。
bwordtable 字符串	MMS 禁止词表 ID。
carrier_endpoint_prefix 别名：carrier-endpoint-prefix 字符串	启用/禁用端点值的加前缀。 选项 "disable" "enable"
carrier_endpoint_prefix_range_max 别名：carrier-endpoint-prefix-range-max 整数	可以加前缀的端点值的最大长度
carrier_endpoint_prefix_range_min 别名：carrier-endpoint-prefix-range-min 整数	要加前缀的最小端点长度
carrier_endpoint_prefix_string 别名：carrier-endpoint-prefix-string 字符串	用于为端点值加前缀的字符串。
carrierendpointbwltable 字符串	运营商端点过滤器表 ID。
comment 字符串	注释。
dupe 字典	重复。
action1 列表 / 元素=字符串	达到阈值时要采取的操作。 选项 "log" "archive" "intercept" "block" "archive-first" "alert-notif"
action2 列表 / 元素=字符串	达到阈值时要采取的操作。 选项 "log" "archive" "intercept" "block" "archive-first" "alert-notif"
action3 列表 / 元素=字符串	达到阈值时要采取的操作。 选项 "log" "archive" "intercept" "block" "archive-first" "alert-notif"
block_time1 别名：block-time1 整数	操作生效的持续时间
block_time2 别名：block-time2 整数	操作生效的持续时间
block_time3 别名：block-time3 整数	操作生效的持续时间
limit1 整数	允许的最大消息数。
limit2 整数	允许的最大消息数。
limit3 整数	允许的最大消息数。
protocol 字符串	协议。
status1 字符串	启用/禁用 status1 检测。 选项 "disable" "enable"
status2 字符串	启用/禁用 status2 检测。 选项 "disable" "enable"
status3 字符串	启用/禁用 status3 检测。 选项 "disable" "enable"
window1 整数	用于计算消息的窗口
window2 整数	用于计算消息的窗口
window3 整数	用于计算消息的窗口
flood 字典	泛洪。
action1 列表 / 元素=字符串	达到阈值时要采取的操作。 选项 "log" "archive" "intercept" "block" "archive-first" "alert-notif"
action2 列表 / 元素=字符串	达到阈值时要采取的操作。 选项 "log" "archive" "intercept" "block" "archive-first" "alert-notif"
action3 列表 / 元素=字符串	达到阈值时要采取的操作。 选项 "log" "archive" "intercept" "block" "archive-first" "alert-notif"
block_time1 别名：block-time1 整数	操作生效的持续时间
block_time2 别名：block-time2 整数	操作生效的持续时间
block_time3 别名：block-time3 整数	操作生效的持续时间
limit1 整数	允许的最大消息数。
limit2 整数	允许的最大消息数。
limit3 整数	允许的最大消息数。
protocol 字符串	协议。
status1 字符串	启用/禁用 status1 检测。 选项 "disable" "enable"
status2 字符串	启用/禁用 status2 检测。 选项 "disable" "enable"
status3 字符串	启用/禁用 status3 检测。 选项 "disable" "enable"
window1 整数	用于计算消息的窗口
window2 整数	用于计算消息的窗口
window3 整数	用于计算消息的窗口
mm1 列表 / 元素=字符串	MM1 选项。 选项 "avmonitor" "block" "oversize" "quarantine" "scan" "avquery" "bannedword" "no-content-summary" "archive-summary" "archive-full" "carrier-endpoint-bwl" "remove-blocked" "chunkedbypass" "clientcomfort" "servercomfort" "strict-file" "mms-checksum"
mm1_addr_hdr 别名：mm1-addr-hdr 字符串	HTTP 头字段
mm1_addr_source 别名：mm1-addr-source 字符串	MM1 用户地址的来源。 选项 "http-header" "cookie"
mm1_convert_hex 别名：mm1-convert-hex 字符串	启用/禁用将 MM1 的用户地址从十六进制字符串转换。 选项 "disable" "enable"
mm1_outbreak_prevention 别名：mm1-outbreak-prevention 字符串	启用 FortiGuard 病毒爆发防护服务。 选项 "disabled" "files" "full-archive"
mm1_retr_dupe 别名：mm1-retr-dupe 字符串	启用/禁用 MM1 retr 的重复扫描。 选项 "disable" "enable"
mm1_retrieve_scan 别名：mm1-retrieve-scan 字符串	启用/禁用对 MM1 检索配置消息的扫描。 选项 "disable" "enable"
mm1comfortamount 整数	MM1 舒适量
mm1comfortinterval 整数	MM1 舒适间隔
mm1oversizelimit 整数	要扫描的最大文件大小
mm3 列表 / 元素=字符串	MM3 选项。 选项 "avmonitor" "block" "oversize" "quarantine" "scan" "avquery" "bannedword" "no-content-summary" "archive-summary" "archive-full" "carrier-endpoint-bwl" "remove-blocked" "fragmail" "splice" "mms-checksum"
mm3_outbreak_prevention 别名：mm3-outbreak-prevention 字符串	启用 FortiGuard 病毒爆发防护服务。 选项 "disabled" "files" "full-archive"
mm3oversizelimit 整数	要扫描的最大文件大小
mm4 列表 / 元素=字符串	MM4 选项。 选项 "avmonitor" "block" "oversize" "quarantine" "scan" "avquery" "bannedword" "no-content-summary" "archive-summary" "archive-full" "carrier-endpoint-bwl" "remove-blocked" "fragmail" "splice" "mms-checksum"
mm4_outbreak_prevention 别名: mm4-outbreak-prevention 字符串	启用 FortiGuard 病毒爆发防护服务。 选项 "disabled" "files" "full-archive"
mm4oversizelimit 整数	要扫描的最大文件大小
mm7 列表 / 元素=字符串	MM7 选项。 选项 "avmonitor" "block" "oversize" "quarantine" "scan" "avquery" "bannedword" "no-content-summary" "archive-summary" "archive-full" "carrier-endpoint-bwl" "remove-blocked" "chunkedbypass" "clientcomfort" "servercomfort" "strict-file" "mms-checksum"
mm7_addr_hdr 别名: mm7-addr-hdr 字符串	HTTP 头字段
mm7_addr_source 别名: mm7-addr-source 字符串	MM7 用户地址的来源。 选项 "http-header" "cookie"
mm7_convert_hex 别名: mm7-convert-hex 字符串	启用/禁用 MM7 用户地址的十六进制字符串转换。 选项 "disable" "enable"
mm7_outbreak_prevention 别名: mm7-outbreak-prevention 字符串	启用 FortiGuard 病毒爆发防护服务。 选项 "disabled" "files" "full-archive"
mm7comfortamount 整数	MM7 舒适量
mm7comfortinterval 整数	MM7 舒适间隔
mm7oversizelimit 整数	要扫描的最大文件大小
mms_antispam_mass_log 别名: mms-antispam-mass-log 字符串	启用/禁用 MMS 反垃圾邮件日志记录。 选项 "disable" "enable"
mms_av_block_log 别名: mms-av-block-log 字符串	启用/禁用 MMS 防病毒文件阻止日志记录。 选项 "disable" "enable"
mms_av_oversize_log 别名: mms-av-oversize-log 字符串	启用/禁用 MMS 防病毒超大文件阻止日志记录。 选项 "disable" "enable"
mms_av_virus_log 别名: mms-av-virus-log 字符串	启用/禁用 MMS 防病毒扫描日志记录。 选项 "disable" "enable"
mms_carrier_endpoint_filter_log 别名: mms-carrier-endpoint-filter-log 字符串	启用/禁用 MMS 端点过滤器阻止日志记录。 选项 "disable" "enable"
mms_checksum_log 别名: mms-checksum-log 字符串	启用/禁用 MMS 内容校验和日志记录。 选项 "disable" "enable"
mms_checksum_table 别名: mms-checksum-table 字符串	MMS 内容校验和表 ID。
mms_notification_log 别名: mms-notification-log 字符串	启用/禁用 MMS 通知消息日志记录。 选项 "disable" "enable"
mms_web_content_log 别名: mms-web-content-log 字符串	启用/禁用 MMS 网页内容阻止日志记录。 选项 "disable" "enable"
mmsbwordthreshold 整数	MMS 禁用词阈值。
name 字符串 / 必需	配置文件名称。
notif_msisdn 别名: notif-msisdn 列表 / 元素=字典	Notif msisdn。
msisdn 字符串	接收者 MSISDN。
threshold 列表 / 元素=字符串	此 MSISDN 将接收警报的阈值。 选项 "flood-thresh-1" "flood-thresh-2" "flood-thresh-3" "dupe-thresh-1" "dupe-thresh-2" "dupe-thresh-3"
notification 字典	通知。
alert_int 别名: alert-int 整数	警报通知发送间隔。
alert_int_mode 别名: alert-int-mode 字符串	警报通知间隔模式。 选项 "小时" "分钟"
alert_src_msisdn 别名: alert-src-msisdn 字符串	指定警报消息的源地址。
alert_status 别名: alert-status 字符串	警报通知状态。 选项 "disable" "enable"
bword_int 别名: bword-int 整数	禁用词通知发送间隔。
bword_int_mode 别名: bword-int-mode 字符串	禁用词通知间隔模式。 选项 "小时" "分钟"
bword_status 别名: bword-status 字符串	禁用词通知状态。 选项 "disable" "enable"
carrier_endpoint_bwl_int 别名: carrier-endpoint-bwl-int 整数	运营商端点黑/白名单通知发送间隔。
carrier_endpoint_bwl_int_mode 别名: carrier-endpoint-bwl-int-mode 字符串	运营商端点黑/白名单通知间隔模式。 选项 "小时" "分钟"
carrier_endpoint_bwl_status 别名: carrier-endpoint-bwl-status 字符串	运营商端点黑/白名单通知状态。 选项 "disable" "enable"
days_allowed 别名: days-allowed 列表 / 元素=字符串	允许发送通知消息的星期几。 选项 "星期日" "星期一" "星期二" "星期三" "星期四" "星期五" "星期六"
detect_server 别名: detect-server 字符串	启用/禁用自动服务器地址确定。 选项 "disable" "enable"
dupe_int 别名: dupe-int 整数	重复通知发送间隔。
dupe_int_mode 别名: dupe-int-mode 字符串	重复通知间隔模式。 选项 "小时" "分钟"
dupe_status 别名: dupe-status 字符串	重复通知状态。 选项 "disable" "enable"
file_block_int 别名: file-block-int 整数	文件阻止通知发送间隔。
file_block_int_mode 别名: file-block-int-mode 字符串	文件阻止通知间隔模式。 选项 "小时" "分钟"
file_block_status 别名: file-block-status 字符串	文件阻止通知状态。 选项 "disable" "enable"
flood_int 别名: flood-int 整数	泛洪通知发送间隔。
flood_int_mode 别名: flood-int-mode 字符串	泛洪通知间隔模式。 选项 "小时" "分钟"
flood_status 别名: flood-status 字符串	泛洪通知状态。 选项 "disable" "enable"
from_in_header 别名: from-in-header 字符串	启用/禁用在 HTTP 头中插入发件人地址。 选项 "disable" "enable"
mms_checksum_int 别名: mms-checksum-int 整数	MMS 校验和通知发送间隔。
mms_checksum_int_mode 别名: mms-checksum-int-mode 字符串	MMS 校验和通知间隔模式。 选项 "小时" "分钟"
mms_checksum_status 别名: mms-checksum-status 字符串	MMS 校验和通知状态。 选项 "disable" "enable"
mmsc_hostname 别名: mmsc-hostname 字符串	MMSC 的主机名或 IP 地址。
mmsc_password 别名: mmsc-password 任意	(列表) 与 MMSC 进行身份验证所需的密码。
mmsc_port 别名: mmsc-port 整数	MMSC 上用于发送 MMS 消息的端口
mmsc_url 别名: mmsc-url 字符串	MMSC 上用于发送 MMS 消息的 URL。
mmsc_username 别名: mmsc-username 字符串	与 MMSC 进行身份验证所需的用户名。
msg_protocol 别名: msg-protocol 字符串	用于发送通知消息的协议。 选项 "mm1" "mm3" "mm4" "mm7"
msg_type 别名: msg-type 字符串	MM7 消息类型。 选项 "submit-req" "deliver-req"
protocol 字符串	协议。
rate_limit 别名: rate-limit 整数	发送通知消息的速率限制
tod_window_duration 别名: tod-window-duration 字符串	一天中的时间窗口持续时间。
tod_window_end 别名: tod-window-end 字符串	已弃用。
tod_window_start 别名: tod-window-start 字符串	一天中的时间窗口开始。
user_domain 别名: user-domain 字符串	用户地址所属的域名。
vas_id 别名: vas-id 字符串	VAS 标识符。
vasp_id 别名: vasp-id 字符串	VASP 标识符。
virus_int 别名: virus-int 整数	病毒通知发送间隔。
virus_int_mode 别名: virus-int-mode 字符串	病毒通知间隔模式。 选项 "小时" "分钟"
virus_status 别名: virus-status 字符串	病毒通知状态。 选项 "disable" "enable"
outbreak_prevention 别名: outbreak-prevention 字典	疫情防护。
external_blocklist 别名: external-blocklist 字符串	启用/禁用外部恶意软件黑名单。 选项 "disable" "enable"
ftgd_service 别名: ftgd-service 字符串	启用/禁用 FortiGuard 病毒疫情防护服务。 选项 "disable" "enable"
remove_blocked_const_length 别名: remove-blocked-const-length 字符串	启用/禁用 MMS 替换被阻止文件的固定长度。 选项 "disable" "enable"
replacemsg_group 别名: replacemsg-group 字符串	替换消息组。
forticloud_access_token 字符串	使用 forticloud API 访问令牌验证 Ansible 客户端。
proposed_method 字符串	底层 Json RPC 请求的覆盖方法。 选项 "更新" "设置" "添加"
rc_failed 列表 / 元素=整数	覆盖失败条件的RC代码列表。
rc_succeeded 列表 / 元素=整数	覆盖成功条件的RC代码列表。
状态 字符串 / 必需	创建、更新或删除对象的指令。 选项 "存在" "不存在"
workspace_locking_adom 字符串	在工作区模式下运行FortiManager时要锁定的ADOM，值可以是全局的和其他值，包括root。
workspace_locking_timeout 整数	等待其他用户释放工作区锁的最大时间（秒）。 默认值： 300

注释

注意

• 从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 MMS profiles.
      fortinet.fortimanager.fmgr_firewall_mmsprofile:
        bypass_validation: false
        adom: FortiCarrier # FortiCarrier only object, need a FortiCarrier adom
        state: present
        firewall_mmsprofile:
          comment: "ansible-comment"
          # extended-utm-log: disable
          mm1:
            - avmonitor
            - block
            - oversize
            - quarantine
            - scan
            - avquery
            - bannedword
            - no-content-summary
            - archive-summary
            - archive-full
            - carrier-endpoint-bwl
            - remove-blocked
            - chunkedbypass
            - clientcomfort
            - servercomfort
            - strict-file
            - mms-checksum
          mm3:
            - avmonitor
            - block
            - oversize
            - quarantine
            - scan
            - avquery
            - bannedword
            - no-content-summary
            - archive-summary
            - archive-full
            - carrier-endpoint-bwl
            - remove-blocked
            - fragmail
            - splice
            - mms-checksum
          mm4:
            - avmonitor
            - block
            - oversize
            - quarantine
            - scan
            - avquery
            - bannedword
            - no-content-summary
            - archive-summary
            - archive-full
            - carrier-endpoint-bwl
            - remove-blocked
            - fragmail
            - splice
            - mms-checksum
          mm7:
            - avmonitor
            - block
            - oversize
            - quarantine
            - scan
            - avquery
            - bannedword
            - no-content-summary
            - archive-summary
            - archive-full
            - carrier-endpoint-bwl
            - remove-blocked
            - chunkedbypass
            - clientcomfort
            - servercomfort
            - strict-file
            - mms-checksum
          name: "ansible-test"

- 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 MMS profiles
      fortinet.fortimanager.fmgr_fact:
        facts:
          selector: "firewall_mmsprofile"
          params:
            adom: "FortiCarrier" # FortiCarrier only object, need a FortiCarrier adom
            mms-profile: "your_value"

返回值

常见的返回值已在此处记录，以下是此模块特有的字段

键	描述
meta 字典	请求的结果。 返回：始终
request_url 字符串	请求的完整URL。 返回：始终 示例： "/sys/login/user"
response_code 整数	API请求的状态。 返回：始终 示例： 0
response_data 列表 / 元素=字符串	API响应。 返回：始终
response_message 字符串	API响应的描述性消息。 返回：始终 示例： "OK."
system_information 字典	目标系统的信息。 返回：始终
rc 整数	请求的状态。 返回：始终 示例： 0
version_check_warning 列表 / 元素=字符串	如果剧本中使用的参数不受当前FortiManager版本支持，则会发出警告。 返回：复杂

作者

• 杜欣伟 (@dux-fortinet)

• 李星 (@lix-fortinet)

• 薛杰 (@JieX19)

• 郑链 (@chillancezen)

• 沈峰 (@fshen01)

• 陆宏斌 (@fgtdev-hblu)

收藏链接

• 问题跟踪器
• 主页
• 代码库 (源代码)