ansible/community.general
1
0
Fork 0
mirror of https://github.com/ansible-collections/community.general.git synced 2024-09-14 20:13:21 +02:00
Code Releases Activity
community.general/docs/man/man1/ansible-playbook.1.asciidoc.in

119 lines
2.3 KiB
Text
Raw Normal View History

Add manpage for ansible-playbook, since it is a command. More detailed docs will remain on the web site.
2012-03-10 04:06:44 +01:00
ansible-playbook(1)
===================
:doctype:manpage
:man source: Ansible
Update %description and auto-add version to manpages Conflicts: docs/man/man1/ansible-playbook.1 docs/man/man1/ansible.1 Update %description
2012-04-17 16:31:29 +02:00
:man version: %VERSION%
Add manpage for ansible-playbook, since it is a command. More detailed docs will remain on the web site.
2012-03-10 04:06:44 +01:00
:man manual: System administration commands
NAME
----
ansible-playbook - run an ansible playbook
SYNOPSIS
--------
ansible-playbook <filename.yml> ... [options]
DESCRIPTION
-----------
Show when options require arguments in the man pages.
2012-03-24 03:29:51 +01:00
*Ansible playbooks* are a configuration and multinode deployment
system. Ansible-playbook is the tool used to run them. See the
project home page (link below) for more information.
Add manpage for ansible-playbook, since it is a command. More detailed docs will remain on the web site.
2012-03-10 04:06:44 +01:00
ARGUMENTS
---------
*filename.yml*::
The names of one or more YAML format files to run as ansible playbooks.
OPTIONS
-------
Remove the -D module debug flag, which no longer is functional due to sudo pty requirements, and replace with -v/--verbose. This flag will show playbook output from non-failing commands. -v is also added to /usr/bin/ansible, but not yet used. I also gutted some internals code dealing with 'invocations' which allowed the callback to know what module invoked it. This is not something 0.5 does or needed, so callbacks have been simplified.
2012-06-20 03:55:57 +02:00
*-v*, *--verbose*
Update manpages, fix missing variable assignment
2012-04-14 01:33:19 +02:00
Remove the -D module debug flag, which no longer is functional due to sudo pty requirements, and replace with -v/--verbose. This flag will show playbook output from non-failing commands. -v is also added to /usr/bin/ansible, but not yet used. I also gutted some internals code dealing with 'invocations' which allowed the callback to know what module invoked it. This is not something 0.5 does or needed, so callbacks have been simplified.
2012-06-20 03:55:57 +02:00
Verbose mode, more output from successful actions will be shown
Add manpage for ansible-playbook, since it is a command. More detailed docs will remain on the web site.
2012-03-10 04:06:44 +01:00
Show when options require arguments in the man pages.
2012-03-24 03:29:51 +01:00
*-i* 'PATH', *--inventory=*'PATH'::
Add manpage for ansible-playbook, since it is a command. More detailed docs will remain on the web site.
2012-03-10 04:06:44 +01:00
Show when options require arguments in the man pages.
2012-03-24 03:29:51 +01:00
The 'PATH' to the inventory hosts file, which defaults to '/etc/ansible/hosts'.
Add manpage for ansible-playbook, since it is a command. More detailed docs will remain on the web site.
2012-03-10 04:06:44 +01:00
Show when options require arguments in the man pages.
2012-03-24 03:29:51 +01:00
*-M* 'DIRECTORY', *--module-path=*'DIRECTORY'::
Add manpage for ansible-playbook, since it is a command. More detailed docs will remain on the web site.
2012-03-10 04:06:44 +01:00
Show when options require arguments in the man pages.
2012-03-24 03:29:51 +01:00
The 'DIRECTORY' to load modules from. The default is '/usr/share/ansible'.
Add manpage for ansible-playbook, since it is a command. More detailed docs will remain on the web site.
2012-03-10 04:06:44 +01:00
Reinstate --extra-vars, which can do things in playbooks like: ansible-playbook release-my-app.yml --extra-vars="version=123" And make $version available in the playbook without re-editing the file
2012-04-27 01:56:10 +02:00
*-e* 'VARS', *--extra-vars=*'VARS'::
Extra variables to inject into a playbook, in key=value key=value format.
Add manpage for ansible-playbook, since it is a command. More detailed docs will remain on the web site.
2012-03-10 04:06:44 +01:00
Show when options require arguments in the man pages.
2012-03-24 03:29:51 +01:00
*-f* 'NUM', *--forks=*'NUM'::
Add manpage for ansible-playbook, since it is a command. More detailed docs will remain on the web site.
2012-03-10 04:06:44 +01:00
Show when options require arguments in the man pages.
2012-03-24 03:29:51 +01:00
Level of parallelism. 'NUM' is specified as an integer, the default is 5.
Add manpage for ansible-playbook, since it is a command. More detailed docs will remain on the web site.
2012-03-10 04:06:44 +01:00
*-k*, *--ask-pass*::
Prompt for the SSH password instead of assuming key-based authentication with ssh-agent.
Update manpages, fix missing variable assignment
2012-04-14 01:33:19 +02:00
*-K*, *--ask-sudo-pass*::
Prompt for the password to use for playbook plays that request sudo access, if any
Show when options require arguments in the man pages.
2012-03-24 03:29:51 +01:00
*-T* 'SECONDS', *--timeout=*'SECONDS'::
Add -T to playbook manpage
2012-03-14 02:54:42 +01:00
Show when options require arguments in the man pages.
2012-03-24 03:29:51 +01:00
Connection timeout to use when trying to talk to hosts, in 'SECONDS'.
Add -T to playbook manpage
2012-03-14 02:54:42 +01:00
Fix man page option description indentation.
2012-04-17 17:39:51 +02:00
*-s*, *--sudo*::
Update docs to reflect --port going away and --sudo and --remote-user being added to ansible-playbook
2012-04-17 04:22:37 +02:00
Force all plays to use sudo, even if not marked as such.
Fix man page option description indentation.
2012-04-17 17:39:51 +02:00
*-u* 'USERNAME', *--remote-user=*'USERNAME'::
Update docs to reflect --port going away and --sudo and --remote-user being added to ansible-playbook
2012-04-17 04:22:37 +02:00
Use this remote user name on playbook steps that do not indicate a user name to run as.
Add manpage for ansible-playbook, since it is a command. More detailed docs will remain on the web site.
2012-03-10 04:06:44 +01:00
ENVIRONMENT
-----------
The following environment variables may specified.
ANSIBLE_HOSTS -- Override the default ansible hosts file
ANSIBLE_LIBRARY -- Override the default ansible module library path
AUTHOR
------
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
--------
Fixup RPM building: Makefile, Spec File, .gitignore Fixup distutils: setup.py Clean old cruft: section 5 man pages
2012-03-10 20:02:25 +01:00
*ansible*(1)
Add manpage for ansible-playbook, since it is a command. More detailed docs will remain on the web site.
2012-03-10 04:06:44 +01:00
Extensive documentation as well as IRC and mailing list info
is available on the ansible home page: <https://ansible.github.com/>
Copy permalink