Модуль community.general.nexmo – Отправка SMS через Nexmo

Примечание

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

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

Для установки используйте: ansible-galaxy collection install community.general.

Для использования в playbook, укажите: community.general.nexmo.

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

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

Отправить SMS-сообщение через Nexmo

Параметры

Параметр	Комментарии
api_key string / required	Ключ API Nexmo
api_secret string / required	Секретный ключ API Nexmo
client_cert path	Файл цепочки сертификатов в формате PEM, который будет использоваться для проверки подлинности клиента SSL. Этот файл может также включать ключ, и если ключ включен, `client_key` не требуется.
client_key path	Файл в формате PEM, содержащий ваш закрытый ключ, который будет использоваться для проверки подлинности клиента SSL. Если `client_cert` содержит как сертификат, так и ключ, этот параметр не требуется.
dest list / elements=integer / required	Номер(а) телефона(ов), на который(ые) нужно отправить SMS-сообщение
force boolean	Если `yes`, не получать кэшированную копию. Варианты: `false` ← (по умолчанию) `true`
force_basic_auth boolean	Учётные данные, указанные с помощью `url_username` и `url_password`, должны передаваться в HTTP-заголовке. Варианты: `false` ← (по умолчанию) `true`
http_agent string	Заголовок для идентификации, обычно отображается в логах веб-сервера. По умолчанию: `"ansible-httpget"`
msg string / required	Текст сообщения для отправки. Сообщения длиннее 160 символов будут разделены на несколько сообщений.
src integer / required	Номер 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	Поддержка: нет	Возвратит детали изменений (или, возможно, необходимых изменений в `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–2024 Red Hat, Inc.
Licensed under the GNU General Public License version 3.
https://docs.ansible.com/ansible/latest/collections/community/general/nexmo_module.html