pulls playbooks from a VCS repo and executes them for the local host
is used to up a remote copy of ansible on each managed node, each set to run via cron and update playbook source via a source repository. This inverts the default push architecture of ansible into a pull architecture, which has near-limitless scaling potential.
The setup playbook can be tuned to change the cron frequency, logging locations, and parameters to ansible-pull. This is useful both for extreme scale-out as well as periodic remediation. Usage of the ‘fetch’ module to retrieve logs from ansible-pull runs would be an excellent way to gather and analyze remote logs from ansible-pull.
adds the hostkey for the repo url if not already added
ask for vault password
don’t make any changes; instead, try to predict some of the changes that may occur
modified files in the working repository will be discarded
when changing (small) files and templates, show the differences in those files; works great with –check
Do a full clone, instead of a shallow one.
outputs a list of matching hosts; does not execute anything else
use this file to authenticate the connection
purge checkout after playbook run
specify extra arguments to pass to scp only (e.g. -l)
specify extra arguments to pass to sftp only (e.g. -f, -l)
only run plays and tasks whose tags do not match these values
specify common arguments to pass to sftp/scp/ssh (e.g. ProxyCommand)
specify extra arguments to pass to ssh only (e.g. -R)
submodules will track the latest changes. This is equivalent to specifying the –remote flag to git submodule update
the vault identity to use
vault password file
verify GPG signature of checked out commit, if it fails abort running the playbook. This needs the corresponding VCS module to support such an operation
show program’s version number, config file location, configured module search path, module location, executable location and exit
branch/tag/commit to checkout. Defaults to behavior of repository module.
ask for privilege escalation password
prepend colon-separated path(s) to module library (default=~/.ansible/plugins/modules:/usr/share/ansible/plugins/modules)
override the connection timeout in seconds (default=10)
URL of the playbook repository
connection type to use (default=smart)
directory to checkout repository to
set additional variables as key=value or YAML/JSON, if filename prepend with @
run the playbook even if the repository could not be updated
show this help message and exit
specify inventory host path or comma separated host list. –inventory-file is deprecated
ask for connection password
further limit selected hosts to an additional pattern
Repository module name, which ansible will use to check out the repo. Choices are (‘git’, ‘subversion’, ‘hg’, ‘bzr’). Default is git.
only run the playbook if the repository has been updated
sleep for random interval (between 0 and n number of seconds) before starting. This is a useful way to disperse git requests
only run plays and tasks tagged with these values
connect as this user (default=None)
verbose mode (-vvv for more, -vvvv to enable connection debugging)
The following environment variables may be specified.
ANSIBLE_CONFIG – Override the default ansible config file
Many more are available for most options in ansible.cfg
/etc/ansible/ansible.cfg – Config file, used if present
~/.ansible.cfg – User config file, overrides the default config if present