Ansible 社区文档

community.general.nexmo 模块 – 通过 nexmo 发送短信

注意

此模块是 community.general 集合（版本 10.1.0）的一部分。

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

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

要在剧本中使用它，请指定：community.general.nexmo。

概要 

通过 nexmo 发送短信消息

参数 

参数	注释
api_key 字符串 / 必需	Nexmo API 密钥
api_secret 字符串 / 必需	Nexmo API 密钥
client_cert 路径	用于 SSL 客户端身份验证的 PEM 格式的证书链文件。此文件也可以包含密钥，如果包含密钥，则不需要 `client_key`。
client_key 路径	包含用于 SSL 客户端身份验证的私钥的 PEM 格式文件。如果 `client_cert` 包含证书和密钥，则不需要此选项。
dest 列表 / elements=整数 / 必需	要向其发送短信的电话号码
force 布尔值	如果 `yes`，则不获取缓存的副本。选项 `false` ←（默认） `true`
force_basic_auth 布尔值	使用 `url_username` 和 `url_password` 指定的凭据应在 HTTP 标头中传递。选项 `false` ←（默认） `true`
http_agent 字符串	用于标识的标头，通常出现在 Web 服务器日志中。默认值： `"ansible-httpget"`
msg 字符串 / 必需	要发送的短信消息。超过 160 个字符的消息将被拆分为多条消息
src 整数 / 必需	用于发送的 Nexmo 号码
url 字符串	形式为 (http\|https\|ftp)://[user[:pass]]@host.domain[:port]/path 的 HTTP、HTTPS 或 FTP URL
url_password 字符串	用于 HTTP 基本身份验证的密码。如果未指定 `url_username` 参数，则不会使用 `url_password` 参数。
url_username 字符串	用于 HTTP 基本身份验证的用户名。此参数可以与 `url_password` 一起使用，以用于允许空密码的站点
use_gssapi 布尔值在 ansible-core 2.11 中添加	使用 GSSAPI 执行身份验证，通常用于 Kerberos 或通过 Negotiate 身份验证的 Kerberos。需要安装 Python 库 gssapi。可以使用 `url_username`/`url_password` 或 GSSAPI 环境变量 `KRB5CCNAME` 来指定 GSSAPI 的凭据，该变量指定自定义 Kerberos 凭据缓存。即使已安装 NTLM 的 GSSAPI 机制，也不支持 NTLM 身份验证。选项 `false` ←（默认） `true`
use_proxy 布尔值	如果 `no`，即使在目标主机上的环境变量中定义了代理，也不会使用代理。选项 `false` `true` ←（默认）
validate_certs 布尔值	如果 `false`，则不会验证 SSL 证书。这应仅在个人控制的使用自签名证书的站点上使用。选项 `false` `true` ←（默认）

属性 

属性	支持	描述
check_mode	支持：无	可以在 `check_mode` 中运行，并返回更改的状态预测，而无需修改目标。
diff_mode	支持：无	当处于 diff 模式时，将返回有关已更改（或可能需要在 `check_mode` 中更改）的详细信息。

示例 

- name: Send notification message via Nexmo
  community.general.nexmo:
    api_key: 640c8a53
    api_secret: 0ce239a6
    src: 12345678901
    dest:
      - 10987654321
      - 16789012345
    msg: '{{ inventory_hostname }} completed'
  delegate_to: localhost

作者

Matt Martz (@sivel)

集合链接