mirror of
https://github.com/ansible-collections/community.general.git
synced 2026-05-07 22:02:50 +00:00
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:
committed by
John R Barker
parent
9a0a7f78d7
commit
d1517f997a
@@ -122,6 +122,6 @@ rc:
|
||||
stdout_lines:
|
||||
description: The command standard output split in lines
|
||||
returned: always
|
||||
type: list of strings
|
||||
type: list
|
||||
sample: [u'Clustering node rabbit@slave1 with rabbit@master ...']
|
||||
'''
|
||||
|
||||
@@ -227,13 +227,13 @@ examined:
|
||||
sample: 10
|
||||
matched:
|
||||
description: The number of files/folders that match the criteria
|
||||
returns: always
|
||||
returned: always
|
||||
type: int
|
||||
sample: 2
|
||||
files:
|
||||
description: Information on the files/folders that match the criteria returned as a list of dictionary elements for each file matched
|
||||
returned: success
|
||||
type: dictionary
|
||||
type: complex
|
||||
contains:
|
||||
attributes:
|
||||
description: attributes of the file at path in raw form
|
||||
|
||||
@@ -117,7 +117,7 @@ attributes:
|
||||
info:
|
||||
description: Information on current state of the Application Pool
|
||||
returned: success
|
||||
type: dictionary
|
||||
type: complex
|
||||
sample:
|
||||
contains:
|
||||
attributes:
|
||||
|
||||
@@ -84,7 +84,7 @@ compare_to_key_found:
|
||||
difference_count:
|
||||
description: number of differences between the registry and the file
|
||||
returned: changed
|
||||
type: integer
|
||||
type: int
|
||||
sample: 1
|
||||
compared:
|
||||
description: whether a comparison has taken place between the registry and the file
|
||||
|
||||
@@ -246,7 +246,7 @@ start_mode:
|
||||
type: string
|
||||
sample: manual
|
||||
path:
|
||||
description:
|
||||
description: path to the service
|
||||
returned: success and service exists
|
||||
type: string
|
||||
sample: C:\Windows\system32\svchost.exe -k LocalServiceNoNetwork
|
||||
@@ -268,11 +268,11 @@ desktop_interact:
|
||||
dependencies:
|
||||
description: A list of dependencies the service relies on
|
||||
returned: success and service exists
|
||||
type: List
|
||||
type: list
|
||||
sample: False
|
||||
depended_by:
|
||||
description: A list of dependencies this service relies on
|
||||
returned: success and service exists
|
||||
type: List
|
||||
type: list
|
||||
sample: False
|
||||
'''
|
||||
|
||||
@@ -130,6 +130,6 @@ rc:
|
||||
stdout_lines:
|
||||
description: The command standard output split in lines
|
||||
returned: always
|
||||
type: list of strings
|
||||
type: list
|
||||
sample: [u'Clustering node rabbit@slave1 with rabbit@master ...']
|
||||
'''
|
||||
|
||||
@@ -112,7 +112,7 @@ changed:
|
||||
stat:
|
||||
description: dictionary containing all the stat data
|
||||
returned: success
|
||||
type: dictionary
|
||||
type: complex
|
||||
contains:
|
||||
attributes:
|
||||
description: attributes of the file at path in raw form
|
||||
|
||||
@@ -103,7 +103,7 @@ reboot_required:
|
||||
updates:
|
||||
description: List of updates that were found/installed
|
||||
returned: success
|
||||
type: dictionary
|
||||
type: complex
|
||||
sample:
|
||||
contains:
|
||||
title:
|
||||
|
||||
@@ -130,7 +130,6 @@ body:
|
||||
returned: when body is specified
|
||||
type: string
|
||||
sample: '{"id":1}'
|
||||
version_added: "2.3"
|
||||
status_code:
|
||||
description: The HTTP Status Code of the response.
|
||||
returned: success
|
||||
|
||||
Reference in New Issue
Block a user