Class: Ansible::Ruby::Modules::Fail

Inherits:

Base

• Object
• Ansible::Ruby::Models::Base
• Base
• Ansible::Ruby::Modules::Fail

Defined in:

lib/ansible/ruby/modules/generated/utilities/logic/fail.rb

Overview

This module fails the progress with a custom message. It can be useful for bailing out when a certain condition is met using C(when). This module is also supported for Windows targets.

Instance Method Summary

• #msg ⇒ String^?

  The customized message used for failing execution.

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

#msg ⇒ String^?

Returns The customized message used for failing execution. If omitted, fail will simply bail out with a generic message.

Returns:

• (String, nil) —

  The customized message used for failing execution. If omitted, fail will simply bail out with a generic message.

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

attribute :msg