• AnsibleFest
  • Products
  • Community
  • Webinars & Training
  • Blog
Ansible Logo
Documentation
Ansible
2.8

Installation, Upgrade & Configuration

  • Installation Guide
  • Ansible Porting Guides

Using Ansible

  • User Guide
    • Ansible Quickstart
    • Getting Started
    • Working with Command Line Tools
    • Introduction To Ad-Hoc Commands
    • Working with Inventory
    • Working With Dynamic Inventory
    • Working With Playbooks
    • Understanding Privilege Escalation
    • Ansible Vault
    • Working with Patterns
    • Working With Modules
      • Introduction
      • Return Values
      • Module Maintenance & Support
      • Module Index
        • All modules
        • Cloud modules
        • Clustering modules
        • Commands modules
        • Crypto modules
        • Database modules
        • Files modules
        • Identity modules
        • Inventory modules
        • Messaging modules
        • Monitoring modules
        • Net Tools modules
        • Network modules
        • Notification modules
        • Packaging modules
        • Remote Management modules
        • Source Control modules
        • Storage modules
        • System modules
        • Utilities modules
        • Web Infrastructure modules
        • Windows modules
    • Working With Plugins
    • BSD Support
    • Windows Guides

Contributing to Ansible

  • Ansible Community Guide

Extending Ansible

  • Developer Guide

Common Ansible Scenarios

  • Public Cloud Guides
  • Network Technology Guides
  • Virtualization and Containerization Guides

Ansible for Network Automation

  • Ansible for Network Automation

Reference & Appendices

  • Module Index
    • All modules
    • Cloud modules
    • Clustering modules
    • Commands modules
    • Crypto modules
    • Database modules
    • Files modules
    • Identity modules
    • Inventory modules
    • Messaging modules
    • Monitoring modules
    • Net Tools modules
    • Network modules
    • Notification modules
    • Packaging modules
    • Remote Management modules
    • Source Control modules
    • Storage modules
    • System modules
    • Utilities modules
      • Helper
      • Logic
    • Web Infrastructure modules
    • Windows modules
  • Playbook Keywords
  • Ansible Galaxy
  • Return Values
  • Ansible Configuration Settings
  • Controlling how Ansible behaves: precedence rules
  • YAML Syntax
  • Python 3 Support
  • Interpreter Discovery
  • Release and maintenance
  • Testing Strategies
  • Sanity Tests
  • Frequently Asked Questions
  • Glossary
  • Ansible Reference: Module Utilities
  • Special Variables
  • Red Hat Ansible Tower

Roadmaps

  • Ansible Roadmap




Ansible
  • Docs »
  • User Guide »
  • Working With Modules »
  • Module Index »
  • Utilities modules

You are reading an unmaintained version of the Ansible documentation. Unmaintained Ansible versions can contain unfixed security vulnerabilities (CVE). Please upgrade to a maintained version. See the latest Ansible documentation.

Utilities modules¶

Helper¶

  • meta – Execute Ansible ‘actions’

Logic¶

  • assert – Asserts given expressions are true

  • async_status – Obtain status of asynchronous task

  • debug – Print statements during execution

  • fail – Fail with custom message

  • import_playbook – Import a playbook

  • import_role – Import a role into a play

  • import_tasks – Import a task list

  • include – Include a play or task list

  • include_role – Load and execute a role

  • include_tasks – Dynamically include a task list

  • include_vars – Load variables from files, dynamically within a task

  • pause – Pause playbook execution

  • set_fact – Set host facts from a task

  • set_stats – Set stats for the current ansible run

  • wait_for – Waits for a condition before continuing

  • wait_for_connection – Waits until remote system is reachable/usable

Note

  • (D): This marks a module as deprecated, which means a module is kept for backwards compatibility but usage is discouraged. The module documentation details page may explain more about this rationale.

Next Previous

© Copyright 2019 Red Hat, Inc. Last updated on Apr 30, 2021.