fixed RETURN docs for modules (#24011)

* fixed RETURN docs for remaining modules

* updated proxymysql_mysql_users 'sample' to yaml dict

* fixed whitespace errors
This commit is contained in:
Andrea Tartaglia 2017-04-26 15:56:13 +01:00 committed by John R Barker
commit d1517f997a
40 changed files with 105 additions and 102 deletions

View file

@ -119,7 +119,7 @@ mgs:
sample: changed inittab entry startmyservice
changed:
description: whether the inittab changed or not
return: always
returned: always
type: boolean
sample: true
'''

View file

@ -170,42 +170,42 @@ key_option:
description: Key options related to the key.
returned: success
type: string
sameple: null
sample: null
keyfile:
description: Path for authorzied key file.
returned: success
type: string
sameple: /home/user/.ssh/authorized_keys
sample: /home/user/.ssh/authorized_keys
manage_dir:
description: Whether this module managed the directory of the authorized key file.
returned: success
type: boolean
sameple: True
sample: True
path:
description: Alternate path to the authorized_keys file
returned: success
type: string
sameple: null
sample: null
state:
description: Whether the given key (with the given key_options) should or should not be in the file
returned: success
type: string
sameple: present
sample: present
unique:
description: Whether the key is unique
returned: success
type: boolean
sameple: false
sample: false
user:
description: The username on the remote host whose authorized_keys file will be modified
returned: success
type: string
sameple: user
sample: user
validate_certs:
description: This only applies if using a https url as the source of the keys. If set to C(no), the SSL certificates will not be validated.
returned: success
type: boolean
sameple: true
sample: true
'''
# Makes sure the public key line is present or absent in the user's .ssh/authorized_keys.

View file

@ -112,7 +112,7 @@ RETURN = '''
partition_info:
description: Current partition information
returned: success
type: dict
type: complex
contains:
device:
description: Generic device information.

View file

@ -123,7 +123,7 @@ status:
description: A dictionary with the key=value pairs returned from `systemctl show`
returned: success
type: complex
sample: {
contains: {
"ActiveEnterTimestamp": "Sun 2016-05-15 18:28:49 EDT",
"ActiveEnterTimestampMonotonic": "8135942",
"ActiveExitTimestampMonotonic": "0",

View file

@ -65,7 +65,7 @@ diff:
description: The differences about the given arguments.
returned: success
type: dictionary
contains:
sample:
before:
description: The values before change
type: dict