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
Playbook Keywords
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
»
System Modules
System Modules
¶
aix_inittab - Manages the inittab on AIX.
aix_lvol - Configure AIX LVM logical volumes
alternatives - Manages alternative programs for common commands
at - Schedule the execution of a command or script file via the at command.
authorized_key - Adds or removes an SSH authorized key
awall - Manage awall policies
beadm - Manage ZFS boot environments on FreeBSD/Solaris/illumos systems.
capabilities - Manage Linux capabilities
cron - Manage cron.d and crontab entries.
cronvar - Manage variables in crontabs
crypttab - Encrypted Linux block devices
dconf - Modify and read dconf database
debconf - Configure a .deb package
facter - Runs the discovery program *facter* on the remote system
filesystem - Makes file system on block device
firewalld - Manage arbitrary ports/services with firewalld
gconftool2 - Edit GNOME Configurations
getent - a wrapper to the unix getent utility
gluster_volume - Manage GlusterFS volumes
group - Add or remove groups
hostname - Manage hostname
interfaces_file - Tweak settings in /etc/network/interfaces files
iptables - Modify the systems iptables
java_cert - Uses keytool to import/remove key from java keystore(cacerts)
kernel_blacklist - Blacklist kernel modules
known_hosts - Add or remove a host from the ``known_hosts`` file
locale_gen - Creates or removes locales.
lvg - Configure LVM volume groups
lvol - Configure LVM logical volumes
make - Run targets in a Makefile
modprobe - Add or remove kernel modules
mount - Control active and configured mount points
ohai - Returns inventory data from *Ohai*
open_iscsi - Manage iscsi targets with open-iscsi
openwrt_init - Manage services on OpenWrt.
osx_defaults - osx_defaults allows users to read, write, and delete Mac OS X user defaults from Ansible
pam_limits - Modify Linux PAM limits
pamd - Manage PAM Modules
parted - Configure block device partitions
ping - Try to connect to host, verify a usable python and return ``pong`` on success
puppet - Runs puppet
runit - Manage runit services.
seboolean - Toggles SELinux booleans.
sefcontext - Manages SELinux file context mapping definitions
selinux - Change policy and state of SELinux
selinux_permissive - Change permissive domain in SELinux policy
seport - Manages SELinux network port type definitions
service - Manage services.
setup - Gathers facts about remote hosts
solaris_zone - Manage Solaris zones
svc - Manage daemontools services.
sysctl - Manage entries in sysctl.conf.
systemd - Manage services.
timezone - Configure timezone setting
ufw - Manage firewall with UFW
user - Manage user accounts
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.