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