archive
/
ansible
mirror of https://github.com/ansible/ansible.git
1
0
Fork 0
Code Issues Projects Releases Wiki Activity

removed gnerated files

Browse Source 
@dharmabumstead, probably need a few more of these
pull/35785/merge
Brian Coca 7 years ago
parent 43eb97ef92
commit 5a0f4f0646
9 changed files with 0 additions and 2223 deletions
Show Stats Download Patch File Download Diff File

152
docs/docsite/rst/cli/ansible-config.rst
Unescape Escape View File

@ -1,152 +0,0 @@
.. _ansible-config:
==============
ansible-config
==============
:strong:`View, edit, and manage ansible configuration.`
.. contents::
:local:
:depth: 2
.. program:: ansible-config
Synopsis
========
.. code-block:: bash
ansible-config [view|dump|list] [--help] [options] [ansible.cfg]
Description
===========
Config command line class
Common Options
==============
.. option:: --version
show program's version number and exit
.. option:: -c <CONFIG_FILE>, --config <CONFIG_FILE>
path to configuration file, defaults to first file found in precedence.
.. option:: -h, --help
show this help message and exit
.. option:: -v, --verbose
verbose mode (-vvv for more, -vvvv to enable connection debugging)
Actions
=======
.. program:: ansible-config list
.. _ansible_config_list:
list
----
list all current configs reading lib/constants.py and shows env and config file setting names
.. program:: ansible-config dump
.. _ansible_config_dump:
dump
----
Shows the current settings, merges ansible.cfg if specified
.. option:: --only-changed
Only show configurations that have changed from the default
.. program:: ansible-config view
.. _ansible_config_view:
view
----
Displays the current config file
.. program:: ansible-config
Environment
===========
The following environment variables may be specified.
:envvar:`ANSIBLE_CONFIG` -- Override the default ansible config file
Many more are available for most options in ansible.cfg
Files
=====
:file:`/etc/ansible/ansible.cfg` -- Config file, used if present
:file:`~/.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.
Copyright
=========
Copyright © 2017 Red Hat, Inc | Ansible.
Ansible is released under the terms of the GPLv3 License.
See also
========
:manpage:`ansible(1)`, :manpage:`ansible-config(1)`, :manpage:`ansible-console(1)`, :manpage:`ansible-doc(1)`, :manpage:`ansible-galaxy(1)`, :manpage:`ansible-inventory(1)`, :manpage:`ansible-playbook(1)`, :manpage:`ansible-pull(1)`, :manpage:`ansible-vault(1)`,

257
docs/docsite/rst/cli/ansible-console.rst
Unescape Escape View File

@ -1,257 +0,0 @@
.. _ansible-console:
===============
ansible-console
===============
:strong:`REPL console for executing Ansible tasks.`
.. contents::
:local:
:depth: 2
.. program:: ansible-console
Synopsis
========
.. code-block:: bash
ansible-console [<host-pattern>] [options]
Description
===========
a REPL that allows for running ad-hoc tasks against a chosen inventory (based on dominis' ansible-shell).
Common Options
==============
.. option:: --ask-su-pass
ask for su password (deprecated, use become)
.. option:: --ask-sudo-pass
ask for sudo password (deprecated, use become)
.. option:: --ask-vault-pass
ask for vault password
.. option:: --become-method <BECOME_METHOD>
privilege escalation method to use (default=sudo), valid choices: [ sudo | su | pbrun | pfexec | doas | dzdo | ksu | runas | pmrun | enable ]
.. option:: --become-user <BECOME_USER>
run operations as this user (default=root)
.. option:: --list-hosts
outputs a list of matching hosts; does not execute anything else
.. option:: --playbook-dir <BASEDIR>
Since this tool does not use playbooks, use this as a subsitute playbook directory.This sets the relative path for many features including roles/ group_vars/ etc.
.. option:: --private-key, --key-file
use this file to authenticate the connection
.. option:: --scp-extra-args <SCP_EXTRA_ARGS>
specify extra arguments to pass to scp only (e.g. -l)
.. option:: --sftp-extra-args <SFTP_EXTRA_ARGS>
specify extra arguments to pass to sftp only (e.g. -f, -l)
.. option:: --ssh-common-args <SSH_COMMON_ARGS>
specify common arguments to pass to sftp/scp/ssh (e.g. ProxyCommand)
.. option:: --ssh-extra-args <SSH_EXTRA_ARGS>
specify extra arguments to pass to ssh only (e.g. -R)
.. option:: --step
one-step-at-a-time: confirm each task before running
.. option:: --syntax-check
perform a syntax check on the playbook, but do not execute it
.. option:: --vault-id
the vault identity to use
.. option:: --vault-password-file
vault password file
.. option:: --version
show program's version number and exit
.. option:: -C, --check
don't make any changes; instead, try to predict some of the changes that may occur
.. option:: -D, --diff
when changing (small) files and templates, show the differences in those files; works great with --check
.. option:: -K, --ask-become-pass
ask for privilege escalation password
.. option:: -M, --module-path
prepend colon-separated path(s) to module library (default=[u'/Users/sbutler/.ansible/plugins/modules', u'/usr/share/ansible/plugins/modules'])
.. option:: -R <SU_USER>, --su-user <SU_USER>
run operations with su as this user (default=None) (deprecated, use become)
.. option:: -S, --su
run operations with su (deprecated, use become)
.. option:: -T <TIMEOUT>, --timeout <TIMEOUT>
override the connection timeout in seconds (default=10)
.. option:: -U <SUDO_USER>, --sudo-user <SUDO_USER>
desired sudo user (default=root) (deprecated, use become)
.. option:: -b, --become
run operations with become (does not imply password prompting)
.. option:: -c <CONNECTION>, --connection <CONNECTION>
connection type to use (default=smart)
.. option:: -f <FORKS>, --forks <FORKS>
specify number of parallel processes to use (default=5)
.. option:: -h, --help
show this help message and exit
.. option:: -i, --inventory, --inventory-file
specify inventory host path or comma separated host list. --inventory-file is deprecated
.. option:: -k, --ask-pass
ask for connection password
.. option:: -l <SUBSET>, --limit <SUBSET>
further limit selected hosts to an additional pattern
.. option:: -s, --sudo
run operations with sudo (nopasswd) (deprecated, use become)
.. option:: -u <REMOTE_USER>, --user <REMOTE_USER>
connect as this user (default=None)
.. option:: -v, --verbose
verbose mode (-vvv for more, -vvvv to enable connection debugging)
Environment
===========
The following environment variables may be specified.
:envvar:`ANSIBLE_CONFIG` -- Override the default ansible config file
Many more are available for most options in ansible.cfg
Files
=====
:file:`/etc/ansible/ansible.cfg` -- Config file, used if present
:file:`~/.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.
Copyright
=========
Copyright © 2017 Red Hat, Inc | Ansible.
Ansible is released under the terms of the GPLv3 License.
See also
========
:manpage:`ansible(1)`, :manpage:`ansible-config(1)`, :manpage:`ansible-console(1)`, :manpage:`ansible-doc(1)`, :manpage:`ansible-galaxy(1)`, :manpage:`ansible-inventory(1)`, :manpage:`ansible-playbook(1)`, :manpage:`ansible-pull(1)`, :manpage:`ansible-vault(1)`,

