From a3099b22944e01a9d77f8bbf49a357aeba84841d Mon Sep 17 00:00:00 2001 From: philsch Date: Thu, 23 Feb 2017 17:30:09 +0100 Subject: [PATCH] Document returned values of module pause Adds missing documentation of the return values of `pause`. Important to know how to retrieve user input. --- lib/ansible/modules/utilities/logic/pause.py | 28 ++++++++++++++++++++ 1 file changed, 28 insertions(+) diff --git a/lib/ansible/modules/utilities/logic/pause.py b/lib/ansible/modules/utilities/logic/pause.py index 0fed099b70..b79bba2c89 100644 --- a/lib/ansible/modules/utilities/logic/pause.py +++ b/lib/ansible/modules/utilities/logic/pause.py @@ -61,3 +61,31 @@ EXAMPLES = ''' - pause: prompt: "Make sure org.foo.FooOverload exception is not present" ''' + +RETURN = ''' +user_input: + description: User input from interactive console + returned: if no waiting time set + type: string + sample: Example user input +start: + description: Time when started pausing + returned: always + type: string + sample: 2017-02-23 14:35:07.298862 +stop: + description: Time when ended pausing + returned: always + type: string + sample: 2017-02-23 14:35:09.552594 +delta: + description: Time paused in seconds + returned: always + type: string + sample: 2 +stdout: + description: Output of pause module + returned: always + type: string + sample: Paused for 0.04 minutes +'''