Class: Ansible::Ruby::Modules::Win_wait_for_process

Inherits:
Base show all
Defined in:
lib/ansible/ruby/modules/generated/windows/win_wait_for_process.rb

Overview

Waiting for a process to start or stop. This is useful when Windows services behave poorly and do not enumerate external dependencies in their manifest.

Instance Method Summary collapse

Methods inherited from Base

#ansible_name, #to_h

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

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

Constructor Details

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

Instance Method Details

#owner ⇒ String?

Returns The owner of the process.,Requires PowerShell version 4.0 or newer.

Returns:

  • (String, nil) —

    The owner of the process.,Requires PowerShell version 4.0 or newer.



33
 
# File 'lib/ansible/ruby/modules/generated/windows/win_wait_for_process.rb', line 33

attribute :owner

#pid ⇒ Integer?

Returns The PID of the process.

Returns:

  • (Integer, nil) —

    The PID of the process.



29
 
# File 'lib/ansible/ruby/modules/generated/windows/win_wait_for_process.rb', line 29

attribute :pid

#post_wait_delay ⇒ Integer?

Returns Seconds to wait after checking for processes.

Returns:

  • (Integer, nil) —

    Seconds to wait after checking for processes.



41
 
# File 'lib/ansible/ruby/modules/generated/windows/win_wait_for_process.rb', line 41

attribute :post_wait_delay

#pre_wait_delay ⇒ Integer?

Returns Seconds to wait before checking processes.

Returns:

  • (Integer, nil) —

    Seconds to wait before checking processes.



37
 
# File 'lib/ansible/ruby/modules/generated/windows/win_wait_for_process.rb', line 37

attribute :pre_wait_delay

#process_min_count ⇒ Integer?

Returns Minimum number of process matching the supplied pattern to satisfy C(present) condition.,Only applies to C(present).

Returns:

  • (Integer, nil) —

    Minimum number of process matching the supplied pattern to satisfy C(present) condition.,Only applies to C(present).



25
 
# File 'lib/ansible/ruby/modules/generated/windows/win_wait_for_process.rb', line 25

attribute :process_min_count

#process_name_exact ⇒ String?

Returns The name of the process(es) for which to wait.

Returns:

  • (String, nil) —

    The name of the process(es) for which to wait.



13
 
# File 'lib/ansible/ruby/modules/generated/windows/win_wait_for_process.rb', line 13

attribute :process_name_exact

#process_name_pattern ⇒ String?

Returns RegEx pattern matching desired process(es).

Returns:

  • (String, nil) —

    RegEx pattern matching desired process(es).



17
 
# File 'lib/ansible/ruby/modules/generated/windows/win_wait_for_process.rb', line 17

attribute :process_name_pattern

#sleep ⇒ Integer?

Returns Number of seconds to sleep between checks.,Only applies when waiting for a process to start. Waiting for a process to start does not have a native non-polling mechanism. Waiting for a stop uses native PowerShell and does not require polling.

Returns:

  • (Integer, nil) —

    Number of seconds to sleep between checks.,Only applies when waiting for a process to start. Waiting for a process to start does not have a native non-polling mechanism. Waiting for a stop uses native PowerShell and does not require polling.



21
 
# File 'lib/ansible/ruby/modules/generated/windows/win_wait_for_process.rb', line 21

attribute :sleep

#state ⇒ String?

Returns When checking for a running process C(present) will block execution until the process exists, or until the timeout has been reached. C(absent) will block execution untile the processs no longer exists, or until the timeout has been reached.,When waiting for C(present), the module will return changed only if the process was not present on the initial check but became present on subsequent checks.,If, while waiting for C(absent), new processes matching the supplied pattern are started, these new processes will not be included in the action.

Returns:

  • (String, nil) —

    When checking for a running process C(present) will block execution until the process exists, or until the timeout has been reached. C(absent) will block execution untile the processs no longer exists, or until the timeout has been reached.,When waiting for C(present), the module will return changed only if the process was not present on the initial check but became present on subsequent checks.,If, while waiting for C(absent), new processes matching the supplied pattern are started, these new processes will not be included in the action.



45
 
# File 'lib/ansible/ruby/modules/generated/windows/win_wait_for_process.rb', line 45

attribute :state

#timeout ⇒ Integer?

Returns The maximum number of seconds to wait for a for a process to start or stop before erroring out.

Returns:

  • (Integer, nil) —

    The maximum number of seconds to wait for a for a process to start or stop before erroring out.



49
 
# File 'lib/ansible/ruby/modules/generated/windows/win_wait_for_process.rb', line 49

attribute :timeout