mirror of
https://github.com/ansible-collections/community.general.git
synced 2025-04-23 19:01:26 -07:00
[pi ... prof]*: normalize docs (#9371)
* [pi ... prof]*: normalize docs * Update plugins/modules/pkg5_publisher.py Co-authored-by: Felix Fontein <felix@fontein.de> --------- Co-authored-by: Felix Fontein <felix@fontein.de>
This commit is contained in:
parent
23d97fa4b0
commit
13e2097f37
23 changed files with 702 additions and 766 deletions
|
@ -8,97 +8,87 @@ from __future__ import absolute_import, division, print_function
|
|||
|
||||
__metaclass__ = type
|
||||
|
||||
DOCUMENTATION = """
|
||||
---
|
||||
DOCUMENTATION = r"""
|
||||
module: pritunl_user
|
||||
author: "Florian Dambrine (@Lowess)"
|
||||
version_added: 2.3.0
|
||||
short_description: Manage Pritunl Users using the Pritunl API
|
||||
description:
|
||||
- A module to manage Pritunl users using the Pritunl API.
|
||||
- A module to manage Pritunl users using the Pritunl API.
|
||||
extends_documentation_fragment:
|
||||
- community.general.pritunl
|
||||
- community.general.attributes
|
||||
- community.general.pritunl
|
||||
- community.general.attributes
|
||||
attributes:
|
||||
check_mode:
|
||||
support: none
|
||||
diff_mode:
|
||||
support: none
|
||||
check_mode:
|
||||
support: none
|
||||
diff_mode:
|
||||
support: none
|
||||
options:
|
||||
organization:
|
||||
type: str
|
||||
required: true
|
||||
aliases:
|
||||
- org
|
||||
description:
|
||||
- The name of the organization the user is part of.
|
||||
|
||||
state:
|
||||
type: str
|
||||
default: 'present'
|
||||
choices:
|
||||
- present
|
||||
- absent
|
||||
description:
|
||||
- If V(present), the module adds user O(user_name) to
|
||||
the Pritunl O(organization). If V(absent), removes the user
|
||||
O(user_name) from the Pritunl O(organization).
|
||||
|
||||
user_name:
|
||||
type: str
|
||||
required: true
|
||||
default: null
|
||||
description:
|
||||
- Name of the user to create or delete from Pritunl.
|
||||
|
||||
user_email:
|
||||
type: str
|
||||
required: false
|
||||
default: null
|
||||
description:
|
||||
- Email address associated with the user O(user_name).
|
||||
|
||||
user_type:
|
||||
type: str
|
||||
required: false
|
||||
default: client
|
||||
choices:
|
||||
- client
|
||||
- server
|
||||
description:
|
||||
- Type of the user O(user_name).
|
||||
|
||||
user_groups:
|
||||
type: list
|
||||
elements: str
|
||||
required: false
|
||||
default: null
|
||||
description:
|
||||
- List of groups associated with the user O(user_name).
|
||||
|
||||
user_disabled:
|
||||
type: bool
|
||||
required: false
|
||||
default: null
|
||||
description:
|
||||
- Enable/Disable the user O(user_name).
|
||||
|
||||
user_gravatar:
|
||||
type: bool
|
||||
required: false
|
||||
default: null
|
||||
description:
|
||||
- Enable/Disable Gravatar usage for the user O(user_name).
|
||||
|
||||
user_mac_addresses:
|
||||
type: list
|
||||
elements: str
|
||||
description:
|
||||
- Allowed MAC addresses for the user O(user_name).
|
||||
version_added: 5.0.0
|
||||
organization:
|
||||
type: str
|
||||
required: true
|
||||
aliases:
|
||||
- org
|
||||
description:
|
||||
- The name of the organization the user is part of.
|
||||
state:
|
||||
type: str
|
||||
default: 'present'
|
||||
choices:
|
||||
- present
|
||||
- absent
|
||||
description:
|
||||
- If V(present), the module adds user O(user_name) to the Pritunl O(organization). If V(absent), removes the user O(user_name) from the
|
||||
Pritunl O(organization).
|
||||
user_name:
|
||||
type: str
|
||||
required: true
|
||||
default:
|
||||
description:
|
||||
- Name of the user to create or delete from Pritunl.
|
||||
user_email:
|
||||
type: str
|
||||
required: false
|
||||
default:
|
||||
description:
|
||||
- Email address associated with the user O(user_name).
|
||||
user_type:
|
||||
type: str
|
||||
required: false
|
||||
default: client
|
||||
choices:
|
||||
- client
|
||||
- server
|
||||
description:
|
||||
- Type of the user O(user_name).
|
||||
user_groups:
|
||||
type: list
|
||||
elements: str
|
||||
required: false
|
||||
default:
|
||||
description:
|
||||
- List of groups associated with the user O(user_name).
|
||||
user_disabled:
|
||||
type: bool
|
||||
required: false
|
||||
default:
|
||||
description:
|
||||
- Enable/Disable the user O(user_name).
|
||||
user_gravatar:
|
||||
type: bool
|
||||
required: false
|
||||
default:
|
||||
description:
|
||||
- Enable/Disable Gravatar usage for the user O(user_name).
|
||||
user_mac_addresses:
|
||||
type: list
|
||||
elements: str
|
||||
description:
|
||||
- Allowed MAC addresses for the user O(user_name).
|
||||
version_added: 5.0.0
|
||||
"""
|
||||
|
||||
EXAMPLES = """
|
||||
EXAMPLES = r"""
|
||||
- name: Create the user Foo with email address foo@bar.com in MyOrg
|
||||
community.general.pritunl_user:
|
||||
state: present
|
||||
|
@ -123,7 +113,7 @@ EXAMPLES = """
|
|||
user_name: Foo
|
||||
"""
|
||||
|
||||
RETURN = """
|
||||
RETURN = r"""
|
||||
response:
|
||||
description: JSON representation of Pritunl Users.
|
||||
returned: success
|
||||
|
|
Loading…
Add table
Add a link
Reference in a new issue