User Guide

Welcome to the Ansible User Guide!

This guide covers how to work with Ansible, including using the command line, working with inventory, and writing playbooks.

• Ansible Quickstart
• Getting Started
  • Foreword
  • Remote Connection Information
  • Your first commands
  • Host Key Checking
• Working with Command Line Tools
  • ansible
  • ansible-config
  • ansible-console
  • ansible-doc
  • ansible-galaxy
  • ansible-inventory
  • ansible-playbook
  • ansible-pull
  • ansible-vault
• Introduction To Ad-Hoc Commands
  • Parallelism and Shell Commands
  • File Transfer
  • Managing Packages
  • Users and Groups
  • Deploying From Source Control
  • Managing Services
  • Time Limited Background Operations
  • Gathering Facts
• Working with Inventory
  • Inventory basics: hosts and groups
  • Assigning a variable to one machine: host variables
  • Assigning a variable to many machines: group variables
  • Default groups
  • Organizing host and group variables
  • How variables are merged
  • Using multiple inventory sources
  • Connecting to hosts: behavioral inventory parameters
• Working With Dynamic Inventory
  • Inventory Script Example: Cobbler
  • Inventory Script Example: AWS EC2
  • Inventory Script Example: OpenStack
  • Other inventory scripts
  • Using Inventory Directories and Multiple Inventory Sources
  • Static Groups of Dynamic Groups
• Working With Playbooks
  • Intro to Playbooks
  • Creating Reusable Playbooks
  • Using Variables
  • Templating (Jinja2)
  • Conditionals
  • Loops
  • Blocks
  • Advanced Playbooks Features
  • Strategies
  • Best Practices
  • Playbook Example: Continuous Delivery and Rolling Upgrades
• Understanding Privilege Escalation
  • Become
  • Directives
  • Become and Networks
  • Become and Windows
• Ansible Vault
  • What Can Be Encrypted With Vault
  • Vault IDs and Multiple Vault Passwords
  • Creating Encrypted Files
  • Editing Encrypted Files
  • Rekeying Encrypted Files
  • Encrypting Unencrypted Files
  • Decrypting Encrypted Files
  • Viewing Encrypted Files
  • Use encrypt_string to create encrypted variables to embed in yaml
  • Providing Vault Passwords
  • Vault Password Client Scripts
  • Speeding Up Vault Operations
  • Vault Format
  • Vault Payload Format 1.1 - 1.2
• Working with Patterns
• Working With Modules
  • Introduction
  • Return Values
  • Module Maintenance & Support
  • Module Index
• Working With Plugins
  • Action Plugins
  • Become Plugins
  • Cache Plugins
  • Callback Plugins
  • Cliconf Plugins
  • Connection Plugins
  • Httpapi Plugins
  • Inventory Plugins
  • Lookup Plugins
  • Shell Plugins
  • Strategy Plugins
  • Vars Plugins
  • Filters
  • Tests
  • Plugin Filter Configuration
• BSD Support
  • Working with BSD
  • Bootstrapping BSD
  • Setting the Python interpreter
  • Which modules are available?
  • Using BSD as the control machine
  • BSD Facts
  • BSD Efforts and Contributions
• Windows Guides
  • Setting up a Windows Host
  • Windows Remote Management
  • Using Ansible and Windows
  • Desired State Configuration
  • Windows Frequently Asked Questions