Module Reference
These 134 modules are compiled into the binary. A task naming anything else fails to resolve: there is no Python fallback, so a module that is not listed here is not available.
Collections: builtin (71), community.general (50), posix (13)
| Module | Synopsis | Collection |
|---|---|---|
acl | Set and remove POSIX filesystem access control lists | posix |
add_host
controller | Add a host to the in-memory inventory during a play | builtin |
alternatives | Manage symbolic links in the update-alternatives system | community.general |
ansible.posix.mount | Manage filesystem mounts and their fstab entries | posix |
apt | Install, upgrade and remove packages with apt on Debian and Ubuntu | builtin |
apt_key | Add or remove trusted apt signing keys | builtin |
apt_repository | Add or remove an apt repository definition | builtin |
archive | Create a compressed archive from files on the target | community.general |
assemble | Concatenate fragment files from a directory into one destination file | builtin |
assert
controller | Fail the play unless the given conditions all hold | builtin |
async_status | Poll the status of a task started with async | builtin |
at | Schedule a one-off command with the at daemon | posix |
authorized_key | Manage the SSH keys authorised for a user | posix |
blockinfile | Insert, update or remove a marked block of lines in a file | builtin |
capabilities | Set and remove Linux file capabilities | community.general |
command | Run a command directly, without a shell | builtin |
composer | Manage PHP dependencies with Composer | community.general |
copy | Copy files from the controller to remote hosts | builtin |
cpanm | Install Perl modules with cpanminus | community.general |
cron | Manage entries in a user's crontab | builtin |
dconf | Read and write dconf configuration keys | community.general |
deb822_repository | Manage apt repositories in the deb822 .sources format | builtin |
debconf | Read and set debconf answers before a package is configured | builtin |
debug
controller | Print a message or the value of a variable during a play | builtin |
dnf | Install, upgrade and remove packages with dnf on Fedora and RHEL | builtin |
dnf5 | Install, upgrade and remove packages with the dnf5 backend | builtin |
docker_compose | Bring Docker Compose projects up and down | community.general |
docker_network | Create and remove Docker networks and their options | community.general |
docker_volume | Create and remove named Docker volumes | community.general |
dpkg_selections | Pin or unpin a dpkg package selection | builtin |
easy_install | Install Python packages with easy_install | community.general |
expect | Run a command and answer its interactive prompts | builtin |
fail
controller | Stop the play on this host with a custom message | builtin |
fetch | Copy files from remote hosts back to the controller | builtin |
file | Manage the state, ownership and permissions of files and directories | builtin |
fileglob
controller | List controller-side files matching a glob pattern | community.general |
filesystem | Create and grow filesystems on block devices | community.general |
find | Search a directory tree for files matching size, age or name criteria | builtin |
firewalld | Manage firewalld zones, services, ports and rich rules | posix |
flatpak | Install and remove Flatpak applications | community.general |
gem | Install and remove Ruby gems | community.general |
get_url | Download a file over HTTP, HTTPS or FTP to the target | builtin |
getent | Query a Name Service Switch database such as passwd or group | builtin |
git | Check out and update a git repository on the target | builtin |
group | Create, modify and remove Unix groups | builtin |
group_by
controller | Create inventory groups from a host expression during a play | builtin |
homebrew | Manage Homebrew packages on macOS and Linux | community.general |
hostname | Set the system hostname | builtin |
htpasswd | Manage user entries in an Apache htpasswd file | community.general |
import_role | Statically import a role's tasks at parse time | builtin |
import_tasks | Statically include a task file at parse time | builtin |
include_tasks | Dynamically include a task file at run time | builtin |
include_vars | Load variables from a file or directory into the play | builtin |
ini_file | Manage individual options in an INI-style file | community.general |
iptables | Manage individual iptables rules | builtin |
jenkins_job | Create, update and remove Jenkins jobs | community.general |
json_query
controller | Query a structure with a JMESPath expression | community.general |
known_hosts | Add or remove entries in a known_hosts file | builtin |
lineinfile | Ensure a single line is present in, or absent from, a file | builtin |
listen_ports_facts | Gather facts about TCP and UDP ports in the listening state | community.general |
locale_gen | Generate and remove system locales | community.general |
lvg | Manage LVM volume groups | community.general |
lvm_facts | Gather facts about LVM physical volumes, volume groups and logical volumes | community.general |
lvol | Manage LVM logical volumes | community.general |
mail | Send an email from the playbook | community.general |
make | Run make targets in a directory | community.general |
meta
controller | Control playbook execution flow, such as ending a play or clearing facts | builtin |
modprobe | Load and unload kernel modules | community.general |
mount | Manage filesystem mounts and their fstab entries | builtin |
mount_facts | Gather facts about currently mounted filesystems | builtin |
mysql_user | Manage MySQL and MariaDB user accounts and privileges | community.general |
nmcli | Configure network interfaces through NetworkManager | community.general |
npm | Manage Node.js packages with npm | community.general |
package | Install or remove packages using whichever package manager the target uses | builtin |
package_facts | Gather facts about packages installed on the target | builtin |
pam_limits | Manage entries in limits.conf | community.general |
parted | Create, resize and remove disk partitions | community.general |
patch | Apply a unified diff to files on the target | posix |
pause | Pause the play for a fixed time or until the operator continues | builtin |
ping | Verify that a host is reachable and can run modules | builtin |
pip | Manage Python packages with pip | builtin |
postgresql_privs | Grant and revoke PostgreSQL privileges | community.general |
postgresql_user | Create, alter and drop PostgreSQL login roles | community.general |
rabbitmq_user | Manage RabbitMQ users, tags and permissions | community.general |
raw | Run a command over the connection with no module machinery at all | builtin |
read_csv
controller | Read a CSV file into a list or dictionary of records | community.general |
reboot | Reboot the target and wait for it to come back | builtin |
redis | Run Redis administrative commands such as replication and flush | community.general |
replace | Replace every occurrence of a pattern in a file | builtin |
rhel_facts | Gather RHEL-specific facts about the target | posix |
rhel_rpm_ostree | Manage packages on RHEL rpm-ostree systems | posix |
rpm_key | Add or remove an RPM signing key from the trusted set | builtin |
rpm_ostree_pkg | Layer and remove packages on rpm-ostree systems | posix |
script | Copy a script from the controller, run it on the target, then remove it | builtin |
seboolean | Toggle SELinux boolean policy switches on or off | posix |
sefcontext | Manage SELinux file context mappings | community.general |
selinux | Configure the SELinux enforcing mode and policy | posix |
service | Start, stop, restart and enable services on any init system | builtin |
service_facts | Gather facts about services known to the init system | builtin |
set_fact
controller | Define variables for the current host during a play | builtin |
setup | Collect facts about the target host | builtin |
shell | Run a command through the target's shell, with pipes and redirection | builtin |
slack | Send a message to a Slack channel | community.general |
slurp | Read a file from the target and return it base64-encoded | builtin |
snap | Install and remove snap packages | community.general |
ssh_config | Manage host entries in an SSH client config file | community.general |
stat | Retrieve metadata about a file, directory or device | builtin |
supervisorctl | Control programs managed by supervisord | community.general |
svn | Check out and update a Subversion working copy | builtin |
synchronize
controller | Mirror files between controller and target using rsync | posix |
sysctl | Set kernel parameters and persist them to a sysctl file | posix |
syslogd | Manage the syslog daemon service and its facilities | community.general |
systemd | Manage systemd units, including daemon reloads and masking | builtin |
systemd_service | Manage systemd services by their unit name | builtin |
sysvinit | Manage services on hosts using SysV init scripts | builtin |
tempfile | Create a temporary file or directory on the target | builtin |
template | Render a Jinja2 template on the controller and install the result | builtin |
terraform | Apply and destroy Terraform configurations | community.general |
timezone | Set the system timezone | community.general |
ufw | Manage ufw firewall rules and its default policy | community.general |
unarchive | Unpack an archive, optionally copying it to the target first | builtin |
uri | Make an HTTP request and check or capture the response | builtin |
user | Create, modify and remove user accounts | builtin |
validate_argument_spec | Validate supplied arguments against a role's argument specification | builtin |
vars_prompt | Prompt the operator for a variable value | builtin |
wait_for | Wait for a port, path or pattern to reach a given state | builtin |
wait_for_connection
controller | Wait until the target accepts a connection and can run modules | builtin |
xfs_quota | Manage user, group and project quotas on XFS filesystems | community.general |
xml | Read and modify XML documents with XPath expressions | community.general |
yarn | Manage Node.js packages with Yarn | community.general |
yum | Install, upgrade and remove packages with yum | builtin |
yum_repository | Create and remove yum repository definitions | builtin |
zfs | Manage ZFS datasets, volumes and their properties | community.general |
No module matches that. Parallax has no Python fallback, so if you need one that
is not listed, it has to be
ported to Go
or driven through command / shell.