Class: Ansible::Ruby::Modules::Pause

Inherits:
Base show all
Defined in:
lib/ansible/ruby/modules/generated/utilities/logic/pause.rb,
lib/ansible/ruby/modules/custom/utilities/logic/pause.rb

Overview

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©. 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.

Instance Method Summary collapse

Methods inherited from Base

#ansible_name, #to_h

Methods inherited from Ansible::Ruby::Models::Base

attr_option, attr_options, attribute, fix_inclusion, #initialize, remove_existing_validations, #to_h, validates

Constructor Details

This class inherits a constructor from Ansible::Ruby::Models::Base

Instance Method Details

#echo ⇒ :yes, ...

Returns Controls whether or not keyboard input is shown when typing.,Has no effect if ‘seconds’ or ‘minutes’ is set.

Returns:

  • (:yes, :no, nil) —

    Controls whether or not keyboard input is shown when typing.,Has no effect if ‘seconds’ or ‘minutes’ is set.



27
 
# File 'lib/ansible/ruby/modules/generated/utilities/logic/pause.rb', line 27

attribute :echo

#minutes ⇒ Integer?

Returns A positive number of minutes to pause for.

Returns:

  • (Integer, nil) —

    A positive number of minutes to pause for.



16
 
# File 'lib/ansible/ruby/modules/generated/utilities/logic/pause.rb', line 16

attribute :minutes

#prompt ⇒ String?

Returns Optional text to use for the prompt message.

Returns:

  • (String, nil) —

    Optional text to use for the prompt message.



23
 
# File 'lib/ansible/ruby/modules/generated/utilities/logic/pause.rb', line 23

attribute :prompt

#seconds ⇒ Object?

Returns A positive number of seconds to pause for.

Returns:

  • (Object, nil) —

    A positive number of seconds to pause for.



20
 
# File 'lib/ansible/ruby/modules/generated/utilities/logic/pause.rb', line 20

attribute :seconds