irc - Отправка сообщения в канал IRC
Описание
- Отправка сообщения в канал IRC. Это очень упрощенная реализация.
Требования (к хосту, на котором выполняется модуль)
- socket
Параметры
| параметр | обязательно | по умолчанию | значения | комментарии |
|---|---|---|---|---|
| channel | да | Имя канала. Нужно указать либо nick_to, либо channel. Если оба параметра указаны, сообщение будет отправлено и в nick_to, и в channel. | ||
| color | нет | none |
| Цвет текста сообщения. ("none" — допустимое значение начиная с версии 1.6. В версии 1.6 и ранее по умолчанию был чёрный цвет, а не "none"). Добавлены ещё 11 цветов в версии 2.0. |
| key (добавлено в 1.7)
| нет | Ключ канала | ||
| msg | да | Тело сообщения. | ||
| nick | нет | ansible | Никнейм для отправки сообщения. Может быть сокращён в зависимости от настроек сервера NICKLEN. | |
| nick_to (добавлено в 2.0)
| нет | Список никнеймов, которым будет отправлено сообщение. Нужно указать либо nick_to, либо channel. Если оба параметра указаны, сообщение будет отправлено и в nick_to, и в channel. | ||
| part (добавлено в 2.0)
| нет | True | Определяет, должен ли пользователь покинуть канал после отправки сообщения. Полезно при использовании фейкового бота, чтобы избежать присоединений/выходов между сообщениями. | |
| passwd | нет | Пароль сервера | ||
| port | нет | 6667 | Порт сервера IRC | |
| server | нет | localhost | Имя/адрес сервера IRC | |
| style (добавлено в 2.0)
| нет | None |
| Стиль текста сообщения. Обратите внимание, что italic может не работать на некоторых клиентах |
| timeout (добавлено в 1.5)
| нет | 30 | Таймаут для ожидания успешной регистрации и присоединения к каналу, предотвращает бесконечный цикл | |
| topic (добавлено в 2.0)
| нет | Установить тему канала | ||
| use_ssl (добавлено в 1.8)
| нет | Указывает, следует ли использовать 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 и Разработка модулей.
© 2012–2018 Michael DeHaan
© 2018–2019 Red Hat, Inc.
Licensed under the GNU General Public License version 3.
https://docs.ansible.com/ansible/2.4/irc_module.html