mirror of
https://github.com/ansible-collections/community.general.git
synced 2025-04-18 16:31:26 -07:00
[mem ... n]*.py: normalize docs (#9388)
* [mem ... n]*.py: normalize docs * Update plugins/modules/netcup_dns.py Co-authored-by: Felix Fontein <felix@fontein.de> * netcup_dns: change type of RV(records) From complex to list of dicts. --------- Co-authored-by: Felix Fontein <felix@fontein.de>
This commit is contained in:
parent
a9fca56374
commit
6aadcc72d1
25 changed files with 2245 additions and 2342 deletions
|
@ -9,60 +9,59 @@ from __future__ import absolute_import, division, print_function
|
|||
|
||||
__metaclass__ = type
|
||||
|
||||
DOCUMENTATION = '''
|
||||
---
|
||||
DOCUMENTATION = r"""
|
||||
module: nomad_token
|
||||
author: Pedro Nascimento (@apecnascimento)
|
||||
version_added: "8.1.0"
|
||||
short_description: Manage Nomad ACL tokens
|
||||
description:
|
||||
- This module allows to create Bootstrap tokens, create ACL tokens, update ACL tokens, and delete ACL tokens.
|
||||
- This module allows to create Bootstrap tokens, create ACL tokens, update ACL tokens, and delete ACL tokens.
|
||||
requirements:
|
||||
- python-nomad
|
||||
- python-nomad
|
||||
extends_documentation_fragment:
|
||||
- community.general.nomad
|
||||
- community.general.attributes
|
||||
- community.general.nomad
|
||||
- community.general.attributes
|
||||
attributes:
|
||||
check_mode:
|
||||
support: none
|
||||
diff_mode:
|
||||
support: none
|
||||
check_mode:
|
||||
support: none
|
||||
diff_mode:
|
||||
support: none
|
||||
options:
|
||||
name:
|
||||
description:
|
||||
- Name of ACL token to create.
|
||||
type: str
|
||||
token_type:
|
||||
description:
|
||||
- The type of the token can be V(client), V(management), or V(bootstrap).
|
||||
choices: ["client", "management", "bootstrap"]
|
||||
type: str
|
||||
default: "client"
|
||||
policies:
|
||||
description:
|
||||
- A list of the policies assigned to the token.
|
||||
type: list
|
||||
elements: str
|
||||
default: []
|
||||
global_replicated:
|
||||
description:
|
||||
- Indicates whether or not the token was created with the C(--global).
|
||||
type: bool
|
||||
default: false
|
||||
state:
|
||||
description:
|
||||
- Create or remove ACL token.
|
||||
choices: ["present", "absent"]
|
||||
required: true
|
||||
type: str
|
||||
name:
|
||||
description:
|
||||
- Name of ACL token to create.
|
||||
type: str
|
||||
token_type:
|
||||
description:
|
||||
- The type of the token can be V(client), V(management), or V(bootstrap).
|
||||
choices: ["client", "management", "bootstrap"]
|
||||
type: str
|
||||
default: "client"
|
||||
policies:
|
||||
description:
|
||||
- A list of the policies assigned to the token.
|
||||
type: list
|
||||
elements: str
|
||||
default: []
|
||||
global_replicated:
|
||||
description:
|
||||
- Indicates whether or not the token was created with the C(--global).
|
||||
type: bool
|
||||
default: false
|
||||
state:
|
||||
description:
|
||||
- Create or remove ACL token.
|
||||
choices: ["present", "absent"]
|
||||
required: true
|
||||
type: str
|
||||
|
||||
seealso:
|
||||
- name: Nomad ACL documentation
|
||||
description: Complete documentation for Nomad API ACL.
|
||||
link: https://developer.hashicorp.com/nomad/api-docs/acl/tokens
|
||||
'''
|
||||
"""
|
||||
|
||||
EXAMPLES = '''
|
||||
EXAMPLES = r"""
|
||||
- name: Create boostrap token
|
||||
community.general.nomad_token:
|
||||
host: localhost
|
||||
|
@ -75,7 +74,7 @@ EXAMPLES = '''
|
|||
name: "Dev token"
|
||||
token_type: client
|
||||
policies:
|
||||
- readonly
|
||||
- readonly
|
||||
global_replicated: false
|
||||
state: absent
|
||||
|
||||
|
@ -85,8 +84,8 @@ EXAMPLES = '''
|
|||
name: "Dev token"
|
||||
token_type: client
|
||||
policies:
|
||||
- readonly
|
||||
- devpolicy
|
||||
- readonly
|
||||
- devpolicy
|
||||
global_replicated: false
|
||||
state: absent
|
||||
|
||||
|
@ -95,9 +94,9 @@ EXAMPLES = '''
|
|||
host: localhost
|
||||
name: "Dev token"
|
||||
state: absent
|
||||
'''
|
||||
"""
|
||||
|
||||
RETURN = '''
|
||||
RETURN = r"""
|
||||
result:
|
||||
description: Result returned by nomad.
|
||||
returned: always
|
||||
|
@ -119,7 +118,7 @@ result:
|
|||
"secret_id": "12e878ab-e1f6-e103-b4c4-3b5173bb4cea",
|
||||
"type": "client"
|
||||
}
|
||||
'''
|
||||
"""
|
||||
|
||||
from ansible.module_utils.basic import AnsibleModule, missing_required_lib
|
||||
from ansible.module_utils.common.text.converters import to_native
|
||||
|
|
Loading…
Add table
Add a link
Reference in a new issue