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

Примеры

- irc:
    server: irc.example.net
    channel: #t1
    msg: Hello world

- local_action:
    module: irc
    port: 6669
    server: irc.example.net
    channel: #t1
    msg: 'All finished at {{ ansible_date_time.iso8601 }}'
    color: red
    nick: ansibleIRC

- 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

Статус

В этом модуле гарантированы изменения интерфейса, совместимые с предыдущими версиями. [stableinterface]
Этот модуль поддерживается сообществом Ansible. [community]

Авторы

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.9/modules/irc_module.html