mirror of
https://github.com/ansible-collections/community.general.git
synced 2024-09-14 20:13:21 +02:00
* Followup to docs refactor pull request #36067 - fixes gitignore and cleanup in makefile; removes some generated files; moves a straggler to the appropriate subdirectory. * Fixed some stragglers * Removed redundant module entries * Delete generated RST files.
This commit is contained in:
scottb
GitHub
parent
7897558b95
commit
c10080bfba
17 changed files with 32 additions and 5715 deletions
31
.gitignore
vendored
31
.gitignore
vendored
|
|
@ -31,29 +31,22 @@ docs/man/man3/*
|
|||
# docsite stuff...
|
||||
docs/api/_build/
|
||||
docs/api/rst/
|
||||
docs/docsite/*.html
|
||||
docs/docsite/_build
|
||||
docs/docsite/*.html
|
||||
docs/docsite/htmlout
|
||||
docs/docsite/rst/cli/ansible-*.rst
|
||||
docs/docsite/rst/cli/ansible.rst
|
||||
docs/docsite/rst/modules/*.rst
|
||||
docs/docsite/rst/playbooks_directives.rst
|
||||
docs/docsite/rst/plugins_by_category.rst
|
||||
docs/docsite/rst/plugins/*/*.rst
|
||||
docs/docsite/rst/reference_appendices/config.rst
|
||||
docs/docsite/rst/reference_appendices/playbooks_keywords.rst
|
||||
docs/docsite/rst_warnings
|
||||
docs/docsite/searchindex.js
|
||||
docs/docsite/_static/*.gif
|
||||
docs/docsite/_static/*.png
|
||||
docs/docsite/_static/websupport.js
|
||||
docs/docsite/htmlout
|
||||
docs/docsite/searchindex.js
|
||||
docs/docsite/rst_warnings
|
||||
docs/docsite/rst/*_module.rst
|
||||
docs/docsite/rst/ansible.rst
|
||||
docs/docsite/rst/ansible-*.rst
|
||||
docs/docsite/rst/community_maintained.rst
|
||||
docs/docsite/rst/config.rst
|
||||
docs/docsite/rst/core_maintained.rst
|
||||
docs/docsite/rst/list_of_*.rst
|
||||
docs/docsite/rst/module_docs/*.rst
|
||||
docs/docsite/rst/modules_by_category.rst
|
||||
docs/docsite/rst/network_maintained.rst
|
||||
docs/docsite/rst/plugins_by_category.rst
|
||||
docs/docsite/rst/partner_maintained.rst
|
||||
docs/docsite/rst/playbooks_keywords.rst
|
||||
docs/docsite/rst/playbooks_directives.rst
|
||||
docs/docsite/rst/plugins/*/*.rst
|
||||
# deb building stuff...
|
||||
/debian/
|
||||
deb-build
|
||||
|
|
|
|||
|
|
@ -58,19 +58,19 @@ clean:
|
|||
find . -type f \( -name "*~" -or -name "#*" \) -delete
|
||||
find . -type f \( -name "*.swp" \) -delete
|
||||
@echo "Cleaning up generated rst"
|
||||
-rm rst/list_of_*.rst
|
||||
-rm rst/*_by_category.rst
|
||||
-rm rst/*_module.rst
|
||||
-rm rst/*_plugin.rst
|
||||
-rm rst/*_maintained.rst
|
||||
-rm rst/cli/ansible-*.rst
|
||||
-rm rst/cli/ansible.rst
|
||||
-rm rst/modules/*_by_category.rst
|
||||
-rm rst/modules/list_of_*.rst
|
||||
-rm rst/modules/*_maintained.rst
|
||||
-rm rst/modules/*_module.rst
|
||||
-rm rst/modules/*_plugin.rst
|
||||
-rm rst/playbooks_directives.rst
|
||||
-rm rst/playbooks_keywords.rst
|
||||
-rm rst/plugins/*/*.rst
|
||||
-rm rst/config.rst
|
||||
-rm rst/ansible-*.rst
|
||||
-rm rst/ansible.rst
|
||||
-rm rst/reference_appendices/config.rst
|
||||
-rm rst/reference_appendices/playbooks_keywords.rst
|
||||
|
||||
.PHONEY: docs clean
|
||||
.PHONY: docs clean
|
||||
|
||||
# TODO: make generate_man output dir cli option
|
||||
cli: $(GENERATE_CLI)
|
||||
|
|
|
|||
|
|
@ -50,7 +50,6 @@ Ansible, Inc. releases a new major release of Ansible approximately every two mo
|
|||
:caption: Scenario Guides
|
||||
|
||||
networking_guide/network
|
||||
..scenario_guides/guides
|
||||
scenario_guides/guide_aws
|
||||
scenario_guides/guide_azure
|
||||
scenario_guides/guide_rax
|
||||
|
|
@ -65,7 +64,7 @@ Ansible, Inc. releases a new major release of Ansible approximately every two mo
|
|||
:maxdepth: 2
|
||||
:caption: Reference & Appendices
|
||||
|
||||
reference_appendices/modules_by_category
|
||||
../modules/modules_by_category
|
||||
reference_appendices/playbooks_keywords
|
||||
reference_appendices/galaxy
|
||||
reference_appendices/common_return_values
|
||||
|
|
|
|||
File diff suppressed because it is too large
Load diff
|
|
@ -1,7 +0,0 @@
|
|||
Module Index
|
||||
============
|
||||
|
||||
|
||||
.. toctree:: :maxdepth: 1
|
||||
|
||||
../modules/modules_by_category
|
||||
|
|
@ -1,424 +0,0 @@
|
|||
Playbook Keywords
|
||||
=================
|
||||
|
||||
These are the keywords available on common playbook objects.
|
||||
|
||||
.. note:: Please note:
|
||||
|
||||
* Aliases for the directives are not reflected here, nor are mutable one. For example,
|
||||
:term:`action` in task can be substituted by the name of any Ansible module.
|
||||
* The keywords do not have ``version_added`` information at this time
|
||||
* Some keywords set defaults for the objects inside of them rather than for the objects
|
||||
themselves
|
||||
|
||||
|
||||
.. contents::
|
||||
:local:
|
||||
:depth: 1
|
||||
|
||||
|
||||
Play
|
||||
----
|
||||
.. glossary::
|
||||
|
||||
always_run
|
||||
*DEPRECATED*, forces a task to run even in check mode. Use :term:`check_mode` directive instead.
|
||||
|
||||
any_errors_fatal
|
||||
Force any un-handled task errors on any host to propagate to all hosts and end the play.
|
||||
|
||||
become
|
||||
Boolean that controls if privilege escalation is used or not on :term:`Task` execution.
|
||||
|
||||
become_flags
|
||||
A string of flag(s) to pass to the privilege escalation program when :term:`become` is True.
|
||||
|
||||
become_method
|
||||
Which method of privilege escalation to use (such as sudo or su).
|
||||
|
||||
become_user
|
||||
User that you 'become' after using privilege escalation. The remote/login user must have permissions to become this user.
|
||||
|
||||
check_mode
|
||||
A boolean that controls if a task is executed in 'check' mode
|
||||
|
||||
.. seealso:: :ref:`check_mode_dry`
|
||||
|
||||
connection
|
||||
Allows you to change the connection plugin used for tasks to execute on the target.
|
||||
|
||||
.. seealso:: :ref:`using_connection`
|
||||
|
||||
debugger
|
||||
UNDOCUMENTED!!
|
||||
|
||||
diff
|
||||
Toggle to make tasks return 'diff' information or not.
|
||||
|
||||
environment
|
||||
A dictionary that gets converted into environment vars to be provided for the task upon execution.
|
||||
|
||||
fact_path
|
||||
Set the fact path option for the fact gathering plugin controlled by :term:`gather_facts`.
|
||||
|
||||
force_handlers
|
||||
Will force notified handler execution for hosts even if they failed during the play. Will not trigger if the play itself fails.
|
||||
|
||||
gather_facts
|
||||
A boolean that controls if the play will automatically run the 'setup' task to gather facts for the hosts.
|
||||
|
||||
gather_subset
|
||||
Allows you to pass subset options to the fact gathering plugin controlled by :term:`gather_facts`.
|
||||
|
||||
gather_timeout
|
||||
Allows you to set the timeout for the fact gathering plugin controlled by :term:`gather_facts`.
|
||||
|
||||
handlers
|
||||
A section with tasks that are treated as handlers, these won't get executed normally, only when notified after each section of tasks is complete.
|
||||
|
||||
hosts
|
||||
A list of groups, hosts or host pattern that translates into a list of hosts that are the play's target.
|
||||
|
||||
ignore_errors
|
||||
Boolean that allows you to ignore task failures and continue with play. It does not affect connection errors.
|
||||
|
||||
max_fail_percentage
|
||||
can be used to abort the run after a given percentage of hosts in the current batch has failed.
|
||||
|
||||
name
|
||||
Identifier. Can be used for documentation, in or tasks/handlers.
|
||||
|
||||
no_log
|
||||
Boolean that controls information disclosure.
|
||||
|
||||
order
|
||||
Controls the sorting of hosts as they are used for executing the play. Possible values are inventory (default), sorted, reverse_sorted, reverse_inventory and shuffle.
|
||||
|
||||
port
|
||||
Used to override the default port used in a connection.
|
||||
|
||||
post_tasks
|
||||
A list of tasks to execute after the :term:`tasks` section.
|
||||
|
||||
pre_tasks
|
||||
A list of tasks to execute before :term:`roles`.
|
||||
|
||||
remote_user
|
||||
User used to log into the target via the connection plugin.
|
||||
|
||||
roles
|
||||
List of roles to be imported into the play
|
||||
|
||||
run_once
|
||||
Boolean that will bypass the host loop, forcing the task to execute on the first host available and will also apply any facts to all active hosts.
|
||||
|
||||
serial
|
||||
Explicitly define how Ansible batches the execution of the current play on the play's target
|
||||
|
||||
.. seealso:: :ref:`rolling_update_batch_size`
|
||||
|
||||
strategy
|
||||
Allows you to choose the connection plugin to use for the play.
|
||||
|
||||
tags
|
||||
Tags applied to the task or included tasks, this allows selecting subsets of tasks from the command line.
|
||||
|
||||
tasks
|
||||
Main list of tasks to execute in the play, they run after :term:`roles` and before :term:`post_tasks`.
|
||||
|
||||
vars
|
||||
Dictionary/map of variables
|
||||
|
||||
vars_files
|
||||
List of files that contain vars to include in the play.
|
||||
|
||||
vars_prompt
|
||||
list of variables to prompt for.
|
||||
|
||||
vault_password
|
||||
Secret used to decrypt vaulted files or variables.
|
||||
|
||||
|
||||
Role
|
||||
----
|
||||
.. glossary::
|
||||
|
||||
always_run
|
||||
*DEPRECATED*, forces a task to run even in check mode. Use :term:`check_mode` directive instead.
|
||||
|
||||
any_errors_fatal
|
||||
Force any un-handled task errors on any host to propagate to all hosts and end the play.
|
||||
|
||||
become
|
||||
Boolean that controls if privilege escalation is used or not on :term:`Task` execution.
|
||||
|
||||
become_flags
|
||||
A string of flag(s) to pass to the privilege escalation program when :term:`become` is True.
|
||||
|
||||
become_method
|
||||
Which method of privilege escalation to use (such as sudo or su).
|
||||
|
||||
become_user
|
||||
User that you 'become' after using privilege escalation. The remote/login user must have permissions to become this user.
|
||||
|
||||
check_mode
|
||||
A boolean that controls if a task is executed in 'check' mode
|
||||
|
||||
.. seealso:: :ref:`check_mode_dry`
|
||||
|
||||
connection
|
||||
Allows you to change the connection plugin used for tasks to execute on the target.
|
||||
|
||||
.. seealso:: :ref:`using_connection`
|
||||
|
||||
debugger
|
||||
UNDOCUMENTED!!
|
||||
|
||||
delegate_facts
|
||||
Boolean that allows you to apply facts to a delegated host instead of inventory_hostname.
|
||||
|
||||
delegate_to
|
||||
Host to execute task instead of the target (inventory_hostname). Connection vars from the delegated host will also be used for the task.
|
||||
|
||||
diff
|
||||
Toggle to make tasks return 'diff' information or not.
|
||||
|
||||
environment
|
||||
A dictionary that gets converted into environment vars to be provided for the task upon execution.
|
||||
|
||||
ignore_errors
|
||||
Boolean that allows you to ignore task failures and continue with play. It does not affect connection errors.
|
||||
|
||||
name
|
||||
Identifier. Can be used for documentation, in or tasks/handlers.
|
||||
|
||||
no_log
|
||||
Boolean that controls information disclosure.
|
||||
|
||||
port
|
||||
Used to override the default port used in a connection.
|
||||
|
||||
remote_user
|
||||
User used to log into the target via the connection plugin.
|
||||
|
||||
run_once
|
||||
Boolean that will bypass the host loop, forcing the task to execute on the first host available and will also apply any facts to all active hosts.
|
||||
|
||||
tags
|
||||
Tags applied to the task or included tasks, this allows selecting subsets of tasks from the command line.
|
||||
|
||||
vars
|
||||
Dictionary/map of variables
|
||||
|
||||
when
|
||||
Conditional expression, determines if an iteration of a task is run or not.
|
||||
|
||||
|
||||
Block
|
||||
-----
|
||||
.. glossary::
|
||||
|
||||
always
|
||||
List of tasks, in a block, that execute no matter if there is an error in the block or not.
|
||||
|
||||
always_run
|
||||
*DEPRECATED*, forces a task to run even in check mode. Use :term:`check_mode` directive instead.
|
||||
|
||||
any_errors_fatal
|
||||
Force any un-handled task errors on any host to propagate to all hosts and end the play.
|
||||
|
||||
become
|
||||
Boolean that controls if privilege escalation is used or not on :term:`Task` execution.
|
||||
|
||||
become_flags
|
||||
A string of flag(s) to pass to the privilege escalation program when :term:`become` is True.
|
||||
|
||||
become_method
|
||||
Which method of privilege escalation to use (such as sudo or su).
|
||||
|
||||
become_user
|
||||
User that you 'become' after using privilege escalation. The remote/login user must have permissions to become this user.
|
||||
|
||||
block
|
||||
List of tasks in a block.
|
||||
|
||||
check_mode
|
||||
A boolean that controls if a task is executed in 'check' mode
|
||||
|
||||
.. seealso:: :ref:`check_mode_dry`
|
||||
|
||||
connection
|
||||
Allows you to change the connection plugin used for tasks to execute on the target.
|
||||
|
||||
.. seealso:: :ref:`using_connection`
|
||||
|
||||
debugger
|
||||
UNDOCUMENTED!!
|
||||
|
||||
delegate_facts
|
||||
Boolean that allows you to apply facts to a delegated host instead of inventory_hostname.
|
||||
|
||||
delegate_to
|
||||
Host to execute task instead of the target (inventory_hostname). Connection vars from the delegated host will also be used for the task.
|
||||
|
||||
diff
|
||||
Toggle to make tasks return 'diff' information or not.
|
||||
|
||||
environment
|
||||
A dictionary that gets converted into environment vars to be provided for the task upon execution.
|
||||
|
||||
ignore_errors
|
||||
Boolean that allows you to ignore task failures and continue with play. It does not affect connection errors.
|
||||
|
||||
name
|
||||
Identifier. Can be used for documentation, in or tasks/handlers.
|
||||
|
||||
no_log
|
||||
Boolean that controls information disclosure.
|
||||
|
||||
port
|
||||
Used to override the default port used in a connection.
|
||||
|
||||
remote_user
|
||||
User used to log into the target via the connection plugin.
|
||||
|
||||
rescue
|
||||
List of tasks in a :term:`block` that run if there is a task error in the main :term:`block` list.
|
||||
|
||||
run_once
|
||||
Boolean that will bypass the host loop, forcing the task to execute on the first host available and will also apply any facts to all active hosts.
|
||||
|
||||
tags
|
||||
Tags applied to the task or included tasks, this allows selecting subsets of tasks from the command line.
|
||||
|
||||
vars
|
||||
Dictionary/map of variables
|
||||
|
||||
when
|
||||
Conditional expression, determines if an iteration of a task is run or not.
|
||||
|
||||
|
||||
Task
|
||||
----
|
||||
.. glossary::
|
||||
|
||||
action
|
||||
The 'action' to execute for a task, it normally translates into a C(module) or action plugin.
|
||||
|
||||
always_run
|
||||
*DEPRECATED*, forces a task to run even in check mode. Use :term:`check_mode` directive instead.
|
||||
|
||||
any_errors_fatal
|
||||
Force any un-handled task errors on any host to propagate to all hosts and end the play.
|
||||
|
||||
args
|
||||
*DEPRECATED*, A secondary way to add arguments into a task. Takes a dictionary in which keys map to options and values.
|
||||
|
||||
async_val
|
||||
UNDOCUMENTED!!
|
||||
|
||||
become
|
||||
Boolean that controls if privilege escalation is used or not on :term:`Task` execution.
|
||||
|
||||
become_flags
|
||||
A string of flag(s) to pass to the privilege escalation program when :term:`become` is True.
|
||||
|
||||
become_method
|
||||
Which method of privilege escalation to use (such as sudo or su).
|
||||
|
||||
become_user
|
||||
User that you 'become' after using privilege escalation. The remote/login user must have permissions to become this user.
|
||||
|
||||
changed_when
|
||||
Conditional expression that overrides the task's normal 'changed' status.
|
||||
|
||||
check_mode
|
||||
A boolean that controls if a task is executed in 'check' mode
|
||||
|
||||
.. seealso:: :ref:`check_mode_dry`
|
||||
|
||||
connection
|
||||
Allows you to change the connection plugin used for tasks to execute on the target.
|
||||
|
||||
.. seealso:: :ref:`using_connection`
|
||||
|
||||
debugger
|
||||
UNDOCUMENTED!!
|
||||
|
||||
delay
|
||||
Number of seconds to delay between retries. This setting is only used in combination with :term:`until`.
|
||||
|
||||
delegate_facts
|
||||
Boolean that allows you to apply facts to a delegated host instead of inventory_hostname.
|
||||
|
||||
delegate_to
|
||||
Host to execute task instead of the target (inventory_hostname). Connection vars from the delegated host will also be used for the task.
|
||||
|
||||
diff
|
||||
Toggle to make tasks return 'diff' information or not.
|
||||
|
||||
environment
|
||||
A dictionary that gets converted into environment vars to be provided for the task upon execution.
|
||||
|
||||
failed_when
|
||||
Conditional expression that overrides the task's normal 'failed' status.
|
||||
|
||||
ignore_errors
|
||||
Boolean that allows you to ignore task failures and continue with play. It does not affect connection errors.
|
||||
|
||||
local_action
|
||||
Same as action but also implies ``delegate_to: localhost``
|
||||
|
||||
loop
|
||||
Takes a list for the task to iterate over, saving each list element into the ``item`` variable (configurable via loop_control)
|
||||
|
||||
loop_control
|
||||
Several keys here allow you to modify/set loop behaviour in a task.
|
||||
|
||||
.. seealso:: :ref:`loop_control`
|
||||
|
||||
loop_with
|
||||
UNDOCUMENTED!!
|
||||
|
||||
name
|
||||
Identifier. Can be used for documentation, in or tasks/handlers.
|
||||
|
||||
no_log
|
||||
Boolean that controls information disclosure.
|
||||
|
||||
notify
|
||||
List of handlers to notify when the task returns a 'changed=True' status.
|
||||
|
||||
poll
|
||||
Sets the polling interval in seconds for async tasks (default 10s).
|
||||
|
||||
port
|
||||
Used to override the default port used in a connection.
|
||||
|
||||
register
|
||||
Name of variable that will contain task status and module return data.
|
||||
|
||||
remote_user
|
||||
User used to log into the target via the connection plugin.
|
||||
|
||||
retries
|
||||
Number of retries before giving up in a :term:`until` loop. This setting is only used in combination with :term:`until`.
|
||||
|
||||
run_once
|
||||
Boolean that will bypass the host loop, forcing the task to execute on the first host available and will also apply any facts to all active hosts.
|
||||
|
||||
tags
|
||||
Tags applied to the task or included tasks, this allows selecting subsets of tasks from the command line.
|
||||
|
||||
until
|
||||
This keyword implies a ':term:`retries` loop' that will go on until the condition supplied here is met or we hit the :term:`retries` limit.
|
||||
|
||||
vars
|
||||
Dictionary/map of variables
|
||||
|
||||
when
|
||||
Conditional expression, determines if an iteration of a task is run or not.
|
||||
|
||||
with_<lookup_plugin>
|
||||
DEPRECATED: use ``loop`` instead, ``with_`` used to be how loops were defined,
|
||||
|
||||
|
|
@ -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)`,
|
||||
|
|
@ -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)`,
|
||||
|
|
@ -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)`,
|
||||
|
|
@ -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)`,
|
||||
|
|
@ -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)`,
|
||||
|
|
@ -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)`,
|
||||
|
|
@ -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)`,
|
||||
|
|
@ -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)`,
|
||||
|
|
@ -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)`,
|
||||
|
|
@ -7,13 +7,13 @@ Below is a complete list of Ansible utilities. Each page contains a description
|
|||
.. toctree::
|
||||
:maxdepth: 1
|
||||
|
||||
ansible.rst
|
||||
ansible-config.rst
|
||||
ansible-console.rst
|
||||
ansible-doc.rst
|
||||
ansible-galaxy.rst
|
||||
ansible-inventory.rst
|
||||
ansible-playbook.rst
|
||||
ansible-pull.rst
|
||||
ansible-vault.rst
|
||||
../cli/ansible.rst
|
||||
../cli/ansible-config.rst
|
||||
../cli/ansible-console.rst
|
||||
../cli/ansible-doc.rst
|
||||
../cli/ansible-galaxy.rst
|
||||
../cli/ansible-inventory.rst
|
||||
../cli/ansible-playbook.rst
|
||||
../cli/ansible-pull.rst
|
||||
../cli/ansible-vault.rst
|
||||
|
||||
Loading…
Reference in a new issue