130
docs/docsite/rst/cli/ansible-doc.rst
Unescape Escape View File

@ -1,130 +0,0 @@
.. _ansible-doc:
===========
ansible-doc
===========
:strong:`plugin documentation tool`
.. contents::
:local:
:depth: 2
.. program:: ansible-doc
Synopsis
========
.. code-block:: bash
ansible-doc [-l|-F|-s] [options] [-t <plugin type> ] [plugin]
Description
===========
displays information on modules installed in Ansible libraries.
It displays a terse listing of plugins and their short descriptions,
provides a printout of their DOCUMENTATION strings,
and it can create a short "snippet" which can be pasted into a playbook.
Common Options
==============
.. option:: --version
show program's version number and exit
.. option:: -F, --list_files
Show plugin names and their source files without summaries (implies --list)
.. option:: -M, --module-path
prepend colon-separated path(s) to module library (default=[u'/Users/sbutler/.ansible/plugins/modules', u'/usr/share/ansible/plugins/modules'])
.. option:: -a, --all
**For internal testing only** Show documentation for all plugins.
.. option:: -h, --help
show this help message and exit
.. option:: -l, --list
List available plugins
.. option:: -s, --snippet
Show playbook snippet for specified plugin(s)
.. option:: -t <TYPE>, --type <TYPE>
Choose which plugin type (defaults to "module")
.. option:: -v, --verbose
verbose mode (-vvv for more, -vvvv to enable connection debugging)
Environment
===========
The following environment variables may be specified.
:envvar:`ANSIBLE_CONFIG` -- Override the default ansible config file
Many more are available for most options in ansible.cfg
Files
=====
:file:`/etc/ansible/ansible.cfg` -- Config file, used if present
:file:`~/.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.
Copyright
=========
Copyright © 2017 Red Hat, Inc | Ansible.
Ansible is released under the terms of the GPLv3 License.
See also
========
:manpage:`ansible(1)`, :manpage:`ansible-config(1)`, :manpage:`ansible-console(1)`, :manpage:`ansible-doc(1)`, :manpage:`ansible-galaxy(1)`, :manpage:`ansible-inventory(1)`, :manpage:`ansible-playbook(1)`, :manpage:`ansible-pull(1)`, :manpage:`ansible-vault(1)`,

380
docs/docsite/rst/cli/ansible-galaxy.rst
Unescape Escape View File

@ -1,380 +0,0 @@
.. _ansible-galaxy:
==============
ansible-galaxy
==============
:strong:`None`
.. contents::
:local:
:depth: 2
.. program:: ansible-galaxy
Synopsis
========
.. code-block:: bash
ansible-galaxy [delete|import|info|init|install|list|login|remove|search|setup] [--help] [options] ...
Description
===========
command to manage Ansible roles in shared repostories, the default of which is Ansible Galaxy *https://galaxy.ansible.com*.
Common Options
==============
.. option:: --list
List all of your integrations.
.. option:: --remove <REMOVE_ID>
Remove the integration matching the provided ID value. Use --list to see ID values.
.. option:: --version
show program's version number and exit
.. option:: -c, --ignore-certs
Ignore SSL certificate validation errors.
.. option:: -h, --help
show this help message and exit
.. option:: -s <API_SERVER>, --server <API_SERVER>
The API server destination
.. option:: -v, --verbose
verbose mode (-vvv for more, -vvvv to enable connection debugging)
Actions
=======
.. program:: ansible-galaxy info
.. _ansible_galaxy_info:
info
----
prints out detailed information about an installed role as well as info available from the galaxy API.
.. option:: --offline
Don't query the galaxy API when creating roles
.. option:: -p , --roles-path
The path to the directory containing your roles. The default is the roles_path configured in your ansible.cfgfile (/etc/ansible/roles if not configured)
.. program:: ansible-galaxy search
.. _ansible_galaxy_search:
search
------
searches for roles on the Ansible Galaxy server
.. option:: --author <AUTHOR>
GitHub username
.. option:: --galaxy-tags <GALAXY_TAGS>
list of galaxy tags to filter by
.. option:: --platforms <PLATFORMS>
list of OS platforms to filter by
.. option:: -p , --roles-path
The path to the directory containing your roles. The default is the roles_path configured in your ansible.cfgfile (/etc/ansible/roles if not configured)
.. program:: ansible-galaxy setup
.. _ansible_galaxy_setup:
setup
-----
Setup an integration from Github or Travis for Ansible Galaxy roles
.. option:: --list
List all of your integrations.
.. option:: --remove <REMOVE_ID>
Remove the integration matching the provided ID value. Use --list to see ID values.
.. program:: ansible-galaxy list
.. _ansible_galaxy_list:
list
----
lists the roles installed on the local system or matches a single role passed as an argument.
.. option:: -p , --roles-path
The path to the directory containing your roles. The default is the roles_path configured in your ansible.cfgfile (/etc/ansible/roles if not configured)
.. program:: ansible-galaxy remove
.. _ansible_galaxy_remove:
remove
------
removes the list of roles passed as arguments from the local system.
.. option:: -p , --roles-path
The path to the directory containing your roles. The default is the roles_path configured in your ansible.cfgfile (/etc/ansible/roles if not configured)
.. program:: ansible-galaxy init
.. _ansible_galaxy_init:
init
----
creates the skeleton framework of a role that complies with the galaxy metadata format.
.. option:: --container-enabled
Initialize the skeleton role with default contents for a Container Enabled role.
.. option:: --init-path <INIT_PATH>
The path in which the skeleton role will be created. The default is the current working directory.
.. option:: --offline
Don't query the galaxy API when creating roles
.. option:: --role-skeleton <ROLE_SKELETON>
The path to a role skeleton that the new role should be based upon.
.. option:: -f , --force
Force overwriting an existing role
.. program:: ansible-galaxy install
.. _ansible_galaxy_install:
install
-------
uses the args list of roles to be installed, unless -f was specified. The list of roles
can be a name (which will be downloaded via the galaxy API and github), or it can be a local .tar.gz file.
.. option:: -f , --force
Force overwriting an existing role
.. option:: -i , --ignore-errors
Ignore errors and continue with the next specified role.
.. option:: -n , --no-deps
Don't download roles listed as dependencies
.. option:: -p , --roles-path
The path to the directory containing your roles. The default is the roles_path configured in your ansible.cfgfile (/etc/ansible/roles if not configured)
.. option:: -r <ROLE_FILE>, --role-file <ROLE_FILE>
A file containing a list of roles to be imported
.. program:: ansible-galaxy import
.. _ansible_galaxy_import:
import
------
used to import a role into Ansible Galaxy
.. option:: --branch <REFERENCE>
The name of a branch to import. Defaults to the repository's default branch (usually master)
.. option:: --no-wait
Don't wait for import results.
.. option:: --role-name <ROLE_NAME>
The name the role should have, if different than the repo name
.. option:: --status
Check the status of the most recent import request for given github_user/github_repo.
.. program:: ansible-galaxy login
.. _ansible_galaxy_login:
login
-----
verify user's identify via Github and retrieve an auth token from Ansible Galaxy.
.. option:: --github-token <TOKEN>
Identify with github token rather than username and password.
.. program:: ansible-galaxy delete
.. _ansible_galaxy_delete:
delete
------
Delete a role from Ansible Galaxy.
.. program:: ansible-galaxy
Environment
===========
The following environment variables may be specified.
:envvar:`ANSIBLE_CONFIG` -- Override the default ansible config file
Many more are available for most options in ansible.cfg
Files
=====
:file:`/etc/ansible/ansible.cfg` -- Config file, used if present
:file:`~/.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.
Copyright
=========
Copyright © 2017 Red Hat, Inc | Ansible.
Ansible is released under the terms of the GPLv3 License.
See also
========
:manpage:`ansible(1)`, :manpage:`ansible-config(1)`, :manpage:`ansible-console(1)`, :manpage:`ansible-doc(1)`, :manpage:`ansible-galaxy(1)`, :manpage:`ansible-inventory(1)`, :manpage:`ansible-playbook(1)`, :manpage:`ansible-pull(1)`, :manpage:`ansible-vault(1)`,

