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

Примечание

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

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

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

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

Описание

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

Требования

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

socket

Параметры

Параметр	Варианты/Значения по умолчанию	Комментарии
channel строка		Имя канала. Необходимо установить значение одного из параметров nick_to или channel. Если оба параметра установлены, сообщение будет отправлено в оба.
color строка	Варианты: none ← белый чёрный синий зелёный красный коричневый фиолетовый оранжевый жёлтый светло-зелёный бирюзовый светло-голубой светло-синий розовый серый светло-серый	Цвет текста сообщения. ("none" - допустимый вариант начиная с 1.6, в 1.6 и ранее по умолчанию был чёрный цвет, а не "none"). Добавлены ещё 11 цветов в версии 2.0. псевдонимы: colour
key строка		Ключ канала
msg строка / обязательно		Тело сообщения.
nick строка	Значение по умолчанию: "ansible"	Псевдоним для отправки сообщения. Может быть сокращён в зависимости от настроек сервера NICKLEN.
nick_to список / элементы=строка		Список псевдонимов для отправки сообщения. Необходимо установить значение одного из параметров nick_to или channel. Если оба параметра определены, сообщение будет отправлено обоим.
part булево	Варианты: нет да ←	Определяет, должен ли пользователь покинуть канал после отправки сообщения. Полезно при использовании фальшивого бота и если не нужно присоединяться/выходить из канала между сообщениями.
passwd строка		Пароль сервера
port целое число	Значение по умолчанию: 6667	Порт сервера IRC
server строка	Значение по умолчанию: "localhost"	Имя/адрес сервера IRC
style строка	Варианты: полужирный подчёркнутый обратный курсив нет ←	Стиль текста сообщения. Обратите внимание, что курсив может не работать на некоторых клиентах
timeout целое число	Значение по умолчанию: 30	Таймаут, используемый при ожидании успешной регистрации и сообщений о присоединении, это предотвращает бесконечный цикл
topic строка		Установить тему канала
use_ssl булево	Варианты: нет ← да	Определяет, следует ли использовать 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–2021 Red Hat, Inc.
Licensed under the GNU General Public License version 3.
https://docs.ansible.com/ansible/2.11/collections/community/general/irc_module.html