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