fortinet.fortimanager.fmgr_extendercontroller_extenderprofile_cellular_smsnotification 模块 – FortiExtender 蜂窝 SMS 通知配置。

注意

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

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

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

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

fortinet.fortimanager 2.1.0 中的新增功能

概要

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

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

参数

参数

注释

access_token

字符串

用于在不使用用户名和密码的情况下访问 FortiManager 的令牌。

adom

字符串 / 必需

请求 URL 中的参数 (adom)。

bypass_validation

布尔值

仅当模块架构与 FortiManager API 结构不同时才设置为 True，模块将继续执行而不验证参数。

选择

  • false ← (默认)

  • true

enable_log

布尔值

启用/禁用任务的日志记录。

选择

  • false ← (默认)

  • true

extender-profile

字符串

已弃用，请使用“extender_profile”

extender_profile

字符串

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

extendercontroller_extenderprofile_cellular_smsnotification

字典

顶层参数集。

alert

字典

警报。

data_exhausted

别名：data-exhausted

字符串

当数据耗尽时显示的字符串。

fgt_backup_mode_switch

别名：fgt-backup-mode-switch

字符串

当 FortiGate 备份模式切换时显示的字符串。

low_signal_strength

别名：low-signal-strength

字符串

当信号强度低时显示的字符串。

mode_switch

别名：mode-switch

字符串

当模式切换时显示的字符串。

os_image_fallback

别名：os-image-fallback

字符串

当回退到先前的操作系统映像时显示的字符串。

session_disconnect

别名：session-disconnect

字符串

当会话断开连接时显示的字符串。

system_reboot

别名：system-reboot

字符串

当系统重新启动时显示的字符串。

receiver

列表 / 元素=字典

接收者。

alert

列表 / 元素=字符串

警报多项选择。

选择

  • "system-reboot"

  • "data-exhausted"

  • "session-disconnect"

  • "low-signal-strength"

  • "mode-switch"

  • "os-image-fallback"

  • "fgt-backup-mode-switch"

name

字符串

FortiExtender SMS 通知接收者名称。

phone_number

别名：phone-number

字符串

接收者电话号码。

status

字符串

SMS 通知接收者状态。

选择

  • "disable"

  • "enable"

status

字符串

FortiExtender SMS 通知状态。

选择

  • "disable"

  • "enable"

forticloud_access_token

字符串

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

proposed_method

字符串

覆盖底层 Json RPC 请求的方法。

选择

  • "update"

  • "set"

  • "add"

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 有助于完成此工作。

  • 通常，当返回非零 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: FortiExtender cellular SMS notification configuration.
      fortinet.fortimanager.fmgr_extendercontroller_extenderprofile_cellular_smsnotification:
        # 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>
        extender_profile: <your own value>
        extendercontroller_extenderprofile_cellular_smsnotification:
          alert:
            data_exhausted: <string>
            fgt_backup_mode_switch: <string>
            low_signal_strength: <string>
            mode_switch: <string>
            os_image_fallback: <string>
            session_disconnect: <string>
            system_reboot: <string>
          receiver:
            -
              alert:
                - "system-reboot"
                - "data-exhausted"
                - "session-disconnect"
                - "low-signal-strength"
                - "mode-switch"
                - "os-image-fallback"
                - "fgt-backup-mode-switch"
              name: <string>
              phone_number: <string>
              status: <value in [disable, enable]>
          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 版本支持，则会发出警告。

返回: 复杂类型

作者

  • Xinwei Du (@dux-fortinet)

  • Xing Li (@lix-fortinet)

  • Jie Xue (@JieX19)

  • Link Zheng (@chillancezen)

  • Frank Shen (@fshen01)

  • Hongbin Lu (@fgtdev-hblu)