community.general.ejabberd_user 模块 – 管理 ejabberd 服务器的用户

注意

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

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

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

要在 playbook 中使用它，请指定：community.general.ejabberd_user。

概要

  • 此模块提供 ejabberd 服务器的用户管理功能。

要求

在执行此模块的主机上需要以下要求。

  • 带有 mod_admin_extra 模块的 ejabberd。

参数

参数

注释

host

字符串 / 必需

与用户名关联的 ejabberd 主机。

password

字符串

要分配给用户名的密码。

state

字符串

描述要管理的用户所需的状态。

选项

  • "present" ← (默认)

  • "absent"

username

字符串 / 必需

要管理的用户名。

属性

属性

支持

描述

check_mode

支持：完全支持

可以在 check_mode 下运行，并在不修改目标的情况下返回更改状态预测。

diff_mode

支持：不支持

在差异模式下，将返回有关已更改内容（或可能需要在 check_mode 下更改的内容）的详细信息。

备注

注意

  • 只有当 state == present 时才需要 password 参数。

  • 对于此版本，密码必须以明文形式存储。

  • ejabberd 配置文件必须包含 mod_admin_extra 作为模块。

示例

# Example playbook entries using the ejabberd_user module to manage users state.

- name: Create a user if it does not exist
  community.general.ejabberd_user:
    username: test
    host: server
    password: password

- name: Delete a user if it exists
  community.general.ejabberd_user:
    username: test
    host: server
    state: absent

作者

  • Peter Sprygada (@privateip)