157
docs/docsite/rst/cli/ansible-inventory.rst
Unescape Escape View File

@ -1,157 +0,0 @@
.. _ansible-inventory:
=================
ansible-inventory
=================
:strong:`None`
.. contents::
:local:
:depth: 2
.. program:: ansible-inventory
Synopsis
========
.. code-block:: bash
ansible-inventory [options] [host|group]
Description
===========
used to display or dump the configured inventory as Ansible sees it
Common Options
==============
.. option:: --ask-vault-pass
ask for vault password
.. option:: --graph
create inventory graph, if supplying pattern it must be a valid group name
.. option:: --host <HOST>
Output specific host info, works as inventory script
.. option:: --list
Output all hosts info, works as inventory script
.. option:: --list-hosts
outputs a list of matching hosts; does not execute anything else
.. option:: --playbook-dir <BASEDIR>
Since this tool does not use playbooks, use this as a subsitute playbook directory.This sets the relative path for many features including roles/ group_vars/ etc.
.. option:: --vars
Add vars to graph display, ignored unless used with --graph
.. option:: --vault-id
the vault identity to use
.. option:: --vault-password-file
vault password file
.. option:: --version
show program's version number and exit
.. option:: -h, --help
show this help message and exit
.. option:: -i, --inventory, --inventory-file
specify inventory host path or comma separated host list. --inventory-file is deprecated
.. option:: -l <SUBSET>, --limit <SUBSET>
further limit selected hosts to an additional pattern
.. option:: -v, --verbose
verbose mode (-vvv for more, -vvvv to enable connection debugging)
.. option:: -y, --yaml
Use YAML format instead of default JSON, ignored for --graph
Environment
===========
The following environment variables may be specified.
:envvar:`ANSIBLE_CONFIG` -- Override the default ansible config file
Many more are available for most options in ansible.cfg
Files
=====
:file:`/etc/ansible/ansible.cfg` -- Config file, used if present
:file:`~/.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.
Copyright
=========
Copyright © 2017 Red Hat, Inc | Ansible.
Ansible is released under the terms of the GPLv3 License.
See also
========
:manpage:`ansible(1)`, :manpage:`ansible-config(1)`, :manpage:`ansible-console(1)`, :manpage:`ansible-doc(1)`, :manpage:`ansible-galaxy(1)`, :manpage:`ansible-inventory(1)`, :manpage:`ansible-playbook(1)`, :manpage:`ansible-pull(1)`, :manpage:`ansible-vault(1)`,

293
docs/docsite/rst/cli/ansible-playbook.rst
Unescape Escape View File

@ -1,293 +0,0 @@
.. _ansible-playbook:
================
ansible-playbook
================
:strong:`Runs Ansible playbooks, executing the defined tasks on the targeted hosts.`
.. contents::
:local:
:depth: 2
.. program:: ansible-playbook
Synopsis
========
.. code-block:: bash
ansible-playbook [options] playbook.yml [playbook2 ...]
Description
===========
the tool to run *Ansible playbooks*, which are a configuration and multinode deployment system.
See the project home page (https://docs.ansible.com) for more information.
Common Options
==============
.. option:: --ask-su-pass
ask for su password (deprecated, use become)
.. option:: --ask-sudo-pass
ask for sudo password (deprecated, use become)
.. option:: --ask-vault-pass
ask for vault password
.. option:: --become-method <BECOME_METHOD>
privilege escalation method to use (default=sudo), valid choices: [ sudo | su | pbrun | pfexec | doas | dzdo | ksu | runas | pmrun | enable ]
.. option:: --become-user <BECOME_USER>
run operations as this user (default=root)
.. option:: --flush-cache
clear the fact cache for every host in inventory
.. option:: --force-handlers
run handlers even if a task fails
.. option:: --list-hosts
outputs a list of matching hosts; does not execute anything else
.. option:: --list-tags
list all available tags
.. option:: --list-tasks
list all tasks that would be executed
.. option:: --private-key, --key-file
use this file to authenticate the connection
.. option:: --scp-extra-args <SCP_EXTRA_ARGS>
specify extra arguments to pass to scp only (e.g. -l)
.. option:: --sftp-extra-args <SFTP_EXTRA_ARGS>
specify extra arguments to pass to sftp only (e.g. -f, -l)
.. option:: --skip-tags
only run plays and tasks whose tags do not match these values
.. option:: --ssh-common-args <SSH_COMMON_ARGS>
specify common arguments to pass to sftp/scp/ssh (e.g. ProxyCommand)
.. option:: --ssh-extra-args <SSH_EXTRA_ARGS>
specify extra arguments to pass to ssh only (e.g. -R)
.. option:: --start-at-task <START_AT_TASK>
start the playbook at the task matching this name
.. option:: --step
one-step-at-a-time: confirm each task before running
.. option:: --syntax-check
perform a syntax check on the playbook, but do not execute it
.. option:: --vault-id
the vault identity to use
.. option:: --vault-password-file
vault password file
.. option:: --version
show program's version number and exit
.. option:: -C, --check
don't make any changes; instead, try to predict some of the changes that may occur
.. option:: -D, --diff
when changing (small) files and templates, show the differences in those files; works great with --check
.. option:: -K, --ask-become-pass
ask for privilege escalation password
.. option:: -M, --module-path
prepend colon-separated path(s) to module library (default=[u'/Users/sbutler/.ansible/plugins/modules', u'/usr/share/ansible/plugins/modules'])
.. option:: -R <SU_USER>, --su-user <SU_USER>
run operations with su as this user (default=None) (deprecated, use become)
.. option:: -S, --su
run operations with su (deprecated, use become)
.. option:: -T <TIMEOUT>, --timeout <TIMEOUT>
override the connection timeout in seconds (default=10)
.. option:: -U <SUDO_USER>, --sudo-user <SUDO_USER>
desired sudo user (default=root) (deprecated, use become)
.. option:: -b, --become
run operations with become (does not imply password prompting)
.. option:: -c <CONNECTION>, --connection <CONNECTION>
connection type to use (default=smart)
.. option:: -e, --extra-vars
set additional variables as key=value or YAML/JSON, if filename prepend with @
.. option:: -f <FORKS>, --forks <FORKS>
specify number of parallel processes to use (default=5)
.. option:: -h, --help
show this help message and exit
.. option:: -i, --inventory, --inventory-file
specify inventory host path or comma separated host list. --inventory-file is deprecated
.. option:: -k, --ask-pass
ask for connection password
.. option:: -l <SUBSET>, --limit <SUBSET>
further limit selected hosts to an additional pattern
.. option:: -s, --sudo
run operations with sudo (nopasswd) (deprecated, use become)
.. option:: -t, --tags
only run plays and tasks tagged with these values
.. option:: -u <REMOTE_USER>, --user <REMOTE_USER>
connect as this user (default=None)
.. option:: -v, --verbose
verbose mode (-vvv for more, -vvvv to enable connection debugging)
Environment
===========
The following environment variables may be specified.
:envvar:`ANSIBLE_CONFIG` -- Override the default ansible config file
Many more are available for most options in ansible.cfg
Files
=====
:file:`/etc/ansible/ansible.cfg` -- Config file, used if present
:file:`~/.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.
Copyright
=========
Copyright © 2017 Red Hat, Inc | Ansible.
Ansible is released under the terms of the GPLv3 License.
See also
========
:manpage:`ansible(1)`, :manpage:`ansible-config(1)`, :manpage:`ansible-console(1)`, :manpage:`ansible-doc(1)`, :manpage:`ansible-galaxy(1)`, :manpage:`ansible-inventory(1)`, :manpage:`ansible-playbook(1)`, :manpage:`ansible-pull(1)`, :manpage:`ansible-vault(1)`,

