fortinet.fortimanager.fmgr_extendercontroller_extenderprofile_cellular_smsnotification_alert 模块 – 短信告警列表。

注意

此模块是 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_alert。

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 字符串	系统重启时显示的字符串。
forticloud_access_token 字符串	使用 forticloud API 访问令牌验证 Ansible 客户端。
proposed_method 字符串	用于底层 Json RPC 请求的覆盖方法。选择 `"update"` `"set"` `"add"`
rc_failed 列表 / elements=整数	将覆盖失败条件的 rc 代码列表。
rc_succeeded 列表 / elements=整数	将覆盖成功条件的 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: SMS alert list.
      fortinet.fortimanager.fmgr_extendercontroller_extenderprofile_cellular_smsnotification_alert:
        # 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>

返回值 

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

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

作者

Xinwei Du (@dux-fortinet)
Xing Li (@lix-fortinet)
Jie Xue (@JieX19)
Link Zheng (@chillancezen)
Frank Shen (@fshen01)
Hongbin Lu (@fgtdev-hblu)