AnsibleFest
Products
Community
Webinars & Training
Blog
Documentation
Ansible
v2.4
For previous versions, see the
documentation archive.
Introduction
Installation
Getting Started
Inventory
Dynamic Inventory
Patterns
Introduction To Ad-Hoc Commands
Configuration file
BSD Support
Windows Support
Networking Support
Quickstart Video
Playbooks
Intro to Playbooks
Creating Reusable Playbooks
Variables
Templating (Jinja2)
Conditionals
Loops
Blocks
Strategies
Best Practices
Playbooks: Special Topics
Become (Privilege Escalation)
Accelerated Mode
Asynchronous Actions and Polling
Check Mode (“Dry Run”)
Playbook Debugger
Delegation, Rolling Updates, and Local Actions
Setting the Environment (and Working With Proxies)
Working With Language-Specific Version Managers
Error Handling In Playbooks
Advanced Syntax
Lookups
Examples
Prompts
Tags
Using Vault in playbooks
Start and Step
Directives Glossary
About 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
Ansible Vault
What Can Be Encrypted With Vault
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
Vault Ids and Multiple Vault Passwords
Providing Vault Passwords
Speeding Up Vault Operations
Vault Format
Vault Payload Format 1.1
Command Line Tools
ansible
ansible-playbook
ansible-vault
ansible-galaxy
ansible-console
ansible-config
ansible-doc
ansible-inventory
ansible-pull
Detailed Guides
Amazon Web Services Guide
Getting Started with Azure
Rackspace Cloud Guide
Google Cloud Platform Guide
CloudStack Cloud Guide
Using Vagrant and Ansible
Continuous Delivery and Rolling Upgrades
Getting Started with Docker
Using Ansible with the Packet host
Developer Information
Ansible Developer Guide
Ansible Tower
Community Information & Contributing
Ansible Users
For Current and Prospective Developers
Other Topics
Community Code of Conduct
Contributors License Agreement
Ansible Galaxy
The Website
The command line tool
Testing Strategies
Integrating Testing With Ansible Playbooks
The Right Level of Testing
Check Mode As A Drift Test
Modules That Are Useful for Testing
Testing Lifecycle
Integrating Testing With Rolling Updates
Achieving Continuous Deployment
Conclusion
Frequently Asked Questions
How can I set the PATH or any other environment variable for a task or entire playbook?
How do I handle different machines needing different user accounts or ports to log in with?
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 configure a jump host to access servers that I have no direct access to?
How do I speed up management inside EC2?
How do I handle python pathing not having a Python 2.X in /usr/bin/python on a remote machine?
What is the best way to make content reusable/redistributable?
Where does the configuration file live and what can I configure in it?
How do I disable cowsay?
How do I see a list of all of the ansible_ variables?
How do I see all the inventory vars defined for my host?
How do I loop over a list of hosts in a group, inside of a template?
How do I access a variable name programmatically?
How do I access a variable of the first host in a group?
How do I copy files recursively onto a target host?
How do I access shell environment variables?
How do I generate crypted passwords for the user module?
Can I get training on Ansible?
Is there a web interface / REST API / etc?
How do I submit a change to the documentation?
How do I keep secret data in my playbook?
When should I use {{ }}? Also, how to interpolate variables or dynamic variable names
Why don’t you ship in X format?
I don’t see my question here
Configuration
Common Options
Environment Variables
Glossary
YAML Syntax
YAML Basics
Gotchas
Ansible Porting Guides
Python 3 Support
Testing Python 3 with commands and playbooks
Testing Python 3 module support
What to do if an incompatibility is found
Release and maintenance
Release cycle
Release status
Development and stable version maintenance workflow
AnsibleFest
Products
Community
Webinars & Training
Blog
Ansible Documentation
Docs
»
Modules Maintained by the Ansible Partners
Edit on GitHub
Modules Maintained by the Ansible Partners
¶
aws_kms - Perform various KMS management tasks.
azure_rm_deployment - Create or destroy Azure Resource Manager template deployments
azure_rm_networkinterface - Manage Azure network interfaces.
azure_rm_networkinterface_facts - Get network interface facts.
azure_rm_publicipaddress - Manage Azure Public IP Addresses.
azure_rm_publicipaddress_facts - Get public IP facts.
azure_rm_resourcegroup - Manage Azure resource groups.
azure_rm_resourcegroup_facts - Get resource group facts.
azure_rm_securitygroup - Manage Azure network security groups.
azure_rm_securitygroup_facts - Get security group facts.
azure_rm_storageaccount - Manage Azure storage accounts.
azure_rm_storageaccount_facts - Get storage account facts.
azure_rm_storageblob - Manage blob containers and blob objects.
azure_rm_subnet - Manage Azure subnets.
azure_rm_virtualmachine - Manage Azure virtual machines.
azure_rm_virtualmachineimage_facts - Get virtual machine image facts.
azure_rm_virtualnetwork - Manage Azure virtual networks.
azure_rm_virtualnetwork_facts - Get virtual network facts.
ec2_ami - create or destroy an image in ec2
ec2_asg - Create or delete AWS Autoscaling Groups
ec2_eip - manages EC2 elastic IP (EIP) addresses.
ec2_elb - De-registers or registers instances from EC2 ELBs
ec2_elb_lb - Creates or destroys Amazon ELB.
ec2_key - maintain an ec2 key pair.
ec2_lc - Create or delete AWS Autoscaling Launch Configurations
ec2_metric_alarm - Create/update or delete AWS Cloudwatch ‘metric alarms’
ec2_remote_facts **(D)** - Gather facts about ec2 instances in AWS
ec2_scaling_policy - Create or delete AWS scaling policies for Autoscaling groups
ec2_tag - create and remove tag(s) to ec2 resources.
ec2_vpc **(D)** - configure AWS virtual private clouds
ec2_vpc_dhcp_option - Manages DHCP Options, and can ensure the DHCP options for the given VPC match what’s requested
ec2_vpc_igw - Manage an AWS VPC Internet gateway
ec2_vpc_nacl - create and delete Network ACLs.
ec2_vpc_nacl_facts - Gather facts about Network ACLs in an AWS VPC
ec2_vpc_peer - create, delete, accept, and reject VPC peering connections between two VPCs.
ec2_vpc_route_table - Manage route tables for AWS virtual private clouds
ec2_vpc_vgw - Create and delete AWS VPN Virtual Gateways.
efs - create and maintain EFS file systems
efs_facts - Get information about Amazon EFS file systems
elb_classic_lb - Creates or destroys Amazon ELB.
elb_instance - De-registers or registers instances from EC2 ELBs
iam - Manage IAM users, groups, roles and keys
s3_lifecycle - Manage s3 bucket lifecycle rules in AWS
s3_logging - Manage logging facility of an s3 bucket in AWS
sns_topic - Manages AWS SNS topics and subscriptions
sqs_queue - Creates or deletes AWS SQS queues.
sts_assume_role - Assume a role using AWS Security Token Service and obtain temporary credentials
sts_session_token - Obtain a session token from the AWS Security Token Service
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.