W3cubDocs

/Ansible

Community.General

Collection version 3.8.1

Guides

Plugin Index

These are the plugins in the community.general collection

Become Plugins

  • doas – Do As user
  • dzdo – Centrify’s Direct Authorize
  • ksu – Kerberos substitute user
  • machinectl – Systemd’s machinectl privilege escalation
  • pbrun – PowerBroker run
  • pfexec – profile based execution
  • pmrun – Privilege Manager run
  • sesu – CA Privileged Access Manager
  • sudosu – Run tasks using sudo su -

Cache Plugins

  • memcached – Use memcached DB for cache
  • pickle – Pickle formatted files.
  • redis – Use Redis DB for cache
  • yaml – YAML formatted files.

Callback Plugins

  • cgroup_memory_recap – Profiles maximum memory usage of tasks and full execution using cgroups
  • context_demo – demo callback that adds play/task context
  • counter_enabled – adds counters to the output items (tasks and hosts/task)
  • dense – minimal stdout output
  • diy – Customize the output
  • elastic – Create distributed traces for each Ansible task in Elastic APM
  • hipchat – post task events to hipchat
  • jabber – post task events to a jabber server
  • log_plays – write playbook output to log file
  • loganalytics – Posts task results to Azure Log Analytics
  • logdna – Sends playbook logs to LogDNA
  • logentries – Sends events to Logentries
  • logstash – Sends events to Logstash
  • mail – Sends failure events via email
  • nrdp – Post task results to a Nagios server through nrdp
  • null – Don’t display stuff to screen
  • opentelemetry – Create distributed traces with OpenTelemetry
  • say – notify using software speech synthesizer
  • selective – only print certain tasks
  • slack – Sends play events to a Slack channel
  • splunk – Sends task result events to Splunk HTTP Event Collector
  • sumologic – Sends task result events to Sumologic
  • syslog_json – sends JSON events to syslog
  • unixy – condensed Ansible output
  • yaml – yaml-ized Ansible screen output

Connection Plugins

  • chroot – Interact with local chroot
  • funcd – Use funcd to connect to target
  • iocage – Run tasks in iocage jails
  • jail – Run tasks in jails
  • lxc – Run tasks in lxc containers via lxc python library
  • lxd – Run tasks in lxc containers via lxc CLI
  • qubes – Interact with an existing QubesOS AppVM
  • saltstack – Allow ansible to piggyback on salt minions
  • zone – Run tasks in a zone instance

Inventory Plugins

  • cobbler – Cobbler inventory source
  • gitlab_runners – Ansible dynamic inventory plugin for GitLab runners.
  • icinga2 – Icinga2 inventory source
  • linode – Ansible dynamic inventory plugin for Linode.
  • lxd – Returns Ansible inventory from lxd host
  • nmap – Uses nmap to find hosts to target
  • online – Scaleway (previously Online SAS or Online.net) inventory source
  • opennebula – OpenNebula inventory source
  • proxmox – Proxmox inventory source
  • scaleway – Scaleway inventory source
  • stackpath_compute – StackPath Edge Computing inventory source
  • virtualbox – virtualbox inventory source

Lookup Plugins

  • cartesian – returns the cartesian product of lists
  • chef_databag – fetches data from a Chef Databag
  • consul_kv – Fetch metadata from a Consul key value store.
  • credstash – retrieve secrets from Credstash on AWS
  • cyberarkpassword – get secrets from CyberArk AIM
  • dependent – Composes a list with nested elements of other lists or dicts which can depend on previous loop variables
  • dig – query DNS using the dnspython library
  • dnstxt – query a domain(s)’s DNS txt fields
  • dsv – Get secrets from Thycotic DevOps Secrets Vault
  • etcd – get info from an etcd server
  • etcd3 – Get key values from etcd3 server
  • filetree – recursively match all files in a directory tree
  • flattened – return single list completely flattened
  • hiera – get info from hiera data
  • keyring – grab secrets from the OS keyring
  • lastpass – fetch data from lastpass
  • lmdb_kv – fetch data from LMDB
  • manifold – get credentials from Manifold.co
  • nios – Query Infoblox NIOS objects
  • nios_next_ip – Return the next available IP address for a network
  • nios_next_network – Return the next available network range for a network-container
  • onepassword – fetch field values from 1Password
  • onepassword_raw – fetch an entire item from 1Password
  • passwordstore – manage passwords with passwordstore.org’s pass utility
  • random_pet – Generates random pet names
  • random_string – Generates random string
  • redis – fetch data from Redis
  • shelvefile – read keys from Python shelve file
  • tss – Get secrets from Thycotic Secret Server

Modules

See also

List of collections with docs hosted here.

© 2012–2018 Michael DeHaan
© 2018–2021 Red Hat, Inc.
Licensed under the GNU General Public License version 3.
https://docs.ansible.com/ansible/latest/collections/community/general/index.html