285
docs/docsite/rst/cli/ansible-pull.rst
Unescape Escape View File

@ -1,285 +0,0 @@
.. _ansible-pull:
============
ansible-pull
============
:strong:`pulls playbooks from a VCS repo and executes them for the local host`
.. contents::
:local:
:depth: 2
.. program:: ansible-pull
Synopsis
========
.. code-block:: bash
ansible-pull -U <repository> [options] [<playbook.yml>]
Description
===========
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.
Common Options
==============
.. option:: --accept-host-key
adds the hostkey for the repo url if not already added
.. option:: --ask-su-pass
ask for su password (deprecated, use become)
.. option:: --ask-sudo-pass
ask for sudo password (deprecated, use become)
.. option:: --ask-vault-pass
ask for vault password
.. option:: --check
don't make any changes; instead, try to predict some of the changes that may occur
.. option:: --clean
modified files in the working repository will be discarded
.. option:: --full
Do a full clone, instead of a shallow one.
.. option:: --list-hosts
outputs a list of matching hosts; does not execute anything else
.. option:: --private-key, --key-file
use this file to authenticate the connection
.. option:: --purge
purge checkout after playbook run
.. option:: --scp-extra-args <SCP_EXTRA_ARGS>
specify extra arguments to pass to scp only (e.g. -l)
.. option:: --sftp-extra-args <SFTP_EXTRA_ARGS>
specify extra arguments to pass to sftp only (e.g. -f, -l)
.. option:: --skip-tags
only run plays and tasks whose tags do not match these values
.. option:: --ssh-common-args <SSH_COMMON_ARGS>
specify common arguments to pass to sftp/scp/ssh (e.g. ProxyCommand)
.. option:: --ssh-extra-args <SSH_EXTRA_ARGS>
specify extra arguments to pass to ssh only (e.g. -R)
.. option:: --track-subs
submodules will track the latest changes. This is equivalent to specifying the --remote flag to git submodule update
.. option:: --vault-id
the vault identity to use
.. option:: --vault-password-file
vault password file
.. option:: --verify-commit
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
.. option:: --version
show program's version number and exit
.. option:: -C <CHECKOUT>, --checkout <CHECKOUT>
branch/tag/commit to checkout. Defaults to behavior of repository module.
.. option:: -K, --ask-become-pass
ask for privilege escalation password
.. option:: -M, --module-path
prepend colon-separated path(s) to module library (default=[u'/Users/sbutler/.ansible/plugins/modules', u'/usr/share/ansible/plugins/modules'])
.. option:: -T <TIMEOUT>, --timeout <TIMEOUT>
override the connection timeout in seconds (default=10)
.. option:: -U <URL>, --url <URL>
URL of the playbook repository
.. option:: -c <CONNECTION>, --connection <CONNECTION>
connection type to use (default=smart)
.. option:: -d <DEST>, --directory <DEST>
directory to checkout repository to
.. option:: -e, --extra-vars
set additional variables as key=value or YAML/JSON, if filename prepend with @
.. option:: -f, --force
run the playbook even if the repository could not be updated
.. option:: -h, --help
show this help message and exit
.. option:: -i, --inventory, --inventory-file
specify inventory host path or comma separated host list. --inventory-file is deprecated
.. option:: -k, --ask-pass
ask for connection password
.. option:: -l <SUBSET>, --limit <SUBSET>
further limit selected hosts to an additional pattern
.. option:: -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 git.
.. option:: -o, --only-if-changed
only run the playbook if the repository has been updated
.. option:: -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
.. option:: -t, --tags
only run plays and tasks tagged with these values
.. option:: -u <REMOTE_USER>, --user <REMOTE_USER>
connect as this user (default=None)
.. option:: -v, --verbose
verbose mode (-vvv for more, -vvvv to enable connection debugging)
Environment
===========
The following environment variables may be specified.
:envvar:`ANSIBLE_CONFIG` -- Override the default ansible config file
Many more are available for most options in ansible.cfg
Files
=====
:file:`/etc/ansible/ansible.cfg` -- Config file, used if present
:file:`~/.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.
Copyright
=========
Copyright © 2017 Red Hat, Inc | Ansible.
Ansible is released under the terms of the GPLv3 License.
See also
========
:manpage:`ansible(1)`, :manpage:`ansible-config(1)`, :manpage:`ansible-console(1)`, :manpage:`ansible-doc(1)`, :manpage:`ansible-galaxy(1)`, :manpage:`ansible-inventory(1)`, :manpage:`ansible-playbook(1)`, :manpage:`ansible-pull(1)`, :manpage:`ansible-vault(1)`,

281
docs/docsite/rst/cli/ansible-vault.rst
Unescape Escape View File

@ -1,281 +0,0 @@
.. _ansible-vault:
=============
ansible-vault
=============
:strong:`encryption/decryption utility for Ansible data files`
.. contents::
:local:
:depth: 2
.. program:: ansible-vault
Synopsis
========
.. code-block:: bash
ansible-vault [create|decrypt|edit|encrypt|encrypt_string|rekey|view] [options] [vaultfile.yml]
Description
===========
can encrypt any structured data file used by Ansible.
This can include *group_vars/* or *host_vars/* inventory variables,
variables loaded by *include_vars* or *vars_files*, or variable files
passed on the ansible-playbook command line with *-e @file.yml* or *-e @file.json*.
Role variables and defaults are also included!
Because Ansible tasks, handlers, and other objects are data, these can also be encrypted with vault.
If you'd like to not expose what variables you are using, you can keep an individual task file entirely encrypted.
The password used with vault currently must be the same for all files you wish to use together at the same time.
Common Options
==============
.. option:: --ask-vault-pass
ask for vault password
.. option:: --new-vault-id <NEW_VAULT_ID>
the new vault identity to use for rekey
.. option:: --new-vault-password-file
new vault password file for rekey
.. option:: --vault-id
the vault identity to use
.. option:: --vault-password-file
vault password file
.. option:: --version
show program's version number and exit
.. option:: -h, --help
show this help message and exit
.. option:: -v, --verbose
verbose mode (-vvv for more, -vvvv to enable connection debugging)
Actions
=======
.. program:: ansible-vault encrypt
.. _ansible_vault_encrypt:
encrypt
-------
encrypt the supplied file using the provided vault secret
.. option:: --encrypt-vault-id <ENCRYPT_VAULT_ID>
the vault id used to encrypt (required if more than vault-id is provided)
.. option:: --output
output file name for encrypt or decrypt; use - for stdout
.. program:: ansible-vault rekey
.. _ansible_vault_rekey:
rekey
-----
re-encrypt a vaulted file with a new secret, the previous secret is required
.. option:: --encrypt-vault-id <ENCRYPT_VAULT_ID>
the vault id used to encrypt (required if more than vault-id is provided)
.. program:: ansible-vault encrypt_string
.. _ansible_vault_encrypt_string:
encrypt_string
--------------
encrypt the supplied string using the provided vault secret
.. option:: --encrypt-vault-id <ENCRYPT_VAULT_ID>
the vault id used to encrypt (required if more than vault-id is provided)
.. option:: --output
output file name for encrypt or decrypt; use - for stdout
.. option:: --stdin-name <ENCRYPT_STRING_STDIN_NAME>
Specify the variable name for stdin
.. option:: -n , --name
Specify the variable name
.. option:: -p , --prompt
Prompt for the string to encrypt
.. program:: ansible-vault edit
.. _ansible_vault_edit:
edit
----
open and decrypt an existing vaulted file in an editor, that will be encryped again when closed
.. program:: ansible-vault create
.. _ansible_vault_create:
create
------
create and open a file in an editor that will be encryped with the provided vault secret when closed
.. option:: --encrypt-vault-id <ENCRYPT_VAULT_ID>
the vault id used to encrypt (required if more than vault-id is provided)
.. program:: ansible-vault decrypt
.. _ansible_vault_decrypt:
decrypt
-------
decrypt the supplied file using the provided vault secret
.. option:: --output
output file name for encrypt or decrypt; use - for stdout
.. program:: ansible-vault view
.. _ansible_vault_view:
view
----
open, decrypt and view an existing vaulted file using a pager using the supplied vault secret
.. program:: ansible-vault
Environment
===========
The following environment variables may be specified.
:envvar:`ANSIBLE_CONFIG` -- Override the default ansible config file
Many more are available for most options in ansible.cfg
Files
=====
:file:`/etc/ansible/ansible.cfg` -- Config file, used if present
:file:`~/.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.
Copyright
=========
Copyright © 2017 Red Hat, Inc | Ansible.
Ansible is released under the terms of the GPLv3 License.
See also
========
:manpage:`ansible(1)`, :manpage:`ansible-config(1)`, :manpage:`ansible-console(1)`, :manpage:`ansible-doc(1)`, :manpage:`ansible-galaxy(1)`, :manpage:`ansible-inventory(1)`, :manpage:`ansible-playbook(1)`, :manpage:`ansible-pull(1)`, :manpage:`ansible-vault(1)`,

