community.general.pritunl_user_info 模块 – 使用 Pritunl API 列出 Pritunl 用户

注意

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

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

要安装它，请使用： ansible-galaxy collection install community.general。

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

community.general 2.3.0 中的新增功能

概要

  • 一个使用 Pritunl API 列出 Pritunl 用户的模块。

参数

参数

注释

organization

别名：org

字符串 / 必需

用户所属组织的名称。

pritunl_api_secret

字符串 / 必需

在管理员 > 用户名 > API 密钥中找到的 API 密钥。

pritunl_api_token

字符串 / 必需

Pritunl 管理员用户的 API 令牌。

需要在管理员 > 用户名 > 启用令牌身份验证中启用。

pritunl_url

字符串 / 必需

启用了 API 的 Pritunl 服务器的 URL 和端口。

user_name

字符串

要在 Pritunl 上进行过滤的用户名称。

user_type

字符串

用户 user_name 的类型。

选项

  • "client" ← (默认)

  • "server"

validate_certs

布尔值

是否应验证证书。

除非您非常确定与服务器的连接不会受到中间人攻击，否则绝不应将其设置为 false。

选项

  • false

  • true ← (默认)

属性

属性

支持

描述

check_mode

支持：完全支持

此操作不会修改状态。

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

diff_mode

支持： N/A

此操作不会修改状态。

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

示例

- name: List all existing users part of the organization MyOrg
  community.general.pritunl_user_info:
    state: list
    organization: MyOrg

- name: Search for the user named Florian part of the organization MyOrg
  community.general.pritunl_user_info:
    state: list
    organization: MyOrg
    user_name: Florian

返回值

常见的返回值已在此处记录，以下是此模块特有的字段

键

描述

users

列表 / 元素=字典

Pritunl 用户列表。

返回：成功

示例： [{"audit": false, "auth_type": "google", "bypass_secondary": false, "client_to_client": false, "disabled": false, "dns_mapping": null, "dns_servers": null, "dns_suffix": null, "email": "[email protected]", "gravatar": true, "groups": ["foo", "bar"], "id": "5d070dafe63q3b2e6s472c3b", "name": "[email protected]", "network_links": [], "organization": "58070daee6sf342e6e4s2c36", "organization_name": "Acme", "otp_auth": true, "otp_secret": "35H5EJA3XB2$4CWG", "pin": false, "port_forwarding": [], "servers": []}]

作者

  • Florian Dambrine (@Lowess)