community / community.general / 6.6.8 / module / pritunl_org Manages Pritunl Organizations using the Pritunl API | "added in version" 2.5.0 of community.general" Authors: Florian Dambrine (@Lowess)community.general.pritunl_org (6.6.8) — module
Install with ansible-galaxy collection install community.general:==6.6.8
collections: - name: community.general version: 6.6.8
A module to manage Pritunl organizations using the Pritunl API.
- 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
name: aliases: - org description: - The name of the organization to manage in Pritunl. required: true type: str force: default: false description: - If I(force) is C(true) and I(state) is C(absent), the module will delete the organization, no matter if it contains users or not. By default I(force) is C(false), which will cause the module to fail the deletion of the organization when it contains users. type: bool state: choices: - present - absent default: present description: - If C(present), the module adds organization I(name) to Pritunl. If C(absent), attempt to delete the organization from Pritunl (please read about I(force) usage). type: str pritunl_url: description: - URL and port of the Pritunl server on which the API is enabled. required: true type: str validate_certs: default: true description: - If certificates should be validated or not. - This should never be set to C(false), except if you are very sure that your connection to the server can not be subject to a Man In The Middle attack. required: false type: bool pritunl_api_token: description: - API Token of a Pritunl admin user. - It needs to be enabled in Administrators > USERNAME > Enable Token Authentication. required: true type: str pritunl_api_secret: description: - API Secret found in Administrators > USERNAME > API Secret. required: true type: str
response: description: JSON representation of a Pritunl Organization. returned: success sample: auth_api: false auth_secret: null auth_token: null id: csftwlu6uhralzi2dpmhekz3 name: Foo user_count: 0 type: dict