Class: Ansible::Ruby::Modules::Debug

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

Overview

This module prints statements during execution and can be useful for debugging variables or expressions without necessarily halting the playbook. Useful for debugging together with the ‘when:’ directive. 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, #initialize, remove_existing_validations, #to_h, validates

Constructor Details

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

Instance Method Details

#msg ⇒ String?

Returns The customized message that is printed. If omitted, prints a generic message.

Returns:

  • (String, nil) —

    The customized message that is printed. If omitted, prints a generic message.



13
 
# File 'lib/ansible/ruby/modules/generated/utilities/logic/debug.rb', line 13

attribute :msg

#var ⇒ String?

Returns A variable name to debug. Mutually exclusive with the ‘msg’ option.

Returns:

  • (String, nil) —

    A variable name to debug. Mutually exclusive with the ‘msg’ option.



17
 
# File 'lib/ansible/ruby/modules/generated/utilities/logic/debug.rb', line 17

attribute :var

#verbosity ⇒ Integer?

Returns A number that controls when the debug is run, if you set to 3 it will only run debug when -vvv or above.

Returns:

  • (Integer, nil) —

    A number that controls when the debug is run, if you set to 3 it will only run debug when -vvv or above



21
 
# File 'lib/ansible/ruby/modules/generated/utilities/logic/debug.rb', line 21

attribute :verbosity