community.general.pritunl_user – Manage Pritunl Users using the Pritunl API¶
Note
This plugin is part of the community.general collection (version 2.5.1).
To install it use: ansible-galaxy collection install community.general
.
To use it in a playbook, specify: community.general.pritunl_user
.
New in version 2.3.0: of community.general
Parameters¶
Examples¶
- name: Create the user Foo with email address [email protected] in MyOrg
community.general.pritunl_user:
state: present
name: MyOrg
user_name: Foo
user_email: [email protected]
- name: Disable the user Foo but keep it in Pritunl
community.general.pritunl_user:
state: present
name: MyOrg
user_name: Foo
user_email: [email protected]
user_disabled: yes
- name: Make sure the user Foo is not part of MyOrg anymore
community.general.pritunl_user:
state: absent
name: MyOrg
user_name: Foo
Return Values¶
Common return values are documented here, the following are the fields unique to this module:
Key | Returned | Description |
---|---|---|
response
dictionary
|
success |
JSON representation 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)