Spec-Zone.ru › Ansible 2.11

community.general.nexmo – Отправка SMS-сообщения через nexmo

Примечание

Этот плагин является частью коллекции community.general (версия 2.0.1).

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

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

  • Обзор
  • Параметры
  • Примеры

Обзор

  • Отправка SMS-сообщения через nexmo

Параметры

Параметр Варианты/Значения по умолчанию Комментарии
api_key
строка / обязательно
Ключ API Nexmo
api_secret
строка / обязательно
Секретный ключ API Nexmo
client_cert
путь
Файл цепочки сертификатов в формате PEM для SSL-аутентификации клиента.
Этот файл также может содержать ключ, и если ключ включён, client_key не требуется.
client_key
путь
Файл в формате PEM, содержащий ваш закрытый ключ для SSL-аутентификации клиента.
Если client_cert содержит как сертификат, так и ключ, этот параметр не требуется.
dest
список / элементы=строка / обязательно
Номер(а) телефона(ов) для отправки SMS-сообщения
force
булево
    Варианты:
  • нет ←
  • да
Если yes не получить кэшированную копию.
Псевдоним thirsty устарел и будет удален в версии 2.13.

псевдонимы: thirsty
force_basic_auth
булево
    Варианты:
  • нет ←
  • да
Указанные в url_username и url_password учетные данные должны передаваться в HTTP-заголовке.
http_agent
строка
По умолчанию:
"ansible-httpget"
Идентификатор агента, обычно отображается в журнале веб-сервера.
msg
строка / обязательно
Текст сообщения для отправки. Сообщения, превышающие 160 символов, будут разбиты на несколько сообщений
src
целое число / обязательно
Номер Nexmo для отправки
url
строка
URL HTTP, HTTPS или FTP в формате (http|https|ftp)://[пользователь[:пароль]]@хост.домен[:порт]/путь
url_password
строка
Пароль для использования в HTTP-аутентификации по основанию.
Если параметр url_username не указан, параметр url_password не будет использоваться.
url_username
строка
Имя пользователя для использования в HTTP-аутентификации по основанию.
Этот параметр может использоваться без url_password для сайтов, допускающих пустые пароли
use_gssapi
булево
добавлен в 2.11 ansible.builtin
    Варианты:
  • нет ←
  • да
Использовать GSSAPI для выполнения аутентификации, обычно это для аутентификации Kerberos или Kerberos через Negotiate.
Требуется установка Python-библиотеки gssapi.
Учетные данные для GSSAPI можно указать с помощью url_username/url_password или с помощью переменной среды GSSAPI KRB5CCNAME, которая указывает на пользовательский кэш учетных данных Kerberos.
Аутентификация NTLM not поддерживается, даже если механизм GSSAPI для NTLM был установлен.
use_proxy
булево
    Варианты:
  • нет
  • да ←
Если no, прокси не будет использоваться, даже если он определён в переменной окружения на целевых хостах.
validate_certs
булево
    Варианты:
  • нет
  • да ←
Если no, сертификаты SSL не будут проверены. Это следует использовать только на сайтах, контролируемых лично, с использованием самозаверяемых сертификатов.

Примеры

- 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–2021 Red Hat, Inc.
Licensed under the GNU General Public License version 3.
https://docs.ansible.com/ansible/2.11/collections/community/general/nexmo_module.html

Spec-Zone.ru

Настройки Оффлайн Что нового Помощь О нас
Spec-Zone .ru
спецификации, руководства, описания, API