Модуль community.general.irc – Отправка сообщения в IRC-канал или ник

Примечание

Этот модуль является частью коллекции community.general (версия 9.5.0).

Возможно, эта коллекция уже установлена, если вы используете пакет ansible. Она не включена в ansible-core. Чтобы проверить установку, выполните ansible-galaxy collection list.

Для установки используйте: ansible-galaxy collection install community.general. Для использования этого модуля требуются дополнительные компоненты. Подробности см. в разделе Требования.

Для использования в книге задач укажите: community.general.irc.

Описание
Требования
Параметры
Атрибуты
Примеры

Описание

Отправка сообщения в IRC-канал или ник. Это очень упрощенная реализация.

Требования

Ниже перечислены требования, необходимые на хосте, на котором выполняется этот модуль.

socket

Параметры

Параметр	Комментарии
channel строка	Имя канала. Необходимо задать один из параметров nick_to или channel. Если оба установлены, сообщение будет отправлено и в канал, и нику.
color псевдонимы: colour строка	Цвет текста сообщения. Варианты: `"none"` ← (по умолчанию) `"white"` `"black"` `"blue"` `"green"` `"red"` `"brown"` `"purple"` `"orange"` `"yellow"` `"light_green"` `"teal"` `"light_cyan"` `"light_blue"` `"pink"` `"gray"` `"light_gray"`
key строка	Ключ канала
msg строка / обязательно	Тело сообщения.
nick строка	Никнейм для отправки сообщения. Может быть укорочен в зависимости от настроек сервера NICKLEN. По умолчанию: `"ansible"`
nick_to список / элементы=строка	Список никнеймов для отправки сообщения. Необходимо задать один из параметров nick_to или channel. Если оба определены, сообщение будет отправлено и в указанные ники, и в канал.
part логическое	Указывает, должен ли пользователь покинуть канал после отправки сообщения. Полезно при использовании фейкового бота, чтобы не было лишних join/part между сообщениями. Варианты: `false` `true` ← (по умолчанию)
passwd строка	Пароль сервера
port целое число	Номер порта IRC-сервера По умолчанию: `6667`
server строка	Имя/адрес IRC-сервера По умолчанию: `"localhost"`
style строка	Стиль текста сообщения. Обратите внимание, что курсив может не работать на некоторых клиентах Варианты: `"bold"` `"underline"` `"reverse"` `"italic"` `"none"` ← (по умолчанию)
timeout целое число	Таймаут для ожидания успешной регистрации и вступления в канал, чтобы избежать бесконечного цикла По умолчанию: `30`
topic строка	Установить тему канала
use_tls псевдонимы: use_ssl логическое	Указывает, следует ли использовать TLS/SSL при подключении к IRC-серверу `use_tls` доступен с community.general 8.1.0, ранее этот параметр назывался `use_ssl`. Последний теперь является псевдонимом для `use_tls`. Примечание: по соображениям безопасности, вы всегда должны устанавливать `use_tls=true` и `validate_certs=true`, когда это возможно. В настоящее время параметр по умолчанию `false`. По умолчанию был устаревший и изменится на `true` в community.general 10.0.0. Чтобы избежать предупреждений об устаревании, явно задайте этому параметру значение (в идеале `true`). Варианты: `false` `true`
validate_certs логическое добавлен в community.general 8.1.0	Если установлено `false`, сертификаты SSL не будут проверены. Это всегда должно быть установлено в `true`. Использование `false` небезопасно и должно применяться только в том случае, если известно, что сеть между Ansible и IRC-сервером безопасна. Примечание: по соображениям безопасности, вы всегда должны устанавливать `use_tls=true` и `validate_certs=true` когда это возможно. В настоящее время параметр по умолчанию `false`. По умолчанию был устаревшим и изменится на `true` в community.general 10.0.0. Чтобы избежать предупреждений об устаревании, явно задайте этому параметру значение (в идеале `true`). Варианты: `false` `true`

Атрибуты

Атрибут	Поддержка	Описание
check_mode	Поддержка: полная	Может работать в режиме `check_mode` и возвращать прогноз о статусе изменения без модификации целевого объекта.
diff_mode	Поддержка: отсутствует	При работе в режиме diff вернет информацию о том, что изменилось (или, возможно, нуждается в изменении в `check_mode`).

Примеры

- name: Send a message to an IRC channel from nick ansible
  community.general.irc:
    server: irc.example.net
    use_tls: true
    validate_certs: true
    channel: #t1
    msg: Hello world

- name: Send a message to an IRC channel
  local_action:
    module: irc
    port: 6669
    server: irc.example.net
    use_tls: true
    validate_certs: true
    channel: #t1
    msg: 'All finished at {{ ansible_date_time.iso8601 }}'
    color: red
    nick: ansibleIRC

- name: Send a message to an IRC channel
  local_action:
    module: irc
    port: 6669
    server: irc.example.net
    use_tls: true
    validate_certs: true
    channel: #t1
    nick_to:
      - nick1
      - nick2
    msg: 'All finished at {{ ansible_date_time.iso8601 }}'
    color: red
    nick: ansibleIRC

Авторы

Jan-Piet Mens (@jpmens)
Matt Martz (@sivel)

Ссылки на сборник

© 2012–2018 Michael DeHaan
© 2018–2024 Red Hat, Inc.
Licensed under the GNU General Public License version 3.
https://docs.ansible.com/ansible/latest/collections/community/general/irc_module.html