irc – Отправка сообщения в канал IRC
Описание
- Отправка сообщения в канал IRC. Это очень упрощенная реализация.
Требования
Ниже перечислены требования к хосту, на котором выполняется этот модуль.
- socket
Параметры
| Параметр | Варианты/Значения по умолчанию | Комментарии |
|---|---|---|
| channel - / обязательно | Имя канала. Необходимо указать либо nick_to, либо channel. Если оба параметра указаны, сообщение будет отправлено и туда, и туда. | |
| color - |
| Цвет текста сообщения. («none» — допустимый вариант начиная с версии 1.6. В версиях 1.6 и ранее значение по умолчанию — чёрный, а не «none»). Добавлены ещё 11 цветов в версии 2.0. |
| key - | Ключ канала | |
| msg - / обязательно | Тело сообщения. | |
| nick - | Значение по умолчанию: "ansible" | Никнейм для отправки сообщения. Может быть сокращён в зависимости от параметра NICKLEN сервера. |
| nick_to - добавлено в 2.0 | Список никнеймов для отправки сообщения. Необходимо указать либо nick_to, либо channel. Если оба параметра указаны, сообщение будет отправлено и туда, и туда. | |
| part boolean добавлено в 2.0 |
| Указывает, нужно ли покинуть канал после отправки сообщения. Полезно при использовании фейкового бота, чтобы не вызывать join/part между сообщениями. |
| passwd - | Пароль к серверу | |
| port - | Значение по умолчанию: 6667 | Номер порта сервера IRC |
| server - | Значение по умолчанию: "localhost" | Имя/адрес сервера IRC |
| style - добавлено в 2.0 |
| Стиль текста сообщения. Обратите внимание, что курсив может не работать на некоторых клиентах. |
| timeout - | Значение по умолчанию: 30 | Таймаут ожидания успешной регистрации и сообщений о входе в канал, чтобы предотвратить бесконечный цикл |
| topic - добавлено в 2.0 | Установить тему канала | |
| use_ssl boolean |
| Указывает, нужно ли использовать 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.8/modules/irc_module.html
