community.general.irc 模块 – 向 IRC 频道或昵称发送消息

注意

此模块是 community.general 集合（版本 10.1.0）的一部分。

如果您正在使用 ansible 包，您可能已经安装了这个集合。它不包含在 ansible-core 中。要检查是否已安装，请运行 ansible-galaxy collection list。

要安装它，请使用：ansible-galaxy collection install community.general。您需要更多要求才能使用此模块，请参阅要求了解详细信息。

要在 playbook 中使用它，请指定：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 布尔值	指定用户在发送消息后是否应离开频道。当使用伪机器人并且不希望在消息之间加入/离开时很有用。选择 `false` `true` ←（默认）
passwd 字符串	服务器密码
port 整数	IRC 服务器端口号默认值： `6667`
server 字符串	IRC 服务器名称/地址默认值： `"localhost"`
style 字符串	消息的文本样式。请注意，斜体在某些客户端上不起作用选择 `"bold"` `"underline"` `"reverse"` `"italic"` `"none"` ←（默认）
timeout 整数	等待成功注册和加入消息时使用的超时时间，这是为了防止无休止的循环默认值： `30`
topic 字符串	设置频道主题
use_tls 别名：use_ssl 布尔值	指定在连接到 IRC 服务器时是否应使用 TLS/SSL `use_tls` 自 community.general 8.1.0 起可用，在此之前，该选项专门称为 `use_ssl`。后者现在是 `use_tls` 的别名。注意：出于安全原因，您应尽可能始终设置 `use_tls=true` 和 `validate_certs=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`。此选项的默认值在 community.general 10.0.0 中更改为 `true`。选择 `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)