Skip to content

Modules

Modules are the building blocks of a playbook — each one is a YAML task type that does one thing. Modules are organised into categories:

CategoryExamples
filesfile, copy, template, directory, unpack, download, move, git, stat, checksum
packagespackage (apt, pacman, yum/dnf, zypper, homebrew)
servicesservice (sd_service and others)
commandscommand, shell
accessuser
controlassert, echo, debug, set, facts, fail

Module names map to the YAML task type, prefixed with !:

- !file
  path: /etc/motd
  state: present

- !package
  name: htop
  state: present

Documented modules

Note: Reference documentation for the full module set is being written. For now, the module registry source is the authoritative list.