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

Примечание

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

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

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

Чтобы использовать модуль в плейбуке, укажите: community.general.irc.

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

Краткое описание

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

Требования

На узле, выполняющем этот модуль, должны быть установлены следующие компоненты.

socket

Параметры

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

Атрибуты

Атрибут	Поддержка	Описание
check_mode	Поддержка: полная	Может работать в режиме `check_mode` и возвращать прогноз изменения статуса, не изменяя целевой объект.
diff_mode	Поддержка: нет	В режиме сравнения возвращает сведения об изменениях (или о том, что, возможно, нужно изменить в `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–2025 Red Hat, Inc.
Licensed under the GNU General Public License version 3.
https://docs.ansible.com/projects/ansible/latest/collections/community/general/irc_module.html