mirror of
https://github.com/ansible-collections/community.general.git
synced 2025-07-20 11:50:22 -07:00
[PR #9389/a9fca563 backport][stable-10] ma*.py: normalize docs (#9405)
ma*.py: normalize docs (#9389)
* ma*.py: normalize docs
* Update plugins/modules/matrix.py
Co-authored-by: Felix Fontein <felix@fontein.de>
---------
Co-authored-by: Felix Fontein <felix@fontein.de>
(cherry picked from commit a9fca56374
)
Co-authored-by: Alexei Znamensky <103110+russoz@users.noreply.github.com>
This commit is contained in:
parent
11ba71c802
commit
29e9afcbf4
17 changed files with 596 additions and 639 deletions
|
@ -8,8 +8,7 @@ from __future__ import (absolute_import, division, print_function)
|
|||
__metaclass__ = type
|
||||
|
||||
|
||||
DOCUMENTATION = '''
|
||||
|
||||
DOCUMENTATION = r"""
|
||||
module: manageiq_user
|
||||
|
||||
short_description: Management of users in ManageIQ
|
||||
|
@ -20,7 +19,6 @@ extends_documentation_fragment:
|
|||
author: Daniel Korn (@dkorn)
|
||||
description:
|
||||
- The manageiq_user module supports adding, updating and deleting users in ManageIQ.
|
||||
|
||||
attributes:
|
||||
check_mode:
|
||||
support: none
|
||||
|
@ -31,7 +29,8 @@ options:
|
|||
state:
|
||||
type: str
|
||||
description:
|
||||
- absent - user should not exist, present - user should be.
|
||||
- V(absent) - user should not exist,
|
||||
- V(present) - user should be.
|
||||
choices: ['absent', 'present']
|
||||
default: 'present'
|
||||
userid:
|
||||
|
@ -60,10 +59,11 @@ options:
|
|||
default: always
|
||||
choices: ['always', 'on_create']
|
||||
description:
|
||||
- V(always) will update passwords unconditionally. V(on_create) will only set the password for a newly created user.
|
||||
'''
|
||||
- V(always) will update passwords unconditionally.
|
||||
- V(on_create) will only set the password for a newly created user.
|
||||
"""
|
||||
|
||||
EXAMPLES = '''
|
||||
EXAMPLES = r"""
|
||||
- name: Create a new user in ManageIQ
|
||||
community.general.manageiq_user:
|
||||
userid: 'jdoe'
|
||||
|
@ -75,7 +75,7 @@ EXAMPLES = '''
|
|||
url: 'http://127.0.0.1:3000'
|
||||
username: 'admin'
|
||||
password: 'smartvm'
|
||||
validate_certs: false # only do this when you trust the network!
|
||||
validate_certs: false # only do this when you trust the network!
|
||||
|
||||
- name: Create a new user in ManageIQ using a token
|
||||
community.general.manageiq_user:
|
||||
|
@ -87,7 +87,7 @@ EXAMPLES = '''
|
|||
manageiq_connection:
|
||||
url: 'http://127.0.0.1:3000'
|
||||
token: 'sometoken'
|
||||
validate_certs: false # only do this when you trust the network!
|
||||
validate_certs: false # only do this when you trust the network!
|
||||
|
||||
- name: Delete a user in ManageIQ
|
||||
community.general.manageiq_user:
|
||||
|
@ -97,7 +97,7 @@ EXAMPLES = '''
|
|||
url: 'http://127.0.0.1:3000'
|
||||
username: 'admin'
|
||||
password: 'smartvm'
|
||||
validate_certs: false # only do this when you trust the network!
|
||||
validate_certs: false # only do this when you trust the network!
|
||||
|
||||
- name: Delete a user in ManageIQ using a token
|
||||
community.general.manageiq_user:
|
||||
|
@ -106,7 +106,7 @@ EXAMPLES = '''
|
|||
manageiq_connection:
|
||||
url: 'http://127.0.0.1:3000'
|
||||
token: 'sometoken'
|
||||
validate_certs: false # only do this when you trust the network!
|
||||
validate_certs: false # only do this when you trust the network!
|
||||
|
||||
- name: Update email of user in ManageIQ
|
||||
community.general.manageiq_user:
|
||||
|
@ -116,7 +116,7 @@ EXAMPLES = '''
|
|||
url: 'http://127.0.0.1:3000'
|
||||
username: 'admin'
|
||||
password: 'smartvm'
|
||||
validate_certs: false # only do this when you trust the network!
|
||||
validate_certs: false # only do this when you trust the network!
|
||||
|
||||
- name: Update email of user in ManageIQ using a token
|
||||
community.general.manageiq_user:
|
||||
|
@ -125,11 +125,11 @@ EXAMPLES = '''
|
|||
manageiq_connection:
|
||||
url: 'http://127.0.0.1:3000'
|
||||
token: 'sometoken'
|
||||
validate_certs: false # only do this when you trust the network!
|
||||
'''
|
||||
validate_certs: false # only do this when you trust the network!
|
||||
"""
|
||||
|
||||
RETURN = '''
|
||||
'''
|
||||
RETURN = r"""
|
||||
"""
|
||||
|
||||
from ansible.module_utils.basic import AnsibleModule
|
||||
from ansible_collections.community.general.plugins.module_utils.manageiq import ManageIQ, manageiq_argument_spec
|
||||
|
|
Loading…
Add table
Add a link
Reference in a new issue