ansible-doc

Display information on modules installed in Ansible libraries. Display a terse listing of plugins and their short descriptions. More information: <https://docs.ansible.com/ansible/latest/cli/ansible-doc.html>.

Install

All systems
curl cmd.cat/ansible-doc.sh
Debian Debian
apt-get install ansible
Ubuntu
apt-get install ansible
Alpine
apk add ansible
Arch Arch Linux
pacman -S ansible
image/svg+xml Kali Linux
apt-get install ansible
CentOS
yum install ansible
Fedora
dnf install ansible
Windows (WSL2)
sudo apt-get update sudo apt-get install ansible
OS X
brew install ansible
Raspbian
apt-get install ansible
Dockerfile
dockerfile.run/ansible-doc
Docker
docker run cmd.cat/ansible-doc ansible-doc powered by Commando

Display information on modules installed in Ansible libraries. Display a terse listing of plugins and their short descriptions. More information: <https://docs.ansible.com/ansible/latest/cli/ansible-doc.html>.

  • List available action plugins (modules):
    ansible-doc --list
  • List available plugins of a specific type:
    ansible-doc --type become|cache|callback|cliconf|connection|... --list
  • Show information about a specific action plugin (module):
    ansible-doc plugin_name
  • Show information about a plugin with a specific type:
    ansible-doc --type become|cache|callback|cliconf|connection|... plugin_name
  • Show the playbook snippet for action plugin (modules):
    ansible-doc --snippet plugin_name
  • Show information about an action plugin (module) as JSON:
    ansible-doc --json plugin_name

© tl;dr; authors and contributors