ansible-doc
The command that lists installed modules and plugins and shows the documentation for any one of them.
In more detail
ansible-doc -l lists modules with a one-line description each, and ansible-doc followed by a module name shows its arguments and examples offline. It reads whatever collections are installed on the control node, so it always matches the version you actually run.
Examples
ansible-doc -l ansible.builtinansible-doc ansible.builtin.copyRelated terms
- Ansible module — A small program that knows how to manage one kind of thing, such as a file, a package or a service, and that a task calls to do its work.
- Ansible collection — A distribution package of Ansible content, such as modules, plugins, roles and documentation, published under a namespace.
Taught in
- Ansible Architecture And The Control Node — Ansible Configuration Management at Scale
- Exam Strategy: The First Fifteen Minutes And ansible-doc — RHCE in Ansible (EX294): Automate Red Hat Systems
- Variables And Where They Win: group_vars, host_vars And Play Vars — RHCE in Ansible (EX294): Automate Red Hat Systems
- Finding Modules In Collections: ansible-doc And navigator — RHCE in Ansible (EX294): Automate Red Hat Systems
- RHEL System Roles: timesync And selinux From A Collection — RHCE in Ansible (EX294): Automate Red Hat Systems
- Drill: A Web Node From A Ticket — RHCE in Ansible (EX294): Automate Red Hat Systems
- Drill: Storage Only Where The Disk Exists — RHCE in Ansible (EX294): Automate Red Hat Systems
- Drill: People, Passwords And sudo From The Vault — RHCE in Ansible (EX294): Automate Red Hat Systems