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