mirror of
https://github.com/ansible-collections/community.general.git
synced 2025-08-27 08:21:44 -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
|
|
@ -7,19 +7,19 @@ ansible(1)
|
|||
|
||||
NAME
|
||||
----
|
||||
ansible - run a command somewhere else
|
||||
ansible - run a task on a target host(s)
|
||||
|
||||
|
||||
SYNOPSIS
|
||||
--------
|
||||
ansible <host-pattern> [-f forks] [-m module_name] [-a args]
|
||||
ansible <host-pattern> [-m module_name] [-a args] [options]
|
||||
|
||||
|
||||
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'.
|
||||
This is the adhoc command that allows for a \'single task playbook' run.
|
||||
|
||||
|
||||
ARGUMENTS
|
||||
|
|
@ -27,9 +27,8 @@ ARGUMENTS
|
|||
|
||||
*host-pattern*::
|
||||
|
||||
A name of a group in the inventory file, a shell-like glob selecting
|
||||
hosts in inventory file, or any combination of the two separated by
|
||||
semicolons.
|
||||
A name of a group in the inventory, a shell-like glob selecting
|
||||
hosts in inventory or any combination of the two separated by commas.
|
||||
|
||||
OPTIONS
|
||||
-------
|
||||
|
|
@ -40,19 +39,20 @@ The 'ARGUMENTS' to pass to the module.
|
|||
|
||||
*--ask-become-pass*::
|
||||
|
||||
Ask for privilege escalation password.
|
||||
Ask for privilege escalation password.
|
||||
|
||||
*-k*, *--ask-pass*::
|
||||
|
||||
Prompt for the SSH password instead of assuming key-based authentication with ssh-agent.
|
||||
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 (deprecated, use become).
|
||||
Prompt for su password, used with --su (deprecated, use become).
|
||||
|
||||
*-K*, *--ask-sudo-pass*::
|
||||
|
||||
Prompt for the password to use with --sudo, if any.
|
||||
Prompt for the password to use with --sudo, if any (deprecated, use become).
|
||||
|
||||
*--ask-vault-pass*::
|
||||
|
||||
|
|
@ -69,20 +69,24 @@ valid choices: [ sudo | su | pbrun | pfexec | runas | doas ]
|
|||
|
||||
*--become-user=*'BECOME_USER'::
|
||||
|
||||
Run operations as this user (default=None).
|
||||
Run operations as this user (default=root).
|
||||
|
||||
*-C*, *--check*::
|
||||
|
||||
Don't make any changes; instead try to predict some of the changes that may occur.
|
||||
Do not make any changes on the remote system, but test resources to see what might
|
||||
have changed. Note this can not scan all possible resource types and is only
|
||||
a simulation.
|
||||
|
||||
*-c* 'CONNECTION', *--connection=*'CONNECTION'::
|
||||
|
||||
Connection type to use. Possible options are 'paramiko' (SSH), 'ssh',
|
||||
Connection type to use. Most common options are 'paramiko' (SSH), 'ssh', 'winrm'
|
||||
and 'local'. 'local' is mostly useful for crontab or kickstarts.
|
||||
|
||||
*-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* 'NUM', *--forks=*'NUM'::
|
||||
|
||||
|
|
@ -94,15 +98,13 @@ Show help message and exit.
|
|||
|
||||
*-i* 'PATH', *--inventory=*'PATH'::
|
||||
|
||||
The 'PATH' to the inventory hosts file, which defaults to '/etc/ansible/hosts'.
|
||||
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,'.
|
||||
|
||||
*-l* 'SUBSET', *--limit=*'SUBSET'::
|
||||
|
||||
Further limits the selected host/group patterns.
|
||||
|
||||
*-l* '\~REGEX', *--limit=*'~REGEX'::
|
||||
|
||||
Further limits hosts with a regex pattern.
|
||||
You can prefix it with '~' to indicate that the patter in a regex.
|
||||
|
||||
*--list-hosts*::
|
||||
|
||||
|
|
@ -136,12 +138,11 @@ Run operations with su (deprecated, use become).
|
|||
|
||||
*-R* 'SU_USER', *--se-user=*'SUDO_USER'::
|
||||
|
||||
Run operations with su as this user (default=root)
|
||||
(deprecated, use become)
|
||||
Run operations with su as this user (default=root) (deprecated, use become).
|
||||
|
||||
*-s*, *--sudo*::
|
||||
|
||||
Run the command as the user given by -u and sudo to root.
|
||||
Run the command as the user given by -u and sudo to root (deprecated, use become).
|
||||
|
||||
*--ssh-common-args=*''-o ProxyCommand="ssh -W %h:%p ..." ...''::
|
||||
|
||||
|
|
@ -163,7 +164,7 @@ Add the specified arguments to any ssh command-line.
|
|||
|
||||
*-U* 'SUDO_USERNAME', *--sudo-user=*'SUDO_USERNAME'::
|
||||
|
||||
Sudo to 'SUDO_USERNAME' instead of root. Implies --sudo.
|
||||
Sudo to 'SUDO_USERNAME' default is root. (deprecated, use become).
|
||||
|
||||
*-t* 'DIRECTORY', *--tree=*'DIRECTORY'::
|
||||
|
||||
|
|
@ -176,16 +177,18 @@ Connection timeout to use when trying to talk to hosts, in 'SECONDS'.
|
|||
|
||||
*-u* 'USERNAME', *--user=*'USERNAME'::
|
||||
|
||||
Use this remote 'USERNAME' instead of the current user.
|
||||
Use this 'USERNAME' to login to the target host, instead of the current user.
|
||||
|
||||
*--vault-password-file=*'VAULT_PASSWORD_FILE'::
|
||||
|
||||
Vault password file.
|
||||
A file containing the vault password to be used during the decryption of vault encrypted files.
|
||||
Be sure to keep this file secured if it is used. If the file is executable,
|
||||
it will be run and its standard output will be used as the password.
|
||||
|
||||
*-v*, *--verbose*::
|
||||
|
||||
Verbose mode, more output from successful actions will be shown. Give
|
||||
up to three times for more output.
|
||||
Verbose mode, more output from successful actions will be shown.
|
||||
Give up to three times for more output.
|
||||
|
||||
*--version*::
|
||||
|
||||
|
|
@ -194,24 +197,14 @@ Show program version number and exit.
|
|||
INVENTORY
|
||||
---------
|
||||
|
||||
Ansible stores the hosts it can potentially operate on in an inventory
|
||||
file. The 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.
|
||||
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/.
|
||||
|
||||
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
|
||||
|
||||
ENVIRONMENT
|
||||
-----------
|
||||
|
|
@ -224,26 +217,39 @@ 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-playbook*(1), *ansible-pull*(1), *ansible-doc*(1)
|
||||
*ansible-playbook*(1), *ansible-pull*(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