mirror of
https://github.com/ansible-collections/community.general.git
synced 2025-04-25 03:41:25 -07:00
e65045f51f
* Enable ECHO in prompt module Fixes #14160 * Add option for controlling echo behavior with pause module * Improve option logic Allow all options to be used in varying combinations, rather than being mutually exclusive. Always capture output and return it, even when a time limit is set. * Add version_added to docs * Improve behavior of echo output Set a few more flags to allow interactive deletion and hide control characters. Do not capture or echo input when a time is set. Tried to get this working nicely, but ran into too many issues/oddities to keep it. Maybe in the future if there is demand for capturing/echoing input when a time is set I'll take another pass at it.
107 lines
3.2 KiB
Python
107 lines
3.2 KiB
Python
# -*- coding: utf-8 -*-
|
|
# GNU General Public License v3.0+ (see COPYING or https://www.gnu.org/licenses/gpl-3.0.txt)
|
|
|
|
from __future__ import absolute_import, division, print_function
|
|
__metaclass__ = type
|
|
|
|
|
|
ANSIBLE_METADATA = {'metadata_version': '1.1',
|
|
'status': ['stableinterface'],
|
|
'supported_by': 'core'}
|
|
|
|
|
|
DOCUMENTATION = '''
|
|
---
|
|
module: pause
|
|
short_description: Pause playbook execution
|
|
description:
|
|
- Pauses playbook execution for a set amount of time, or until a prompt is acknowledged.
|
|
All parameters are optional. The default behavior is to pause with a prompt.
|
|
- To pause/wait/sleep per host, use the M(wait_for) module.
|
|
- You can use C(ctrl+c) if you wish to advance a pause earlier than it is set to expire or if you need to abort a playbook run entirely.
|
|
To continue early press C(ctrl+c) and then C(c). To abort a playbook press C(ctrl+c) and then C(a).
|
|
- The pause module integrates into async/parallelized playbooks without any special considerations (see Rolling Updates).
|
|
When using pauses with the C(serial) playbook parameter (as in rolling updates) you are only prompted once for the current group of hosts.
|
|
- This module is also supported for Windows targets.
|
|
version_added: "0.8"
|
|
options:
|
|
minutes:
|
|
description:
|
|
- A positive number of minutes to pause for.
|
|
required: false
|
|
default: null
|
|
seconds:
|
|
description:
|
|
- A positive number of seconds to pause for.
|
|
required: false
|
|
default: null
|
|
prompt:
|
|
description:
|
|
- Optional text to use for the prompt message.
|
|
required: false
|
|
default: null
|
|
echo:
|
|
description:
|
|
- Contols whether or not keyboard input is shown when typing.
|
|
- Has no effect if 'seconds' or 'minutes' is set.
|
|
required: false
|
|
default: 'yes'
|
|
choices: ['yes', 'no']
|
|
version_added: 2.5
|
|
author: "Tim Bielawa (@tbielawa)"
|
|
notes:
|
|
- Starting in 2.2, if you specify 0 or negative for minutes or seconds, it will wait for 1 second, previously it would wait indefinitely.
|
|
- This module is also supported for Windows targets.
|
|
- User input is not captured or echoed, regardless of echo setting, when minutes or seconds is specified.
|
|
'''
|
|
|
|
EXAMPLES = '''
|
|
# Pause for 5 minutes to build app cache.
|
|
- pause:
|
|
minutes: 5
|
|
|
|
# Pause until you can verify updates to an application were successful.
|
|
- pause:
|
|
|
|
# A helpful reminder of what to look out for post-update.
|
|
- pause:
|
|
prompt: "Make sure org.foo.FooOverload exception is not present"
|
|
|
|
# Pause to get some sensitive input.
|
|
- pause:
|
|
prompt: "Enter a secret"
|
|
echo: no
|
|
'''
|
|
|
|
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
|
|
echo:
|
|
description: Value of echo setting
|
|
returned: always
|
|
type: bool
|
|
sample: true
|
|
'''
|