288
docs/docsite/rst/cli/ansible.rst
Unescape Escape View File

@ -1,288 +0,0 @@
.. _ansible:
=======
ansible
=======
:strong:`Define and run a single task 'playbook' against a set of hosts`
.. contents::
:local:
:depth: 2
.. program:: ansible
Synopsis
========
.. code-block:: bash
ansible <host-pattern> [options]
Description
===========
is an extra-simple tool/framework/API for doing 'remote things'.
this command allows you to define and run a single task 'playbook' against a set of hosts
Common Options
==============
.. option:: --ask-su-pass
ask for su password (deprecated, use become)
.. option:: --ask-sudo-pass
ask for sudo password (deprecated, use become)
.. option:: --ask-vault-pass
ask for vault password
.. option:: --become-method <BECOME_METHOD>
privilege escalation method to use (default=sudo), valid choices: [ sudo | su | pbrun | pfexec | doas | dzdo | ksu | runas | pmrun | enable ]
.. option:: --become-user <BECOME_USER>
run operations as this user (default=root)
.. option:: --list-hosts
outputs a list of matching hosts; does not execute anything else
.. option:: --playbook-dir <BASEDIR>
Since this tool does not use playbooks, use this as a subsitute playbook directory.This sets the relative path for many features including roles/ group_vars/ etc.
.. option:: --private-key, --key-file
use this file to authenticate the connection
.. option:: --scp-extra-args <SCP_EXTRA_ARGS>
specify extra arguments to pass to scp only (e.g. -l)
.. option:: --sftp-extra-args <SFTP_EXTRA_ARGS>
specify extra arguments to pass to sftp only (e.g. -f, -l)
.. option:: --ssh-common-args <SSH_COMMON_ARGS>
specify common arguments to pass to sftp/scp/ssh (e.g. ProxyCommand)
.. option:: --ssh-extra-args <SSH_EXTRA_ARGS>
specify extra arguments to pass to ssh only (e.g. -R)
.. option:: --syntax-check
perform a syntax check on the playbook, but do not execute it
.. option:: --vault-id
the vault identity to use
.. option:: --vault-password-file
vault password file
.. option:: --version
show program's version number and exit
.. option:: -B <SECONDS>, --background <SECONDS>
run asynchronously, failing after X seconds (default=N/A)
.. option:: -C, --check
don't make any changes; instead, try to predict some of the changes that may occur
.. option:: -D, --diff
when changing (small) files and templates, show the differences in those files; works great with --check
.. option:: -K, --ask-become-pass
ask for privilege escalation password
.. option:: -M, --module-path
prepend colon-separated path(s) to module library (default=[u'/Users/sbutler/.ansible/plugins/modules', u'/usr/share/ansible/plugins/modules'])
.. option:: -P <POLL_INTERVAL>, --poll <POLL_INTERVAL>
set the poll interval if using -B (default=15)
.. option:: -R <SU_USER>, --su-user <SU_USER>
run operations with su as this user (default=None) (deprecated, use become)
.. option:: -S, --su
run operations with su (deprecated, use become)
.. option:: -T <TIMEOUT>, --timeout <TIMEOUT>
override the connection timeout in seconds (default=10)
.. option:: -U <SUDO_USER>, --sudo-user <SUDO_USER>
desired sudo user (default=root) (deprecated, use become)
.. option:: -a <MODULE_ARGS>, --args <MODULE_ARGS>
module arguments
.. option:: -b, --become
run operations with become (does not imply password prompting)
.. option:: -c <CONNECTION>, --connection <CONNECTION>
connection type to use (default=smart)
.. option:: -e, --extra-vars
set additional variables as key=value or YAML/JSON, if filename prepend with @
.. option:: -f <FORKS>, --forks <FORKS>
specify number of parallel processes to use (default=5)
.. option:: -h, --help
show this help message and exit
.. option:: -i, --inventory, --inventory-file
specify inventory host path or comma separated host list. --inventory-file is deprecated
.. option:: -k, --ask-pass
ask for connection password
.. option:: -l <SUBSET>, --limit <SUBSET>
further limit selected hosts to an additional pattern
.. option:: -m <MODULE_NAME>, --module-name <MODULE_NAME>
module name to execute (default=command)
.. option:: -o, --one-line
condense output
.. option:: -s, --sudo
run operations with sudo (nopasswd) (deprecated, use become)
.. option:: -t <TREE>, --tree <TREE>
log output to this directory
.. option:: -u <REMOTE_USER>, --user <REMOTE_USER>
connect as this user (default=None)
.. option:: -v, --verbose
verbose mode (-vvv for more, -vvvv to enable connection debugging)
Environment
===========
The following environment variables may be specified.
:envvar:`ANSIBLE_CONFIG` -- Override the default ansible config file
Many more are available for most options in ansible.cfg
Files
=====
:file:`/etc/ansible/ansible.cfg` -- Config file, used if present
:file:`~/.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.
Copyright
=========
Copyright © 2017 Red Hat, Inc | Ansible.
Ansible is released under the terms of the GPLv3 License.
See also
========
:manpage:`ansible(1)`, :manpage:`ansible-config(1)`, :manpage:`ansible-console(1)`, :manpage:`ansible-doc(1)`, :manpage:`ansible-galaxy(1)`, :manpage:`ansible-inventory(1)`, :manpage:`ansible-playbook(1)`, :manpage:`ansible-pull(1)`, :manpage:`ansible-vault(1)`,
Write Preview
Loading…
Cancel
Save