Ansible Documentation

About Ansible

Ansible is an IT automation tool. It can configure systems, deploy software, and orchestrate more advanced IT tasks such as continuous deployments or zero downtime rolling updates.

Ansible’s main goals are simplicity and ease-of-use. It also has a strong focus on security and reliability, featuring a minimum of moving parts, usage of OpenSSH for transport (with other transports and pull modes as alternatives), and a language that is designed around auditability by humans–even those not familiar with the program.

We believe simplicity is relevant to all sizes of environments, so we design for busy users of all types: developers, sysadmins, release engineers, IT managers, and everyone in between. Ansible is appropriate for managing all environments, from small setups with a handful of instances to enterprise environments with many thousands of instances.

You can learn more at AnsibleFest, the annual event for all Ansible contributors, users, and customers hosted by Red Hat. AnsibleFest is the place to connect with others, learn new skills, and find a new friend to automate with.

Ansible manages machines in an agent-less manner. There is never a question of how to upgrade remote daemons or the problem of not being able to manage systems because daemons are uninstalled. Because OpenSSH is one of the most peer-reviewed open source components, security exposure is greatly reduced. Ansible is decentralized–it relies on your existing OS credentials to control access to remote machines. If needed, Ansible can easily connect with Kerberos, LDAP, and other centralized authentication management systems.

This documentation covers the version of Ansible noted in the upper left corner of this page. We maintain multiple versions of Ansible and of the documentation, so please be sure you are using the version of the documentation that covers the version of Ansible you’re using. For recent features, we note the version of Ansible where the feature was added.

Ansible releases a new major release of Ansible approximately three to four times per year. The core application evolves somewhat conservatively, valuing simplicity in language design and setup. Contributors develop and change modules and plugins, hosted in collections since version 2.10, much more quickly.

Installation, Upgrade & Configuration

• Installation Guide
  • Installing Ansible
  • Configuring Ansible
• Ansible Porting Guides

Using Ansible

• User Guide
  • Getting started
  • Writing tasks, plays, and playbooks
  • Working with inventory
  • Interacting with data
  • Executing playbooks
  • Advanced features and reference
  • Traditional Table of Contents

Contributing to Ansible

• Ansible Community Guide
  • Getting started
  • Going deeper
  • Working with the Ansible repo
  • Traditional Table of Contents

Extending Ansible

• Developer Guide
  • Adding modules and plugins locally
  • Should you develop a module?
  • Ansible module development: getting started
  • Contributing your module to an existing Ansible collection
  • Conventions, tips, and pitfalls
  • Ansible and Python 3
  • Debugging modules
  • Module format and documentation
  • Windows module development walkthrough
  • Developing Cisco ACI modules
  • Guidelines for Ansible Amazon AWS module development
  • OpenStack Ansible Modules
  • oVirt Ansible Modules
  • Guidelines for VMware module development
  • Creating a new collection
  • Testing Ansible
  • The lifecycle of an Ansible module
  • Developing plugins
  • Developing dynamic inventory
  • Developing ansible-base
  • Ansible module architecture
  • Python API
  • Rebasing a pull request
  • Using and developing module utilities
  • Developing collections
  • Migrating Roles to Roles in Collections on Galaxy
  • Collection Galaxy metadata structure
  • Migrating Roles to Roles in Collections on Galaxy
  • Ansible architecture

Common Ansible Scenarios

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

Network Automation

• Network Getting Started
  • Basic Concepts
  • How Network Automation is Different
  • Run Your First Command and Playbook
  • Build Your Inventory
  • Use Ansible network roles
  • Beyond the basics
  • Working with network connection options
  • Resources and next steps
• Network Advanced Topics
  • Network Resource Modules
  • Ansible Network Examples
  • Parsing semi-structured text with Ansible
  • Network Debug and Troubleshooting Guide
  • Working with command output and prompts in network modules
  • Ansible Network FAQ
  • Platform Options
• Network Developer Guide
  • Developing network resource modules
  • Developing network plugins
  • Documenting new network platforms

Ansible Galaxy

• Galaxy User Guide
  • Finding collections on Galaxy
  • Installing collections
  • Finding roles on Galaxy
  • Installing roles from Galaxy
• Galaxy Developer Guide
  • Creating collections for Galaxy
  • Creating roles for Galaxy

Reference & Appendices

• Collection Index
• Indexes of all modules and plugins
• Playbook Keywords
• 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
• Ansible Automation Hub
• Logging Ansible output

Roadmaps

• Ansible Roadmap
  • ansible-base Roadmap
  • Ansible Roadmap
  • Older Roadmaps