Ansible Documentation
Collections
Environments
Guides
- Accessibility guidelines
- Achieving Continuous Deployment
- Advanced Contributor Guide
- Advanced playbook syntax
- Ansible Automation Hub
- Ansible CLI cheatsheet
- Ansible Collections Contributor Guide
- Ansible Community Guide
- Ansible Community Steering Committee
- Ansible Configuration Settings
- Ansible Ecosystem Project Development Resources
- Ansible Network Examples
- Ansible Network FAQ
- Ansible Porting Guides
- Ansible Reference: Module Utilities
- Ansible Vault
- Ansible allows dot notation and array notation for variables. Which notation should I use?
- Ansible community package collections requirements
- Ansible concepts
- Ansible documentation style guide
- Ansible playbooks
- Ansible tips and tricks
- AnsibleModule
- Argument Spec
- Basic
- Basic Concepts
- Beyond the basics
- Block
- Build Your Inventory
- Building Ansible inventories
- Building an inventory
- Building your first Execution Environment
- Can I get training on Ansible?
- Check Mode As A Drift Test
- Collection Index
- Collections in the Amazon Namespace
- Collections in the Ansible Namespace
- Collections in the Arista Namespace
- Collections in the Awx Namespace
- Collections in the Azure Namespace
- Collections in the Check_point Namespace
- Collections in the Chocolatey Namespace
- Collections in the Cisco Namespace
- Collections in the Cloud Namespace
- Collections in the Cloudscale_ch Namespace
- Collections in the Community Namespace
- Collections in the Containers Namespace
- Collections in the Cyberark Namespace
- Collections in the Dellemc Namespace
- Collections in the F5networks Namespace
- Collections in the Fortinet Namespace
- Collections in the Frr Namespace
- Collections in the Gluster Namespace
- Collections in the Google Namespace
- Collections in the Grafana Namespace
- Collections in the Hetzner Namespace
- Collections in the Hpe Namespace
- Collections in the Ibm Namespace
- Collections in the Ieisystem Namespace
- Collections in the Infinidat Namespace
- Collections in the Infoblox Namespace
- Collections in the Inspur Namespace
- Collections in the Junipernetworks Namespace
- Collections in the Kaytus Namespace
- Collections in the Kubernetes Namespace
- Collections in the Kubevirt Namespace
- Collections in the Lowlydba Namespace
- Collections in the Mellanox Namespace
- Collections in the Microsoft Namespace
- Collections in the Netapp Namespace
- Collections in the Netapp_eseries Namespace
- Collections in the Netbox Namespace
- Collections in the Ngine_io Namespace
- Collections in the Openstack Namespace
- Collections in the Openvswitch Namespace
- Collections in the Ovirt Namespace
- Collections in the Purestorage Namespace
- Collections in the Sensu Namespace
- Collections in the Servicenow Namespace
- Collections in the Splunk Namespace
- Collections in the T_systems_mms Namespace
- Collections in the Telekom_mms Namespace
- Collections in the Theforeman Namespace
- Collections in the Vmware Namespace
- Collections in the Vultr Namespace
- Collections in the Vyos Namespace
- Collections in the Wti Namespace
- Collections index
- Committers Guidelines
- Common
- Common Options
- Common System Issues
- Conclusion
- Conditionals based on ansible_facts
- Conditionals based on variables
- Conditionals with imports
- Conditionals with includes
- Conditionals with reuse
- Conditionals with roles
- Conditions based on registered variables
- Configuring defaults for using encrypted content
- Connection methods and details
- Connection variables
- Contributing to Ansible-maintained Collections
- Contributing to the Ansible Documentation
- Controlling how Ansible behaves: precedence rules
- Creating a playbook
- Creating your first collection pull request
- Dependencies
- Deprecation cycles
- Developer Guide
- Development and maintenance workflows
- Does Ansible support multiple factor authentication 2FA/MFA/biometrics/finterprint/usbkey/OTP/…
- Downloading collections
- Encrypting content with Ansible Vault
- Environment Variables
- Errors
- Executing playbooks
- Execution tricks
- Facts
- Finding collections on Galaxy
- Finding roles on Galaxy
- Format of files encrypted with Ansible Vault
- Frequently Asked Questions
- Galaxy Developer Guide
- Galaxy User Guide
- General tips
- Get more information about a role
- Getting started with Ansible
- Getting started with Execution Environments
- GitHub Admins
- Glossary
- Guidelines for collection maintainers
- How Network Automation is Different
- How can I set the PATH or any other environment variable for a task or entire play?
- How can I speed up Ansible on systems with slow disks?
- How do I access a group variable?
- How do I access a variable name programmatically?
- How do I access a variable of the first host in a group?
- How do I access shell environment variables?
- How do I configure a jump host to access servers that I have no direct access to?
- How do I copy files recursively onto a target host?
- How do I disable cowsay?
- How do I fix ‘protocol error: file name does not match request’ when fetching a file?
- How do I generate encrypted passwords for the user module?
- How do I get Ansible to notice a dead target in a timely manner?
- How do I get ansible to reuse connections, enable Kerberized SSH, or have Ansible pay attention to my local SSH config file?
- How do I get the original ansible_host when I delegate a task?
- How do I handle different machines needing different user accounts or ports to log in with?
- How do I handle not having a Python interpreter at /usr/bin/python on a remote machine?
- How do I handle the package dependencies required by Ansible package dependencies during Ansible installation ?
- How do I keep secret data in my playbook?
- How do I loop over a list of hosts in a group, inside of a template?
- How do I see a list of all of the ansible_ variables?
- How do I see all the inventory variables defined for my host?
- How do I see all the variables specific to my host?
- How do I speed up run of ansible for servers from cloud providers (EC2, openstack,.. )?
- How do I submit a change to the documentation?
- How to build your inventory
- Index of all Become Plugins
- Index of all Cache Plugins
- Index of all Callback Plugins
- Index of all Cliconf Plugins
- Index of all Connection Plugins
- Index of all Filter Plugins
- Index of all Httpapi Plugins
- Index of all Inventory Plugins
- Index of all Lookup Plugins
- Index of all Modules
- Index of all Netconf Plugins
- Index of all Roles
- Index of all Shell Plugins
- Index of all Strategy Plugins
- Index of all Test Plugins
- Index of all Vars Plugins
- Indexes of all modules and plugins
- Installation Guide
- Installing a specific version of a role
- Installing collections
- Installing multiple roles from a file
- Installing multiple roles from multiple files
- Installing roles
- Installing roles and collections from the same requirements.yml file
- Installing roles from Galaxy
- Integrating Testing With Ansible Playbooks
- Integrating Testing With Rolling Updates
- Internal use
- Interpreter Discovery
- Introduction to Ansible
- Introduction to Execution Environments
- Introduction to ad hoc commands
- Introduction to modules
- Inventory tips
- Is there a web interface / REST API / GUI?
- Legacy Public Cloud Guides
- Linguistic guidelines
- List installed roles
- Listing collections
- Loading custom facts
- Logging Ansible output
- Magic variables
- Managing BSD hosts with Ansible
- Managing Windows hosts with Ansible
- Managing vault passwords
- Managing z/OS UNIX hosts with Ansible
- Manipulating data
- Markdown guidelines
- Module maintenance and support
- Modules That Are Useful for Testing
- Modules and plugins index
- More resources
- Network Advanced Topics
- Network Debug and Troubleshooting Guide
- Network Developer Guide
- Network Getting Started
- Network Resource Modules
- On the control node side
- Other Tools and Programs
- Parsing semi-structured text with Ansible
- Patterns: targeting hosts and groups
- Platform Options
- Play
- Playbook Keywords
- Playbook tips
- Precedence categories
- Preparing for a new release
- Protecting sensitive data with Ansible vault
- Protecting sensitive data with no_log
- Python 3 Support
- Red Hat Ansible Automation Platform
- Rejecting modules
- Release Manager Guidelines
- Release cycle overview
- Releases and maintenance
- Remove an installed role
- Removing a collection
- Reporting bugs and requesting features
- Requesting changes to a collection
- Resources and next steps
- Return Values
- Review checklist for collection PRs
- Role
- Run Your First Command and Playbook
- Running Ansible with the community EE image
- Running your EE
- Sample Ansible setup
- Sanity Tests
- Selecting files and templates based on facts
- Selecting variables files based on facts
- Selecting variables, files, or templates based on facts
- Setting up your environment
- Special Variables
- Start automating with Ansible
- Task
- Testing Collection Contributions
- Testing Lifecycle
- Testing Strategies
- The Ansible Collections Development Cycle
- The Ansible Development Cycle
- The Right Level of Testing
- The configuration file
- The ‘validate’ option is not enough for my needs, what do I do?
- Use Ansible network roles
- Using Ansible collections
- Using Ansible command line tools
- Using Ansible modules and plugins
- Using Ansible on Windows, BSD, and z/OS UNIX
- Using Ansible playbooks
- Using Python 3 on the managed machines with commands and playbooks
- Using collections in a playbook
- Using conditionals in loops
- Using encrypted variables and files
- Validate data against set criteria with Ansible
- Verifying collections
- What is the best way to make content reusable/redistributable?
- What is the difference between ansible.legacy and ansible.builtin collections?
- What to do if an incompatibility is found
- When are encrypted files made visible?
- When is it unsafe to bulk-set task arguments from a variable?
- When should I use {{ }}? Also, how to interpolate variables or dynamic variable names
- Where did all the modules go?
- Where did this specific module go?
- Where does the configuration file live and what can I configure in it?
- Why does the regex_search filter return None instead of an empty string?
- Working with command line tools
- Working with command output and prompts in network modules
- Working with dynamic inventory
- Working with network connection options
- Working with playbooks
- Working with plugins
- Working with the Ansible collection repositories
- Working with the Ansible repo
- YAML Basics
- YAML Syntax
- action-plugin-docs
- ansible-core Contributors Guide
- ansible-doc
- ansible-requirements
- ansible_facts[‘distribution_major_version’]
- ansible_facts[‘distribution’]
- ansible_facts[‘os_family’]
- bin-symlinks
- boilerplate
- changelog
- compile
- empty-init
- ignores
- import
- integration-aliases
- line-endings
- mypy
- no-assert
- no-basestring
- no-dict-iteritems
- no-dict-iterkeys
- no-dict-itervalues
- no-get-exception
- no-illegal-filenames
- no-main-display
- no-smart-quotes
- no-unicode-literals
- no-unwanted-files
- obsolete-files
- package-data
- pep8
- pslint
- pylint
- pymarkdown
- reStructuredText guidelines
- release-names
- replace-urlopen
- required-and-default-attributes
- runtime-metadata
- shebang
- shellcheck
- symlinks
- test-constraints
- use-argspec-type-path
- use-compat-six
- validate-modules
- yamllint
Plugins
Settings