Spec-Zone.ru › Ansible 2.10

community.general.irc – Отправка сообщения в канал IRC или нику

Примечание

Этот плагин входит в сборку community.general (версия 1.3.2).

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

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

  • Описание
  • Требования
  • Параметры
  • Примеры

Описание

  • Отправка сообщения в канал IRC или нику. Это очень упрощенная реализация.

Требования

Ниже перечислены требования, необходимые на хосте, который выполняет этот модуль.

  • socket

Параметры

Параметр Варианты/Значения по умолчанию Комментарии
channel
строка
Имя канала. Один из параметров nick_to или channel должен быть задан. Если оба заданы, сообщение будет отправлено и туда, и туда.
color
строка
    Варианты:
  • none ←
  • white
  • black
  • blue
  • green
  • red
  • brown
  • purple
  • orange
  • yellow
  • light_green
  • teal
  • light_cyan
  • light_blue
  • pink
  • gray
  • light_gray
Цвет текста сообщения. ("none" — допустимый вариант начиная с версии 1.6; в версиях 1.6 и ранее цвет по умолчанию — чёрный, а не "none"). Добавлены еще 11 цветов в версии 2.0.

Псевдонимы: colour
key
строка
Ключ канала
msg
строка / обязательно
Текст сообщения.
nick
строка
Значение по умолчанию:
"ansible"
Никнейм, с которого отправляется сообщение. Может быть сокращен, в зависимости от настройки NICKLEN сервера.
nick_to
список / элементы=строка
Список никнеймов, которым отправляется сообщение. Один из параметров nick_to или channel должен быть задан. Если оба определены, сообщение будет отправлено и туда, и туда.
part
булево
    Варианты:
  • no
  • yes ←
Определяет, должен ли пользователь покинуть канал после отправки сообщения. Полезно при использовании фейкового бота, чтобы избежать автоматических join/part между сообщениями.
passwd
строка
Пароль сервера
port
целое число
Значение по умолчанию:
6667
Порт сервера IRC
server
строка
Значение по умолчанию:
"localhost"
Имя/адрес сервера IRC
style
строка
    Варианты:
  • bold
  • underline
  • reverse
  • italic
  • none ←
Стиль текста сообщения. Обратите внимание, что italic не работает на некоторых клиентах.
timeout
целое число
Значение по умолчанию:
30
Таймаут ожидания успешной регистрации и сообщения о присоединении, чтобы предотвратить бесконечный цикл
topic
строка
Установить тему канала
use_ssl
булево
    Варианты:
  • no ←
  • yes
Указывает, следует ли использовать TLS/SSL при подключении к серверу IRC

Примеры

- name: Send a message to an IRC channel from nick ansible
  community.general.irc:
    server: irc.example.net
    channel: #t1
    msg: Hello world

- name: Send a message to an IRC channel
  local_action:
    module: irc
    port: 6669
    server: irc.example.net
    channel: #t1
    msg: 'All finished at {{ ansible_date_time.iso8601 }}'
    color: red
    nick: ansibleIRC

- name: Send a message to an IRC channel
  local_action:
    module: irc
    port: 6669
    server: irc.example.net
    channel: #t1
    nick_to:
      - nick1
      - nick2
    msg: 'All finished at {{ ansible_date_time.iso8601 }}'
    color: red
    nick: ansibleIRC

Авторы

  • Jan-Piet Mens (@jpmens)
  • Matt Martz (@sivel)

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

Spec-Zone.ru

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