Модуль community.general.nexmo – отправка SMS с помощью Nexmo

Примечание

Этот модуль входит в коллекцию community.general (версия 12.6.1).

Возможно, эта коллекция уже установлена, если вы используете пакет ansible. Она не входит в состав ansible-core. Чтобы проверить, установлена ли она, выполните ansible-galaxy collection list.

Чтобы установить её, используйте: ansible-galaxy collection install community.general.

Чтобы использовать её в плейбуке, укажите: community.general.nexmo.

Краткое описание
Параметры
Атрибуты
Примеры

Краткое описание

Отправка SMS-сообщения с помощью Nexmo.

Параметры

Параметр	Комментарии
api_key string / обязательный	Ключ API Nexmo.
api_secret string / обязательный	Секретный ключ API Nexmo.
client_cert path	Файл цепочки сертификатов в формате PEM, используемый для аутентификации SSL-клиента. Этот файл также может содержать ключ; если ключ включён в него, параметр `client_key` не требуется.
client_key path	Файл в формате PEM, содержащий закрытый ключ для аутентификации SSL-клиента. Если `client_cert` содержит и сертификат, и ключ, этот параметр не требуется.
dest list / элементы=integer / обязательный	Номер(а) телефона, на который(ые) нужно отправить SMS-сообщение.
force boolean	Если `yes`, не использовать кэшированную копию. Варианты: `false` ← (по умолчанию) `true`
force_basic_auth boolean	Учётные данные, заданные с помощью `url_username` и `url_password`, следует передавать в заголовке HTTP. Варианты: `false` ← (по умолчанию) `true`
http_agent string	Значение заголовка для идентификации; обычно отображается в журналах веб-сервера. По умолчанию: `"ansible-httpget"`
msg string / обязательный	Текст сообщения для отправки. Сообщения длиной более 160 символов разделяются на несколько сообщений.
src integer / обязательный	Номер Nexmo, с которого отправляется сообщение.
url string	URL HTTP, HTTPS или FTP в формате (http\|https\|ftp)://[user[:pass]]@host.domain[:port]/path
url_password string	Пароль для базовой аутентификации HTTP. Если параметр `url_username` не указан, параметр `url_password` использоваться не будет.
url_username string	Имя пользователя для базовой аутентификации HTTP. Этот параметр можно использовать без `url_password` для сайтов, допускающих пустые пароли.
use_gssapi boolean добавлено в ansible-core 2.11	Использовать GSSAPI для аутентификации; обычно это Kerberos или Kerberos через аутентификацию Negotiate. Требуется установить библиотеку Python gssapi. Учётные данные GSSAPI можно задать с помощью `url_username`/`url_password` или переменной среды GSSAPI `KRB5CCNAME`, указывающей пользовательский кэш учётных данных Kerberos. Аутентификация NTLM не поддерживается, даже если установлен механизм GSSAPI для NTLM. Варианты: `false` ← (по умолчанию) `true`
use_proxy boolean	Если `no`, прокси использоваться не будет, даже если он задан в переменной среды на целевых узлах. Варианты: `false` `true` ← (по умолчанию)
validate_certs boolean	Если `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)

Ссылки на коллекцию

© 2012–2018 Michael DeHaan
© 2018–2025 Red Hat, Inc.
Licensed under the GNU General Public License version 3.
https://docs.ansible.com/projects/ansible/latest/collections/community/general/nexmo_module.html