Ansible.Builtin

Collection version 2.11.0b1

Plugin Index

These are the plugins in the ansible.builtin collection

Become Plugins

• runas – Run As user
• su – Substitute User
• sudo – Substitute User DO

Cache Plugins

• jsonfile – JSON formatted files.
• memory – RAM backed, non persistent

Callback Plugins

• default – default Ansible screen output
• junit – write playbook output to a JUnit file.
• minimal – minimal Ansible screen output
• oneline – oneline Ansible screen output
• tree – Save host events to files

Connection Plugins

• local – execute on controller
• paramiko_ssh – Run tasks via python ssh (paramiko)
• psrp – Run tasks over Microsoft PowerShell Remoting Protocol
• ssh – connect via ssh client binary
• winrm – Run tasks over Microsoft’s WinRM

Inventory Plugins

• advanced_host_list – Parses a ‘host list’ with ranges
• auto – Loads and executes an inventory plugin specified in a YAML config
• constructed – Uses Jinja2 to construct vars and groups based on existing inventory.
• generator – Uses Jinja2 to construct hosts and groups from patterns
• host_list – Parses a ‘host list’ string
• ini – Uses an Ansible INI file as inventory source.
• script – Executes an inventory script that returns JSON
• toml – Uses a specific TOML file as an inventory source.
• yaml – Uses a specific YAML file as an inventory source.

Lookup Plugins

• config – Lookup current Ansible configuration values
• csvfile – read data from a TSV or CSV file
• dict – returns key/value pair items from dictionaries
• env – Read the value of environment variables
• file – read file contents
• fileglob – list files matching a pattern
• first_found – return first file found from list
• indexed_items – rewrites lists to return ‘indexed items’
• ini – read data from a ini file
• inventory_hostnames – list of inventory hosts matching a host pattern
• items – list of items
• lines – read lines from command
• list – simply returns what it is given.
• nested – composes a list with nested elements of other lists
• password – retrieve or generate a random password, stored in a file
• pipe – read output from a command
• random_choice – return random element from list
• sequence – generate a list based on a number sequence
• subelements – traverse nested key from a list of dictionaries
• template – retrieve contents of file after templating with Jinja2
• together – merges lists into synchronized list
• unvault – read vaulted file(s) contents
• url – return contents from URL
• varnames – Lookup matching variable names
• vars – Lookup templated value of variables

Modules

• add_host – Add a host (and alternatively a group) to the ansible-playbook in-memory inventory
• apt – Manages apt-packages
• apt_key – Add or remove an apt key
• apt_repository – Add and remove APT repositories
• assemble – Assemble configuration files from fragments
• assert – Asserts given expressions are true
• async_status – Obtain status of asynchronous task
• blockinfile – Insert/update/remove a text block surrounded by marker lines
• command – Execute commands on targets
• copy – Copy files to remote locations
• cron – Manage cron.d and crontab entries
• debconf – Configure a .deb package
• debug – Print statements during execution
• dnf – Manages packages with the dnf package manager
• dpkg_selections – Dpkg package selection selections
• expect – Executes a command and responds to prompts
• fail – Fail with custom message
• fetch – Fetch files from remote nodes
• file – Manage files and file properties
• find – Return a list of files based on specific criteria
• gather_facts – Gathers facts about remote hosts
• get_url – Downloads files from HTTP, HTTPS, or FTP to node
• getent – A wrapper to the unix getent utility
• git – Deploy software (or files) from git checkouts
• group – Add or remove groups
• group_by – Create Ansible groups based on facts
• hostname – Manage hostname
• import_playbook – Import a playbook
• import_role – Import a role into a play
• import_tasks – Import a task list
• include – Include a play or task list
• include_role – Load and execute a role
• include_tasks – Dynamically include a task list
• include_vars – Load variables from files, dynamically within a task
• iptables – Modify iptables rules
• known_hosts – Add or remove a host from the known_hosts file
• lineinfile – Manage lines in text files
• meta – Execute Ansible ‘actions’
• package – Generic OS package manager
• package_facts – Package information as facts
• pause – Pause playbook execution
• ping – Try to connect to host, verify a usable python and return pong on success
• pip – Manages Python library dependencies
• raw – Executes a low-down and dirty command
• reboot – Reboot a machine
• replace – Replace all instances of a particular string in a file using a back-referenced regular expression
• rpm_key – Adds or removes a gpg key from the rpm db
• script – Runs a local script on a remote node after transferring it
• service – Manage services
• service_facts – Return service state information as fact data
• set_fact – Set host facts from a task
• set_stats – Set stats for the current ansible run
• setup – Gathers facts about remote hosts
• shell – Execute shell commands on targets
• slurp – Slurps a file from remote nodes
• stat – Retrieve file or file system status
• subversion – Deploys a subversion repository
• systemd – Manage services
• sysvinit – Manage SysV services.
• tempfile – Creates temporary files and directories
• template – Template a file out to a target host
• unarchive – Unpacks an archive after (optionally) copying it from the local machine
• uri – Interacts with webservices
• user – Manage user accounts
• validate_argument_spec – Validate role argument specs.
• wait_for – Waits for a condition before continuing
• wait_for_connection – Waits until remote system is reachable/usable
• yum – Manages packages with the yum package manager
• yum_repository – Add or remove YUM repositories

Shell Plugins

• cmd – Windows Command Prompt
• powershell – Windows PowerShell
• sh – POSIX shell (/bin/sh)

Strategy Plugins

• debug – Executes tasks in interactive debug session.
• free – Executes tasks without waiting for all hosts
• host_pinned – Executes tasks on each host without interruption
• linear – Executes tasks in a linear fashion

Vars Plugins

• host_group_vars – In charge of loading group_vars and host_vars