irc - Send a message to an IRC channel

Author:Jan-Piet Mens, Matt Martz

Synopsis

New in version 1.2.

Send a message to an IRC channel. This is a very simplistic implementation.

Options

parameter required default choices comments
channel yes
    Channel name
    color no none
    • none
    • yellow
    • red
    • green
    • blue
    • black
    Text color for the message. ("none" is a valid option in 1.6 or later, in 1.6 and prior, the default color is black, not "none").
    key no
      Channel key (added in Ansible 1.7)
      msg yes
        The message body.
        nick no ansible
          Nickname. May be shortened, depending on server's NICKLEN setting.
          passwd no
            Server password
            port no 6667
              IRC server port number
              server no localhost
                IRC server name/address
                timeout no 30
                  Timeout to use while waiting for successful registration and join messages, this is to prevent an endless loop (added in Ansible 1.5)

                  Note

                  Requires socket

                  Examples


                  - irc: server=irc.example.net channel="#t1" msg="Hello world"
                  
                  - local_action: irc port=6669
                                  channel="#t1"
                                  msg="All finished at {{ ansible_date_time.iso8601 }}"
                                  color=red
                                  nick=ansibleIRC
                  

                  Table Of Contents

                  Previous topic

                  hipchat - Send a message to hipchat

                  Next topic

                  jabber - Send a message to jabber user or chat room