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