mirror of
https://github.com/ansible-collections/community.general.git
synced 2025-07-30 00:21:23 -07:00
normalized descriptions for most man pages
also removed the intermediate man page added intermidieate manpages to gitignore
This commit is contained in:
Brian Coca
parent
f3a0adcfa5
commit
8eda94c591
13 changed files with 229 additions and 1223 deletions
|
|
@ -5,9 +5,10 @@ ansible(1)
|
|||
:man version: %VERSION%
|
||||
:man manual: System administration commands
|
||||
|
||||
|
||||
NAME
|
||||
----
|
||||
ansible-pull - set up a remote copy of ansible on each managed node
|
||||
ansible-pull - pull playbooks from VCS server and run them using this machine as the target.
|
||||
|
||||
|
||||
SYNOPSIS
|
||||
|
|
@ -18,8 +19,7 @@ ansible-pull -d DEST -U URL [options] [ <filename.yml> ]
|
|||
DESCRIPTION
|
||||
-----------
|
||||
|
||||
*Ansible* is an extra-simple tool/framework/API for doing \'remote things' over
|
||||
SSH.
|
||||
*Ansible* is an extra-simple tool/framework/API for doing \'remote things'.
|
||||
|
||||
Use ansible-pull to set up a remote copy of ansible on each managed
|
||||
node, each set to run via cron and update playbook source via
|
||||
|
|
@ -54,22 +54,40 @@ OPTIONS
|
|||
|
||||
Adds the hostkey for the repo URL if not already added.
|
||||
|
||||
*--ask-become-pass*::
|
||||
|
||||
Ask for privilege escalation password.
|
||||
|
||||
*-k*, *--ask-pass*::
|
||||
|
||||
Prompt for the connection password, if it is needed for the transport used.
|
||||
For example, using ssh and not having a key-based authentication with ssh-agent.
|
||||
|
||||
*--ask-su-pass*::
|
||||
|
||||
Prompt for su password, used with --su (deprecated, use become).
|
||||
|
||||
*-K*, *--ask-sudo-pass*::
|
||||
|
||||
Ask for sudo password.
|
||||
|
||||
Prompt for the password to use with --sudo, if any (deprecated, use become).
|
||||
|
||||
*--ask-vault-pass*::
|
||||
|
||||
Prompt for vault password.
|
||||
|
||||
*-C* 'CHECKOUT', *--checkout=*'CHECKOUT'::
|
||||
|
||||
Branch/Tag/Commit to checkout. If not provided, uses default behavior of module used to check out playbook repository.
|
||||
|
||||
*-d* 'DEST', *--directory=*'DEST'::
|
||||
|
||||
Directory to checkout repository into. If not provided, a subdirectory of
|
||||
~/.ansible/pull/ will be used.
|
||||
Directory to checkout repository into. If not provided, a subdirectory of ~/.ansible/pull/ will be used.
|
||||
|
||||
*-e* 'EXTRA_VARS', *--extra-vars=*'EXTRA_VARS*::
|
||||
*-e* 'EXTRA_VARS', *--extra-vars=*'EXTRA_VARS::
|
||||
|
||||
Set additional variables as key=value or YAML/JSON
|
||||
Extra variables to inject into a playbook, in key=value key=value format or
|
||||
as quoted YAML/JSON (hashes and arrays). To load variables from a file, specify
|
||||
the file preceded by @ (e.g. @vars.yml).
|
||||
|
||||
*-f*, *--force*::
|
||||
|
||||
|
|
@ -83,11 +101,12 @@ Show the help message and exit.
|
|||
|
||||
*-i* 'PATH', *--inventory=*'PATH'::
|
||||
|
||||
The 'PATH' to the inventory hosts file. This can be a relative path within the checkout.
|
||||
The 'PATH' to the inventory, which defaults to '/etc/ansible/hosts'.
|
||||
Alternatively you can use a comma separated list of hosts or single host with traling comma 'host,'.
|
||||
|
||||
*--key-file=*'KEYFILE'::
|
||||
*--private-key=*'PRIVATE_KEY_FILE'::
|
||||
|
||||
Pass '-i <key_file>' to the SSH arguments used by git.
|
||||
Use this file to authenticate the connection.
|
||||
|
||||
*-m* 'NAME', *--module-name=*'NAME'::
|
||||
|
||||
|
|
@ -140,25 +159,62 @@ Vault password file.
|
|||
Pass -vvv to ansible-playbook.
|
||||
|
||||
|
||||
INVENTORY
|
||||
---------
|
||||
|
||||
Ansible stores the hosts it can potentially operate on in an inventory.
|
||||
This can be an ini-like file, a script, directory or a list.
|
||||
The ini syntax is one host per line. Groups headers are allowed and
|
||||
are included on their own line, enclosed in square brackets that start the line.
|
||||
|
||||
Ranges of hosts are also supported. For more information and
|
||||
additional options, see the documentation on http://docs.ansible.com/.
|
||||
|
||||
|
||||
ENVIRONMENT
|
||||
-----------
|
||||
|
||||
The following environment variables may be specified.
|
||||
|
||||
ANSIBLE_INVENTORY -- Override the default ansible inventory file
|
||||
|
||||
ANSIBLE_LIBRARY -- Override the default ansible module library path
|
||||
|
||||
ANSIBLE_CONFIG -- Override the default ansible config file
|
||||
|
||||
Many more are available for most options in ansible.cfg
|
||||
|
||||
|
||||
FILES
|
||||
-----
|
||||
|
||||
/etc/ansible/hosts -- Default inventory file
|
||||
|
||||
/usr/share/ansible/ -- Default module library
|
||||
|
||||
/etc/ansible/ansible.cfg -- Config file, used if present
|
||||
|
||||
~/.ansible.cfg -- User config file, overrides the default config if present
|
||||
|
||||
|
||||
AUTHOR
|
||||
------
|
||||
|
||||
Ansible was originally written by Michael DeHaan. See the AUTHORS file
|
||||
for a complete list of contributors.
|
||||
Ansible was originally written by Michael DeHaan.
|
||||
See the AUTHORS file for a complete list of contributors.
|
||||
|
||||
|
||||
COPYRIGHT
|
||||
---------
|
||||
|
||||
Copyright © 2012, Michael DeHaan
|
||||
|
||||
Ansible is released under the terms of the GPLv3 License.
|
||||
|
||||
|
||||
SEE ALSO
|
||||
--------
|
||||
|
||||
*ansible*(1), *ansible-playbook*(1), *ansible-doc*(1)
|
||||
*ansible*(1) *ansible-playbook*(1), *ansible-doc*(1), *ansible-vault*(1), *ansible-galaxy*(1)
|
||||
|
||||
Extensive documentation is available in the documentation site:
|
||||
<http://docs.ansible.com>. IRC and mailing list info can be found
|
||||
|
|
|
|||
Loading…
Add table
Add a link
Reference in a new issue