Skip site navigation (1)Skip section navigation (2)

FreeBSD Manual Pages


home | help
ANSIBLE-PULL(1)		System administration commands	       ANSIBLE-PULL(1)

       ansible-pull  -	pulls  playbooks from a	VCS repo and executes them for
       the local host

       ansible-pull -U <repository> [options] [<playbook.yml>]

       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  ar-
       chitecture, 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 ex-
       treme  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

       --private-key, --key-file
	  use this file	to authenticate	the connection

	  purge	checkout after playbook	run

       --scp-extra-args	'SCP_EXTRA_ARGS'
	  specify extra	arguments to pass to scp only (e.g. -l)

       --sftp-extra-args 'SFTP_EXTRA_ARGS'
	  specify extra	arguments to pass to sftp only (e.g. -f, -l)

	  only run plays and tasks whose tags do not match these values

       --ssh-common-args 'SSH_COMMON_ARGS'
	  specify common arguments to pass to sftp/scp/ssh (e.g. ProxyCommand)

       --ssh-extra-args	'SSH_EXTRA_ARGS'
	  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  run-
	  ning	the  playbook. This needs the corresponding VCS	module to sup-
	  port such an operation

	  show program's version number, config	file location, configured mod-
	  ule search path, module location, executable location	and exit

       -C 'CHECKOUT', --checkout 'CHECKOUT'
	  branch/tag/commit  to	 checkout.  Defaults to	behavior of repository

       -K, --ask-become-pass
	  ask for privilege escalation password

       -M, --module-path
	  prepend colon-separated path(s) to module library  (default=~/.ansi-

       -T 'TIMEOUT', --timeout 'TIMEOUT'
	  override the connection timeout in seconds (default=10)

       -U 'URL', --url 'URL'
	  URL of the playbook repository

       -c 'CONNECTION',	--connection 'CONNECTION'
	  connection type to use (default=smart)

       -d 'DEST', --directory 'DEST'
	  directory to checkout	repository to

       -e, --extra-vars
	  set  additional  variables  as  key=value  or	YAML/JSON, if filename
	  prepend with @

       -f, --force
	  run the playbook even	if the repository could	not be updated

       -h, --help
	  show this help message and exit

       -i, --inventory,	--inventory-file
	  specify inventory host path or comma separated host  list.  --inven-
	  tory-file is deprecated

       -k, --ask-pass
	  ask for connection password

       -l 'SUBSET', --limit 'SUBSET'
	  further limit	selected hosts to an additional	pattern

       -m 'MODULE_NAME', --module-name 'MODULE_NAME'
	  Repository  module  name,  which  ansible  will use to check out the
	  repo.	Choices	are ('git', 'subversion',  'hg',  'bzr').  Default  is

       -o, --only-if-changed
	  only run the playbook	if the repository has been updated

       -s 'SLEEP', --sleep 'SLEEP'
	  sleep	for random interval (between 0 and n number of seconds)	before
	  starting. This is a useful way to disperse git requests

       -t, --tags
	  only run plays and tasks tagged with these values

       -u 'REMOTE_USER', --user	'REMOTE_USER'
	  connect as this user (default=None)

       -v, --verbose
	  verbose mode (-vvv for more, -vvvv to	enable connection debugging)

       The following environment variables may be specified.

       ANSIBLE_CONFIG -- Specify override location for the ansible config file

       Many more are available for most	options	in ansible.cfg

       For a full list	check  or  use  the	 ansi-
       ble-config command.

       /usr/local/etc/ansible/ansible.cfg -- Config file, used if present

       ~/.ansible.cfg  --  User	 config	 file, overrides the default config if

       ./ansible.cfg --	Local config file (in current working  directory)  as-
       sumed to	be 'project specific' and overrides the	rest if	present.

       As  mentioned above, the	ANSIBLE_CONFIG environment variable will over-
       ride all	others.

       Ansible was originally written by Michael DeHaan.

       Copyright A(C) 2018 Red Hat, Inc	| Ansible.  Ansible is released	 under
       the terms of the	GPLv3 license.

       ansible	(1), ansible-config (1), ansible-console (1), ansible-doc (1),
       ansible-galaxy (1), ansible-inventory (1), ansible-playbook (1),	 ansi-
       ble-vault (1)

       Extensive  documentation	 is  available	in  the	documentation site: <->.  IRC and mailing list	info can be  found  in
       file,	      available		in:	    <->

Ansible	2.8.11						       ANSIBLE-PULL(1)


Want to link to this manual page? Use this URL:

home | help