community.general.irc module – Send a message to an IRC channel or a nick
Note
This module is part of the community.general collection (version 9.5.0).
You might already have this collection installed if you are using the ansible
package.
It is not included in ansible-core
.
To check whether it is installed, run ansible-galaxy collection list
.
To install it, use: ansible-galaxy collection install community.general
.
You need further requirements to be able to use this module,
see Requirements for details.
To use it in a playbook, specify: community.general.irc
.
Synopsis
Send a message to an IRC channel or a nick. This is a very simplistic implementation.
Requirements
The below requirements are needed on the host that executes this module.
socket
Parameters
Parameter |
Comments |
---|---|
Channel name. One of nick_to or channel needs to be set. When both are set, the message will be sent to both of them. |
|
Text color for the message. Choices:
|
|
Channel key |
|
The message body. |
|
Nickname to send the message from. May be shortened, depending on server’s NICKLEN setting. Default: |
|
A list of nicknames to send the message to. One of nick_to or channel needs to be set. When both are defined, the message will be sent to both of them. |
|
Designates whether user should part from channel after sending message or not. Useful for when using a faux bot and not wanting join/parts between messages. Choices:
|
|
Server password |
|
IRC server port number Default: |
|
IRC server name/address Default: |
|
Text style for the message. Note italic does not work on some clients Choices:
|
|
Timeout to use while waiting for successful registration and join messages, this is to prevent an endless loop Default: |
|
Set the channel topic |
|
Designates whether TLS/SSL should be used when connecting to the IRC server
Note: for security reasons, you should always set The option currently defaults to Choices:
|
|
If set to This should always be set to Note: for security reasons, you should always set The option currently defaults to Choices:
|
Attributes
Attribute |
Support |
Description |
---|---|---|
Support: full |
Can run in |
|
Support: none |
Will return details on what has changed (or possibly needs changing in |
Examples
- 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