fail - Fail with custom message

Author:Dag Wieers

Synopsis

This module fails the progress with a custom message. It can be useful for bailing out when a certain condition is met using when.

Options

parameter required default choices comments
msg no 'Failed as requested from task'
    The customized message used for failing execution. If omitted, fail will simple bail out with a generic message.

    Examples


    # Example playbook using fail and when together
    - fail: msg="The system may not be provisioned according to the CMDB status."
      when: cmdb_status != "to-be-staged"

    Table Of Contents

    Previous topic

    debug - Print statements during execution

    Next topic

    fireball - Enable fireball mode on remote node