fortinet.fortimanager.fmgr_extensioncontroller_extenderprofile_cellular_smsnotification 模块 – FortiExtender 蜂窝短信通知配置。

注意

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

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

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

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

fortinet.fortimanager 2.2.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)。

extensioncontroller_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 短信通知接收器名称。

phone_number

别名：phone-number

字符串

接收器电话号码。

status

字符串

短信通知接收器状态。

选项

  • "disable"

  • "enable"

status

字符串

FortiExtender 短信通知状态。

选项

  • "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，值可以是 global 和其他包括 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_extensioncontroller_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>
        extensioncontroller_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)

字典

请求的结果。

返回值：始终返回

请求URL (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)