community.general.pritunl_org module – Manages Pritunl Organizations using the Pritunl API
Note
This module is part of the community.general collection (version 9.4.0).
It is not included in ansible-core
.
To check whether it is installed, run ansible-galaxy collection list
.
To install it, use: ansible-galaxy collection install community.general
.
To use it in a playbook, specify: community.general.pritunl_org
.
New in community.general 2.5.0
Synopsis
A module to manage Pritunl organizations using the Pritunl API.
Parameters
Parameter |
Comments |
---|---|
The name of the organization to manage in Pritunl. |
|
API Secret found in Administrators > USERNAME > API Secret. |
|
API Token of a Pritunl admin user. It needs to be enabled in Administrators > USERNAME > Enable Token Authentication. |
|
URL and port of the Pritunl server on which the API is enabled. |
|
If certificates should be validated or not. This should never be set to Choices:
|
Attributes
Attribute |
Support |
Description |
---|---|---|
Support: none |
Can run in |
|
Support: none |
Will return details on what has changed (or possibly needs changing in |
Examples
- 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
Return Values
Common return values are documented here, the following are the fields unique to this module:
Key |
Description |
---|---|
JSON representation of a Pritunl Organization. Returned: success Sample: |