Added some documentation for the shell return values

This commit is contained in:
Leonardo Giordani 2016-02-25 10:42:54 +01:00 committed by Matt Clay
parent a148dbe5b4
commit 344c976141

View file

@ -99,3 +99,51 @@ EXAMPLES = '''
args: args:
executable: /bin/bash executable: /bin/bash
''' '''
RETURN = '''
msg:
description: changed
returned: always
type: boolean
sample: True
start:
description: The command execution start time
returned: always
type: string
sample: '2016-02-25 09:18:26.429568'
end:
description: The command execution end time
returned: always
type: string
sample: '2016-02-25 09:18:26.755339'
delta:
description: The command execution delta time
returned: always
type: string
sample: '0:00:00.325771'
stdout:
description: The command standard output
returned: always
type: string
sample: 'Clustering node rabbit@slave1 with rabbit@master ...'
stderr:
description: The command standard error
returned: always
type: string
sample: 'ls: cannot access foo: No such file or directory'
cmd:
description: The command executed by the task
returned: always
type: string
sample: 'rabbitmqctl join_cluster rabbit@master'
rc:
description: The command return code (0 means success)
returned: always
type: int
sample: 0
stdout_lines:
description: The command standard output split in lines
returned: always
type: list of strings
sample: [u'Clustering node rabbit@slave1 with rabbit@master ...']
'''