community.general.pritunl_org_info module – List Pritunl Organizations using the Pritunl API
Note
This module is part of the community.general collection (version 8.6.4).
You might already have this collection installed if you are using the ansible
package.
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_info
.
New in community.general 2.5.0
Synopsis
A module to list Pritunl organizations using the Pritunl API.
Aliases: net_tools.pritunl.pritunl_org_info
Parameters
Parameter |
Comments |
---|---|
Name of the Pritunl organization to search for. If none provided, the module will return all Pritunl organizations. |
|
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: full This action does not modify state. |
Can run in |
|
Support: N/A This action does not modify state. |
Will return details on what has changed (or possibly needs changing in |
Examples
- 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
Return Values
Common return values are documented here, the following are the fields unique to this module:
Key |
Description |
---|---|
List of Pritunl organizations. Returned: success Sample: |