community.general.pritunl_user_info – List Pritunl Users using the Pritunl API

Note

This plugin is part of the community.general collection (version 3.6.0).

To install it use: ansible-galaxy collection install community.general.

To use it in a playbook, specify: community.general.pritunl_user_info.

New in version 2.3.0: of community.general

Synopsis

  • A module to list Pritunl users using the Pritunl API.

Parameters

Parameter Choices/Defaults Comments
organization
string / required
The name of the organization the user is part of.

aliases: org
pritunl_api_secret
string / required
API Secret found in Administrators > USERNAME > API Secret.
pritunl_api_token
string / required
API Token of a Pritunl admin user.
It needs to be enabled in Administrators > USERNAME > Enable Token Authentication.
pritunl_url
string / required
URL and port of the Pritunl server on which the API is enabled.
user_name
string
Name of the user to filter on Pritunl.
user_type
string
    Choices:
  • client ←
  • server
Type of the user user_name.
validate_certs
boolean
    Choices:
  • no
  • yes ←
If certificates should be validated or not.
This should never be set to false, except if you are very sure that your connection to the server can not be subject to a Man In The Middle attack.

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 Returned Description
users
list / elements=dictionary
success
List of Pritunl users.

Sample:
[{'audit': False, 'auth_type': 'google', 'bypass_secondary': False, 'client_to_client': False, 'disabled': False, 'dns_mapping': None, 'dns_servers': None, 'dns_suffix': None, 'email': '[email protected]', 'gravatar': True, 'groups': ['foo', 'bar'], 'id': '5d070dafe63q3b2e6s472c3b', 'name': '[email protected]', 'network_links': [], 'organization': '58070daee6sf342e6e4s2c36', 'organization_name': 'Acme', 'otp_auth': True, 'otp_secret': '35H5EJA3XB2$4CWG', 'pin': False, 'port_forwarding': [], 'servers': []}]


Authors

  • Florian Dambrine (@Lowess)