community.general.pritunl_org 模块 – 使用 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。

community.general 2.5.0 中的新增功能

概要

  • 一个使用 Pritunl API 管理 Pritunl 组织的模块。

参数

参数

注释

force

布尔值

如果 force 为 true 且 state 为 absent，则无论组织是否包含用户，模块都将删除该组织。默认情况下，force 为 false，这将导致模块在组织包含用户时删除失败。

选项

  • false ← (默认)

  • true

name

别名：org

字符串 / 必需

要在 Pritunl 中管理的组织名称。

pritunl_api_secret

字符串 / 必需

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

pritunl_api_token

字符串 / 必需

Pritunl 管理员用户的 API 令牌。

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

pritunl_url

字符串 / 必需

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

state

字符串

如果为 present，则模块会将组织 name 添加到 Pritunl。如果为 absent，则尝试从 Pritunl 删除组织（请阅读有关 force 用法的说明）。

选项

  • "present" ← (默认)

  • "absent"

validate_certs

布尔值

是否应验证证书。

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

选项

  • false

  • true ← (默认)

属性

属性

支持

描述

check_mode

支持：不支持

可以在 check_mode 下运行并返回更改状态预测，而无需修改目标。

diff_mode

支持：不支持

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

示例

- name: Ensure the organization named MyOrg exists
  community.general.pritunl_org:
    state: present
    name: MyOrg

- name: Ensure the organization named MyOrg does not exist
  community.general.pritunl_org:
    state: absent
    name: MyOrg

返回值

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

键

描述

response

字典

Pritunl 组织的 JSON 表示。

返回：成功

示例： {"auth_api": false, "auth_secret": null, "auth_token": null, "id": "csftwlu6uhralzi2dpmhekz3", "name": "Foo", "user_count": 0}

作者

  • Florian Dambrine (@Lowess)