community.general.pritunl_org_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_org_info。

community.general 2.5.0 中的新增功能

概要

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

参数

参数

注释

organization

别名：org

字符串

要搜索的 Pritunl 组织名称。如果未提供，则模块将返回所有 Pritunl 组织。

pritunl_api_secret

字符串 / 必需

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

pritunl_api_token

字符串 / 必需

Pritunl 管理员用户的 API 令牌。

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

pritunl_url

字符串 / 必需

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

validate_certs

布尔值

是否应验证证书。

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

选项

  • false

  • true ← (默认)

属性

属性

支持

描述

check_mode

支持：完全支持

此操作不会修改状态。

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

diff_mode

支持： N/A

此操作不会修改状态。

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

示例

- name: List all existing Pritunl organizations
  community.general.pritunl_org_info:

- name: Search for an organization named MyOrg
  community.general.pritunl_user_info:
    organization: MyOrg

返回值

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

键

描述

organizations

列表 / 元素=字典

Pritunl 组织列表。

返回：成功

示例： [{"auth_api": false, "auth_secret": null, "auth_token": null, "id": "csftwlu6uhralzi2dpmhekz3", "name": "FooOrg", "user_count": 0}, {"auth_api": false, "auth_secret": null, "auth_token": null, "id": "58070daee63f3b2e6e472c36", "name": "MyOrg", "user_count": 3}, {"auth_api": false, "auth_secret": null, "auth_token": null, "id": "v1sncsxxybnsylc8gpqg85pg", "name": "BarOrg", "user_count": 0}]

作者

  • Florian Dambrine (@Lowess)