fortinet.fortimanager.fmgr_firewall_mmsprofile_notification 模块 – 通知配置。

注意

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

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

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

要在 playbook 中使用它，请指定：fortinet.fortimanager.fmgr_firewall_mmsprofile_notification。

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_notification

字典

设置的顶级参数。

alert_int

别名: alert-int

整数

警报通知发送间隔。

alert_int_mode

别名: alert-int-mode

字符串

警报通知间隔模式。

选项

  • "hours"

  • "minutes"

alert_src_msisdn

别名: alert-src-msisdn

字符串

指定警报消息的来源地址。

alert_status

别名: alert-status

字符串

警报通知状态。

选项

  • "disable"

  • "enable"

bword_int

别名: bword-int

整数

禁用字词通知发送间隔。

bword_int_mode

别名: bword-int-mode

字符串

禁用字词通知间隔模式。

选项

  • "hours"

  • "minutes"

bword_status

别名: bword-status

字符串

禁用字词通知状态。

选项

  • "disable"

  • "enable"

carrier_endpoint_bwl_int

别名: carrier-endpoint-bwl-int

整数

运营商端点黑/白名单通知发送间隔。

carrier_endpoint_bwl_int_mode

别名: carrier-endpoint-bwl-int-mode

字符串

运营商端点黑/白名单通知间隔模式。

选项

  • "hours"

  • "minutes"

carrier_endpoint_bwl_status

别名: carrier-endpoint-bwl-status

字符串

运营商端点黑/白名单通知状态。

选项

  • "disable"

  • "enable"

days_allowed

别名: days-allowed

列表 / 元素=字符串

可以发送通知消息的星期几。

选项

  • "sunday"

  • "monday"

  • "tuesday"

  • "wednesday"

  • "thursday"

  • "friday"

  • "saturday"

detect_server

别名: detect-server

字符串

启用/禁用自动服务器地址确定。

选项

  • "disable"

  • "enable"

dupe_int

别名: dupe-int

整数

重复通知发送间隔。

dupe_int_mode

别名: dupe-int-mode

字符串

重复通知间隔模式。

选项

  • "hours"

  • "minutes"

dupe_status

别名: dupe-status

字符串

重复通知状态。

选项

  • "disable"

  • "enable"

file_block_int

别名: file-block-int

整数

文件阻止通知发送间隔。

file_block_int_mode

别名: file-block-int-mode

字符串

文件阻止通知间隔模式。

选项

  • "hours"

  • "minutes"

file_block_status

别名: file-block-status

字符串

文件阻止通知状态。

选项

  • "disable"

  • "enable"

flood_int

别名: flood-int

整数

泛洪通知发送间隔。

flood_int_mode

别名: flood-int-mode

字符串

泛洪通知间隔模式。

选项

  • "hours"

  • "minutes"

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 校验和通知间隔模式。

选项

  • "hours"

  • "minutes"

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 上发送彩信消息的端口

mmsc_url

别名: mmsc-url

字符串

用于在 MMSC 上发送彩信消息的 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

字符串

病毒通知间隔模式。

选项

  • "hours"

  • "minutes"

virus_status

别名: virus-status

字符串

病毒通知状态。

选项

  • "disable"

  • "enable"

forticloud_access_token

字符串

使用 forticloud API 访问令牌验证 Ansible 客户端。

mms-profile

字符串

已弃用，请使用“mms_profile”

mms_profile

字符串

请求 URL 中的参数 (mms-profile)。

proposed_method

字符串

用于底层 Json RPC 请求的重写方法。

选项

  • "update"

  • "set"

  • "add"

rc_failed

list / elements=integer

将覆盖失败条件的 rc 代码列表。

rc_succeeded

list / elements=integer

将覆盖成功条件的 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 帮助完成这项工作。

  • 通常，当返回非零 rc 时，运行一个模块可能会失败。您还可以使用参数 rc_failed 和 rc_succeeded 覆盖失败或成功的条件

示例

- name: Example playbook (generated based on argument schema)
  hosts: fortimanagers
  connection: httpapi
  vars:
    ansible_httpapi_use_ssl: true
    ansible_httpapi_validate_certs: false
    ansible_httpapi_port: 443
  tasks:
    - name: Notification configuration.
      fortinet.fortimanager.fmgr_firewall_mmsprofile_notification:
        # 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>
        mms_profile: <your own value>
        firewall_mmsprofile_notification:
          alert_int: <integer>
          alert_int_mode: <value in [hours, minutes]>
          alert_src_msisdn: <string>
          alert_status: <value in [disable, enable]>
          bword_int: <integer>
          bword_int_mode: <value in [hours, minutes]>
          bword_status: <value in [disable, enable]>
          carrier_endpoint_bwl_int: <integer>
          carrier_endpoint_bwl_int_mode: <value in [hours, minutes]>
          carrier_endpoint_bwl_status: <value in [disable, enable]>
          days_allowed:
            - "sunday"
            - "monday"
            - "tuesday"
            - "wednesday"
            - "thursday"
            - "friday"
            - "saturday"
          detect_server: <value in [disable, enable]>
          dupe_int: <integer>
          dupe_int_mode: <value in [hours, minutes]>
          dupe_status: <value in [disable, enable]>
          file_block_int: <integer>
          file_block_int_mode: <value in [hours, minutes]>
          file_block_status: <value in [disable, enable]>
          flood_int: <integer>
          flood_int_mode: <value in [hours, minutes]>
          flood_status: <value in [disable, enable]>
          from_in_header: <value in [disable, enable]>
          mms_checksum_int: <integer>
          mms_checksum_int_mode: <value in [hours, minutes]>
          mms_checksum_status: <value in [disable, enable]>
          mmsc_hostname: <string>
          mmsc_password: <list or string>
          mmsc_port: <integer>
          mmsc_url: <string>
          mmsc_username: <string>
          msg_protocol: <value in [mm1, mm3, mm4, ...]>
          msg_type: <value in [submit-req, deliver-req]>
          protocol: <string>
          rate_limit: <integer>
          tod_window_duration: <string>
          tod_window_end: <string>
          tod_window_start: <string>
          user_domain: <string>
          vas_id: <string>
          vasp_id: <string>
          virus_int: <integer>
          virus_int_mode: <value in [hours, minutes]>
          virus_status: <value in [disable, enable]>

返回值

通用返回值记录在这里，以下是此模块独有的字段

键

描述

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 版本不支持 playbook 中使用的参数，则发出警告。

返回值: 复杂

作者

  • Xinwei Du (@dux-fortinet)

  • Xing Li (@lix-fortinet)

  • Jie Xue (@JieX19)

  • Link Zheng (@chillancezen)

  • Frank Shen (@fshen01)

  • Hongbin Lu (@fgtdev-hblu)