community.general.pritunl_user_info module – List Pritunl Users using the Pritunl API
Note
This module is part of the community.general collection (version 5.8.3).
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_user_info
.
New in community.general 2.3.0
Synopsis
A module to list Pritunl users using the Pritunl API.
Parameters
Parameter |
Comments |
---|---|
The name of the organization the user is part of. |
|
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. |
|
Name of the user to filter on Pritunl. |
|
Type of the user user_name. Choices:
|
|
If certificates should be validated or not. This should never be set to Choices:
|
Examples
- 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
Return Values
Common return values are documented here, the following are the fields unique to this module:
Key |
Description |
---|---|
List of Pritunl users. Returned: success Sample: |
Collection links
Issue Tracker Repository (Sources) Submit a bug report Request a feature Communication