ja/LC_MESSAGES/reference_appendices.po

6 msgid ""
20 msgid "YAML Syntax"
24 msgid "This page provides a basic overview of correct YAML syntax, which is how Ansible playbooks (…
28 msgid "We use YAML because it is easier for humans to read and write than other common data formats…
32 msgid "You may also wish to read :ref:`working_with_playbooks` at the same time to see how this is …
36 msgid "YAML Basics"
40 msgid "For Ansible, nearly every YAML file starts with a list. Each item in the list is a list of k…
44 msgid "There's another small quirk to YAML.  All YAML files (regardless of their association with A…
48 msgid "All members of a list are lines beginning at the same indentation level starting with a ``\"…
52 msgid "A dictionary is represented in a simple ``key: value`` form (the colon must be followed by a…
56 msgid "More complicated data structures are possible, such as lists of dictionaries, dictionaries w…
60 msgid "Dictionaries and lists can also be represented in an abbreviated form if you really want to:…
64 msgid "These are called \"Flow collections\"."
68 msgid "Ansible doesn't really use these too much, but you can also specify a boolean value (true/fa…
72 msgid "Use lowercase 'true' or 'false' for boolean values in dictionaries if you want to be compati…
76 msgid "Values can span multiple lines using ``|`` or ``>``.  Spanning multiple lines using a \"Lite…
80 msgid "While in the above ``>`` example all newlines are folded into spaces, there are two ways to …
84 msgid "Let's combine what we learned so far in an arbitrary YAML example. This really has nothing t…
88 msgid "That's all you really need to know about YAML to start writing `Ansible` playbooks."
92 msgid "Gotchas"
96 msgid "While you can put just about anything into an unquoted scalar, there are some exceptions. A …
100 msgid "Because of this, the following is going to result in a YAML syntax error::"
104 msgid "...but this will work::"
108 msgid "You will want to quote hash values using colons followed by a space or the end of the line::"
112 msgid "...and then the colon will be preserved."
116 msgid "Alternatively, you can use double quotes::"
120 msgid "The difference between single quotes and double quotes is that in double quotes you can use …
124 msgid "The list of allowed escapes can be found in the YAML Specification under \"Escape Sequences\…
128 msgid "The following is invalid YAML:"
132 msgid "Further, Ansible uses \"{{ var }}\" for variables.  If a value after a colon starts with a \…
136 msgid "If your value starts with a quote the entire value must be quoted, not just part of it. Here…
140 msgid "Not valid::"
144 msgid "In addition to ``'`` and ``\"`` there are a number of characters that are special (or reserv…
148 msgid "You should also be aware of ``? : -``. In YAML, they are allowed at the beginning of a strin…
152 msgid "In Flow Collections, the rules are a bit more strict::"
156 msgid "Boolean conversion is helpful, but this can be a problem when you want a literal `yes` or ot…
160 msgid "YAML converts certain strings into floating-point values, such as the string `1.0`. If you n…
167 msgid ":ref:`working_with_playbooks`"
171 msgid "Learn what playbooks can do and how to write/run them."
175 msgid "`YAMLLint <http://yamllint.com/>`_"
179 msgid "YAML Lint (online) helps you debug YAML syntax if you are having problems"
183 msgid "`GitHub examples directory <https://github.com/ansible/ansible-examples>`_"
187 msgid "Complete playbook files from the github project source"
191 msgid "`Wikipedia YAML syntax reference <https://en.wikipedia.org/wiki/YAML>`_"
195 msgid "A good guide to YAML syntax"
199 msgid "`Mailing List <https://groups.google.com/group/ansible-project>`_"
203 msgid "Questions? Help? Ideas?  Stop by the list on Google Groups"
213 msgid "`irc.libera.chat <https://libera.chat/>`_"
222 msgid "#ansible IRC chat channel"
226 msgid "#yaml for YAML specific questions"
230 msgid "`YAML 1.1 Specification <https://yaml.org/spec/1.1/>`_"
234 msgid "The Specification for YAML 1.1, which PyYAML and libyaml are currently implementing"
238 msgid "`YAML 1.2 Specification <https://yaml.org/spec/1.2/spec.html>`_"
242 msgid "For completeness, YAML 1.2 is the successor of 1.1"
246 msgid "Ansible Automation Hub"
250 msgid "`Ansible Automation Hub <https://www.ansible.com/products/automation-hub>`_ is the official …
254 msgid "Ansible Automation Hub gives you direct access to trusted content collections from Red Hat a…
258 msgid "Ansible Automation Hub is the downstream Red Hat supported product version of Ansible Galaxy…
262 msgid "Return Values"
266 msgid "Topics"
270 msgid "Ansible modules normally return a data structure that can be registered into a variable, or …
274 msgid "This document covers return values common to all modules."
278 msgid "Some of these keys might be set by Ansible itself once it processes the module's return info…
282 msgid "Common"
286 msgid "backup_file"
290 msgid "For those modules that implement `backup=no|yes` when manipulating files, a path to the back…
295 msgid "changed"
299 msgid "A boolean indicating if the task had to make changes to the target or delegated host."
307 msgid "diff"
311 msgid "Information on differences between the previous and current state. Often a dictionary with e…
315 msgid "failed"
319 msgid "A boolean that indicates if the task was failed or not."
323 msgid "invocation"
327 msgid "Information on how the module was invoked."
331 msgid "msg"
335 msgid "A string with a generic message relayed to the user."
339 msgid "rc"
343 msgid "Some modules execute command line utilities or are geared for executing commands directly (r…
347 msgid "results"
351 msgid "If this key exists, it indicates that a loop was present for the task and that it contains a…
355 msgid "skipped"
359 msgid "A boolean that indicates if the task was skipped or not"
363 msgid "stderr"
367 msgid "Some modules execute command line utilities or are geared for executing commands directly (r…
371 msgid "stderr_lines"
375 msgid "When `stderr` is returned we also always provide this field which is a list of strings, one …
379 msgid "stdout"
383 msgid "Some modules execute command line utilities or are geared for executing commands directly (r…
387 msgid "stdout_lines"
391 msgid "When `stdout` is returned, Ansible always provides a list of strings, each containing one it…
395 msgid "Internal use"
399 msgid "These keys can be added by modules but will be removed from registered variables; they are '…
406 msgid "ansible_facts"
410 msgid "This key should contain a dictionary which will be appended to the facts assigned to the hos…
414 msgid "exception"
418 msgid "This key can contain traceback information caused by an exception in a module. It will only …
422 msgid "warnings"
426 msgid "This key contains a list of strings that will be presented to the user."
430 msgid "deprecations"
434 msgid "This key contains a list of dictionaries that will be presented to the user. Keys of the dic…
439 msgid ":ref:`list_of_collections`"
444 msgid "Browse existing collections, modules, and plugins"
448 msgid "`GitHub modules directory <https://github.com/ansible/ansible/tree/devel/lib/ansible/modules…
452 msgid "Browse source of core and extras modules"
456 msgid "`Mailing List <https://groups.google.com/group/ansible-devel>`_"
460 msgid "Development mailing list"
464 msgid "Ansible Configuration Settings"
468 msgid "Ansible supports several sources for configuring its behavior, including an ini file named `…
472 msgid "The ``ansible-config`` utility allows users to see all the configuration settings available,…
476 msgid "The configuration file"
480 msgid "Changes can be made and used in a configuration file which will be searched for in the follo…
485 msgid "``ANSIBLE_CONFIG`` (environment variable if set)"
490 msgid "``ansible.cfg`` (in the current directory)"
495 msgid "``~/.ansible.cfg`` (in the home directory)"
500 msgid "``/usr/local/etc/ansible/ansible.cfg``"
504 msgid "Ansible will process the above list and use the first file found, all others are ignored."
508 msgid "The configuration file is one variant of an INI format. Both the hash sign (``#``) and semic…
512 msgid "Avoiding security risks with ``ansible.cfg`` in the current directory"
516 msgid "If Ansible were to load ``ansible.cfg`` from a world-writable current working directory, it …
520 msgid "If you depend on using Ansible with a config file in the current working directory, the best…
524 msgid "for Vagrant, the `Vagrant documentation <https://www.vagrantup.com/docs/synced-folders/>`_ c…
528 msgid "for WSL, the `WSL docs <https://docs.microsoft.com/en-us/windows/wsl/wsl-config#set-wsl-laun…
532 msgid "If you absolutely depend on storing your Ansible config in a world-writable current working …
536 msgid "Relative paths for configuration"
540 msgid "You can specify a relative path for many configuration options. In most of those cases the p…
544 msgid "Common Options"
548 msgid "This is a copy of the options available from our release, your local install might have extr…
552 msgid "ACTION_WARNINGS"
556 msgid "Description"
560 msgid "By default Ansible will issue a warning when received from a task action (module or action p…
564 msgid "Type"
616 msgid "boolean"
620 msgid "Default"
639 msgid "True"
643 msgid "Version Added"
652 msgid "2.5"
656 msgid "Ini"
660 msgid "Section"
794 msgid "[defaults]"
798 msgid "Key"
802 msgid "action_warnings"
806 msgid "Environment"
810 msgid "Variable"
814 msgid ":envvar:`ANSIBLE_ACTION_WARNINGS`"
818 msgid "AGNOSTIC_BECOME_PROMPT"
823 msgid "Display an agnostic become prompt instead of displaying a prompt containing the command line…
834 msgid "[privilege_escalation]"
838 msgid "agnostic_become_prompt"
842 msgid ":envvar:`ANSIBLE_AGNOSTIC_BECOME_PROMPT`"
846 msgid "ALLOW_WORLD_READABLE_TMPFILES"
850 msgid "This setting has been moved to the individual shell plugins as a plugin option :ref:`shell_p…
894 msgid "False"
898 msgid "Deprecated in"
903 msgid "2.14"
907 msgid "Deprecated detail"
911 msgid "moved to shell plugins"
915 msgid "Deprecated alternatives"
919 msgid "world_readable_tmp"
923 msgid "ANSIBLE_CONNECTION_PATH"
927 msgid "Specify where to look for the ansible-connection script. This location will be checked befor…
941 msgid "path"
961 msgid "None"
977 msgid "2.8"
985 msgid "[persistent_connection]"
989 msgid "ansible_connection_path"
993 msgid ":envvar:`ANSIBLE_CONNECTION_PATH`"
999 msgid "ANSIBLE_COW_ACCEPTLIST"
1005 msgid "White list of cowsay templates that are 'safe' to use, set to empty list if you want to enab…
1029 msgid "list"
1033 msgid "['bud-frogs', 'bunny', 'cheese', 'daemon', 'default', 'dragon', 'elephant-in-snake', 'elepha…
1037 msgid "cow_whitelist"
1049 msgid "2.15"
1061 msgid "normalizing names to new standard"
1066 msgid "cowsay_enabled_stencils"
1081 msgid "2.11"
1085 msgid ":envvar:`ANSIBLE_COW_ACCEPTLIST`"
1089 msgid ":envvar:`ANSIBLE_COW_WHITELIST`"
1093 msgid "ANSIBLE_COW_PATH"
1098 msgid "Specify a custom cowsay path or swap in your cowsay implementation of choice"
1107 msgid "string"
1111 msgid "cowpath"
1115 msgid ":envvar:`ANSIBLE_COW_PATH`"
1119 msgid "ANSIBLE_COW_SELECTION"
1124 msgid "This allows you to chose a specific cowsay stencil for the banners or use 'random' to cycle …
1130 msgid "default"
1134 msgid "cow_selection"
1138 msgid ":envvar:`ANSIBLE_COW_SELECTION`"
1142 msgid "ANSIBLE_FORCE_COLOR"
1147 msgid "This option forces color mode even when running without a TTY or the \"nocolor\" setting is …
1151 msgid "force_color"
1155 msgid ":envvar:`ANSIBLE_FORCE_COLOR`"
1159 msgid "ANSIBLE_NOCOLOR"
1165 msgid "This setting allows suppressing colorizing output, which is used to give a better indication…
1169 msgid "nocolor"
1173 msgid ":envvar:`ANSIBLE_NOCOLOR`"
1177 msgid ":envvar:`NO_COLOR`"
1181 msgid "ANSIBLE_NOCOWS"
1186 msgid "If you have cowsay installed but want to avoid the 'cows' (why????), use this."
1190 msgid "nocows"
1194 msgid ":envvar:`ANSIBLE_NOCOWS`"
1198 msgid "ANSIBLE_PIPELINING"
1202 msgid "Pipelining, if supported by the connection plugin, reduces the number of network operations …
1206 msgid "[connection]"
1211 msgid "pipelining"
1215 msgid ":envvar:`ANSIBLE_PIPELINING`"
1219 msgid "ANY_ERRORS_FATAL"
1224 msgid "Sets the default value for the any_errors_fatal keyword, if True, Task failures will be cons…
1229 msgid "2.4"
1237 msgid "any_errors_fatal"
1241 msgid ":envvar:`ANSIBLE_ANY_ERRORS_FATAL`"
1245 msgid "BECOME_ALLOW_SAME_USER"
1250 msgid "This setting controls if become is skipped when remote user and become user are the same. I.…
1254 msgid "become_allow_same_user"
1258 msgid ":envvar:`ANSIBLE_BECOME_ALLOW_SAME_USER`"
1262 msgid "BECOME_PLUGIN_PATH"
1267 msgid "Colon separated paths in which Ansible will search for Become Plugins."
1290 msgid "pathspec"
1294 msgid "~/.ansible/plugins/become:/usr/local/share/py38-ansible/plugins/become"
1298 msgid "become_plugins"
1302 msgid ":envvar:`ANSIBLE_BECOME_PLUGINS`"
1306 msgid "CACHE_PLUGIN"
1311 msgid "Chooses which cache plugin to use, the default 'memory' is ephemeral."
1315 msgid "memory"
1319 msgid "fact_caching"
1323 msgid ":envvar:`ANSIBLE_CACHE_PLUGIN`"
1327 msgid "CACHE_PLUGIN_CONNECTION"
1332 msgid "Defines connection or path information for the cache plugin"
1336 msgid "fact_caching_connection"
1340 msgid ":envvar:`ANSIBLE_CACHE_PLUGIN_CONNECTION`"
1344 msgid "CACHE_PLUGIN_PREFIX"
1349 msgid "Prefix to use for cache plugin files/tables"
1353 msgid "fact_caching_prefix"
1357 msgid ":envvar:`ANSIBLE_CACHE_PLUGIN_PREFIX`"
1361 msgid "CACHE_PLUGIN_TIMEOUT"
1366 msgid "Expiration timeout for the cache plugin data"
1382 msgid "integer"
1386 msgid "86400"
1390 msgid "fact_caching_timeout"
1394 msgid ":envvar:`ANSIBLE_CACHE_PLUGIN_TIMEOUT`"
1398 msgid "CALLABLE_ACCEPT_LIST"
1404 msgid "Whitelist of callable methods to be made available to template evaluation"
1415 msgid "[]"
1419 msgid "callable_whitelist"
1424 msgid "callable_enabled"
1428 msgid ":envvar:`ANSIBLE_CALLABLE_ENABLED`"
1432 msgid ":envvar:`ANSIBLE_CALLABLE_WHITELIST`"
1437 msgid "ANSIBLE_CALLABLE_ENABLED"
1441 msgid "CALLBACKS_ENABLED"
1447 msgid "List of enabled callbacks, not all callbacks need enabling, but many of those shipped with A…
1451 msgid "callback_whitelist"
1455 msgid "callback_enabled"
1459 msgid "callbacks_enabled"
1463 msgid ":envvar:`ANSIBLE_CALLBACK_WHITELIST`"
1468 msgid "ANSIBLE_CALLBACKS_ENABLED"
1472 msgid ":envvar:`ANSIBLE_CALLBACKS_ENABLED`"
1476 msgid "COLLECTIONS_ON_ANSIBLE_VERSION_MISMATCH"
1481 msgid "When a collection is loaded that does not support the running Ansible version (via the colle…
1487 msgid "warning"
1491 msgid "Choices"
1496 msgid "error"
1500 msgid "ignore"
1504 msgid "collections_on_ansible_version_mismatch"
1508 msgid ":envvar:`ANSIBLE_COLLECTIONS_ON_ANSIBLE_VERSION_MISMATCH`"
1512 msgid "COLLECTIONS_PATHS"
1518 msgid "Colon separated paths in which Ansible will search for collections content. Collections must…
1522 msgid "~/.ansible/collections:/usr/local/share/py38-ansible/collections"
1526 msgid "collections_paths"
1530 msgid "collections_path"
1543 msgid "2.10"
1547 msgid ":envvar:`ANSIBLE_COLLECTIONS_PATH`"
1551 msgid ":envvar:`ANSIBLE_COLLECTIONS_PATHS`"
1555 msgid "COLLECTIONS_SCAN_SYS_PATH"
1560 msgid "A boolean to enable or disable scanning the sys.path for installed collections"
1564 msgid "collections_scan_sys_path"
1568 msgid ":envvar:`ANSIBLE_COLLECTIONS_SCAN_SYS_PATH`"
1572 msgid "COLOR_CHANGED"
1577 msgid "Defines the color to use on 'Changed' task status"
1582 msgid "yellow"
1586 msgid "black"
1590 msgid "bright gray"
1595 msgid "blue"
1601 msgid "white"
1607 msgid "green"
1611 msgid "bright blue"
1617 msgid "cyan"
1621 msgid "bright green"
1627 msgid "red"
1631 msgid "bright cyan"
1636 msgid "purple"
1641 msgid "bright red"
1646 msgid "bright purple"
1651 msgid "dark gray"
1655 msgid "bright yellow"
1659 msgid "magenta"
1663 msgid "bright magenta"
1667 msgid "normal"
1684 msgid "[colors]"
1688 msgid ":envvar:`ANSIBLE_COLOR_CHANGED`"
1692 msgid "COLOR_CONSOLE_PROMPT"
1697 msgid "Defines the default color to use for ansible-console"
1705 msgid "2.7"
1709 msgid "console_prompt"
1713 msgid ":envvar:`ANSIBLE_COLOR_CONSOLE_PROMPT`"
1717 msgid "COLOR_DEBUG"
1722 msgid "Defines the color to use when emitting debug messages"
1727 msgid "debug"
1731 msgid ":envvar:`ANSIBLE_COLOR_DEBUG`"
1735 msgid "COLOR_DEPRECATE"
1740 msgid "Defines the color to use when emitting deprecation messages"
1744 msgid "deprecate"
1748 msgid ":envvar:`ANSIBLE_COLOR_DEPRECATE`"
1752 msgid "COLOR_DIFF_ADD"
1757 msgid "Defines the color to use when showing added lines in diffs"
1761 msgid "diff_add"
1765 msgid ":envvar:`ANSIBLE_COLOR_DIFF_ADD`"
1769 msgid "COLOR_DIFF_LINES"
1774 msgid "Defines the color to use when showing diffs"
1778 msgid "diff_lines"
1782 msgid ":envvar:`ANSIBLE_COLOR_DIFF_LINES`"
1786 msgid "COLOR_DIFF_REMOVE"
1791 msgid "Defines the color to use when showing removed lines in diffs"
1795 msgid "diff_remove"
1799 msgid ":envvar:`ANSIBLE_COLOR_DIFF_REMOVE`"
1803 msgid "COLOR_ERROR"
1808 msgid "Defines the color to use when emitting error messages"
1812 msgid ":envvar:`ANSIBLE_COLOR_ERROR`"
1816 msgid "COLOR_HIGHLIGHT"
1821 msgid "Defines the color to use for highlighting"
1825 msgid "highlight"
1829 msgid ":envvar:`ANSIBLE_COLOR_HIGHLIGHT`"
1833 msgid "COLOR_OK"
1838 msgid "Defines the color to use when showing 'OK' task status"
1842 msgid "ok"
1846 msgid ":envvar:`ANSIBLE_COLOR_OK`"
1850 msgid "COLOR_SKIP"
1855 msgid "Defines the color to use when showing 'Skipped' task status"
1860 msgid "skip"
1864 msgid ":envvar:`ANSIBLE_COLOR_SKIP`"
1868 msgid "COLOR_UNREACHABLE"
1873 msgid "Defines the color to use on 'Unreachable' status"
1877 msgid "unreachable"
1881 msgid ":envvar:`ANSIBLE_COLOR_UNREACHABLE`"
1885 msgid "COLOR_VERBOSE"
1890 msgid "Defines the color to use when emitting verbose messages. i.e those that show with '-v's."
1894 msgid "verbose"
1898 msgid ":envvar:`ANSIBLE_COLOR_VERBOSE`"
1902 msgid "COLOR_WARN"
1907 msgid "Defines the color to use when emitting warning messages"
1914 msgid "warn"
1918 msgid ":envvar:`ANSIBLE_COLOR_WARN`"
1922 msgid "COMMAND_WARNINGS"
1926 msgid "Ansible can issue a warning when the shell or command module is used and the command appears…
1931 msgid "1.8"
1935 msgid "command_warnings"
1939 msgid ":envvar:`ANSIBLE_COMMAND_WARNINGS`"
1943 msgid "the command warnings feature is being removed"
1947 msgid "CONDITIONAL_BARE_VARS"
1951 msgid "With this setting on (True), running conditional evaluation 'var' is treated differently tha…
1955 msgid "conditional_bare_variables"
1959 msgid ":envvar:`ANSIBLE_CONDITIONAL_BARE_VARS`"
1963 msgid "CONNECTION_FACTS_MODULES"
1967 msgid "Which modules to run during a play's fact gathering stage based on connection"
1971 msgid "dict"
1975 msgid "{'asa': 'ansible.legacy.asa_facts', 'cisco.asa.asa': 'cisco.asa.asa_facts', 'eos': 'ansible.…
1979 msgid "CONTROLLER_PYTHON_WARNING"
1984 msgid "Toggle to control showing warnings related to running a Python version older than Python 3.8…
1988 msgid "controller_python_warning"
1992 msgid ":envvar:`ANSIBLE_CONTROLLER_PYTHON_WARNING`"
1996 msgid "COVERAGE_REMOTE_OUTPUT"
2000 msgid "Sets the output directory on the remote host to generate coverage reports to. Currently only…
2006 msgid "str"
2016 msgid "2.9"
2020 msgid ":envvar:`_ANSIBLE_COVERAGE_REMOTE_OUTPUT`"
2026 msgid "Variables"
2034 msgid "name"
2038 msgid "`_ansible_coverage_remote_output`"
2042 msgid "COVERAGE_REMOTE_PATHS"
2046 msgid "A list of paths for files on the Ansible controller to run coverage for when executing on th…
2050 msgid ":envvar:`_ANSIBLE_COVERAGE_REMOTE_PATH_FILTER`"
2054 msgid "DEFAULT_ACTION_PLUGIN_PATH"
2059 msgid "Colon separated paths in which Ansible will search for Action Plugins."
2063 msgid "~/.ansible/plugins/action:/usr/local/share/py38-ansible/plugins/action"
2067 msgid "action_plugins"
2071 msgid ":envvar:`ANSIBLE_ACTION_PLUGINS`"
2075 msgid "DEFAULT_ALLOW_UNSAFE_LOOKUPS"
2079 msgid "When enabled, this option allows lookup plugins (whether used in variables as ``{{lookup('fo…
2083 msgid "2.2.3"
2087 msgid "allow_unsafe_lookups"
2091 msgid "DEFAULT_ASK_PASS"
2096 msgid "This controls whether an Ansible playbook should prompt for a login password. If using SSH k…
2100 msgid "ask_pass"
2104 msgid ":envvar:`ANSIBLE_ASK_PASS`"
2108 msgid "DEFAULT_ASK_VAULT_PASS"
2113 msgid "This controls whether an Ansible playbook should prompt for a vault password."
2117 msgid "ask_vault_pass"
2121 msgid ":envvar:`ANSIBLE_ASK_VAULT_PASS`"
2125 msgid "DEFAULT_BECOME"
2130 msgid "Toggles the use of privilege escalation, allowing you to 'become' another user after login."
2138 msgid "become"
2142 msgid ":envvar:`ANSIBLE_BECOME`"
2146 msgid "DEFAULT_BECOME_ASK_PASS"
2151 msgid "Toggle to prompt for privilege escalation password."
2155 msgid "become_ask_pass"
2159 msgid ":envvar:`ANSIBLE_BECOME_ASK_PASS`"
2163 msgid "DEFAULT_BECOME_EXE"
2168 msgid "executable to use for privilege escalation, otherwise Ansible will depend on PATH"
2176 msgid "become_exe"
2180 msgid ":envvar:`ANSIBLE_BECOME_EXE`"
2184 msgid "DEFAULT_BECOME_FLAGS"
2189 msgid "Flags to pass to the privilege escalation executable."
2197 msgid "become_flags"
2201 msgid ":envvar:`ANSIBLE_BECOME_FLAGS`"
2205 msgid "DEFAULT_BECOME_METHOD"
2210 msgid "Privilege escalation method to use when `become` is enabled."
2214 msgid "sudo"
2222 msgid "become_method"
2226 msgid ":envvar:`ANSIBLE_BECOME_METHOD`"
2230 msgid "DEFAULT_BECOME_USER"
2235 msgid "The user your login/remote user 'becomes' when using privilege escalation, most systems will…
2239 msgid "root"
2247 msgid "become_user"
2251 msgid ":envvar:`ANSIBLE_BECOME_USER`"
2255 msgid "DEFAULT_CACHE_PLUGIN_PATH"
2260 msgid "Colon separated paths in which Ansible will search for Cache Plugins."
2264 msgid "~/.ansible/plugins/cache:/usr/local/share/py38-ansible/plugins/cache"
2268 msgid "cache_plugins"
2272 msgid ":envvar:`ANSIBLE_CACHE_PLUGINS`"
2276 msgid "DEFAULT_CALLBACK_PLUGIN_PATH"
2281 msgid "Colon separated paths in which Ansible will search for Callback Plugins."
2285 msgid "~/.ansible/plugins/callback:/usr/local/share/py38-ansible/plugins/callback"
2289 msgid "callback_plugins"
2293 msgid ":envvar:`ANSIBLE_CALLBACK_PLUGINS`"
2297 msgid "DEFAULT_CLICONF_PLUGIN_PATH"
2302 msgid "Colon separated paths in which Ansible will search for Cliconf Plugins."
2306 msgid "~/.ansible/plugins/cliconf:/usr/local/share/py38-ansible/plugins/cliconf"
2310 msgid "cliconf_plugins"
2314 msgid ":envvar:`ANSIBLE_CLICONF_PLUGINS`"
2318 msgid "DEFAULT_CONNECTION_PLUGIN_PATH"
2323 msgid "Colon separated paths in which Ansible will search for Connection Plugins."
2327 msgid "~/.ansible/plugins/connection:/usr/local/share/py38-ansible/plugins/connection"
2331 msgid "connection_plugins"
2335 msgid ":envvar:`ANSIBLE_CONNECTION_PLUGINS`"
2339 msgid "DEFAULT_DEBUG"
2344 msgid "Toggles debug output in Ansible. This is *very* verbose and can hinder multiprocessing.  Deb…
2348 msgid ":envvar:`ANSIBLE_DEBUG`"
2352 msgid "DEFAULT_EXECUTABLE"
2357 msgid "This indicates the command to use to spawn a shell under for Ansible's execution needs on a …
2361 msgid "/bin/sh"
2365 msgid "executable"
2369 msgid ":envvar:`ANSIBLE_EXECUTABLE`"
2373 msgid "DEFAULT_FACT_PATH"
2377 msgid "This option allows you to globally configure a custom path for 'local_facts' for the implied…
2382 msgid "fact_path"
2386 msgid ":envvar:`ANSIBLE_FACT_PATH`"
2390 msgid "DEFAULT_FILTER_PLUGIN_PATH"
2395 msgid "Colon separated paths in which Ansible will search for Jinja2 Filter Plugins."
2399 msgid "~/.ansible/plugins/filter:/usr/local/share/py38-ansible/plugins/filter"
2403 msgid "filter_plugins"
2407 msgid ":envvar:`ANSIBLE_FILTER_PLUGINS`"
2411 msgid "DEFAULT_FORCE_HANDLERS"
2415 msgid "This option controls if notified handlers run on a host even if a failure occurs on that hos…
2419 msgid "1.9.1"
2424 msgid "force_handlers"
2428 msgid ":envvar:`ANSIBLE_FORCE_HANDLERS`"
2432 msgid "DEFAULT_FORKS"
2437 msgid "Maximum number of forks Ansible will use to execute tasks on target hosts."
2442 msgid "5"
2446 msgid "forks"
2450 msgid ":envvar:`ANSIBLE_FORKS`"
2454 msgid "DEFAULT_GATHER_SUBSET"
2458 msgid "Set the `gather_subset` option for the M(ansible.builtin.setup) task in the implicit fact ga…
2462 msgid "['all']"
2469 msgid "2.1"
2474 msgid "gather_subset"
2478 msgid ":envvar:`ANSIBLE_GATHER_SUBSET`"
2482 msgid "DEFAULT_GATHER_TIMEOUT"
2486 msgid "Set the timeout in seconds for the implicit fact gathering. It does **not** apply to user de…
2491 msgid "10"
2496 msgid "gather_timeout"
2500 msgid ":envvar:`ANSIBLE_GATHER_TIMEOUT`"
2504 msgid "DEFAULT_GATHERING"
2508 msgid "This setting controls the default policy of fact gathering (facts discovered about remote sy…
2513 msgid "implicit"
2518 msgid "smart"
2522 msgid "explicit"
2526 msgid "1.6"
2530 msgid "gathering"
2534 msgid ":envvar:`ANSIBLE_GATHERING`"
2538 msgid "DEFAULT_HANDLER_INCLUDES_STATIC"
2543 msgid "Since 2.0 M(ansible.builtin.include) can be 'dynamic', this setting (if True) forces that if…
2547 msgid "handler_includes_static"
2551 msgid ":envvar:`ANSIBLE_HANDLER_INCLUDES_STATIC`"
2563 msgid "2.12"
2568 msgid "include itself is deprecated and this setting will not matter in the future"
2572 msgid "none as its already built into the decision between include_tasks and import_tasks"
2576 msgid "DEFAULT_HASH_BEHAVIOUR"
2580 msgid "This setting controls how duplicate definitions of dictionary variables (aka hash, map, asso…
2585 msgid "replace"
2589 msgid "Any variable that is defined more than once is overwritten using the order from variable pre…
2593 msgid "merge"
2597 msgid "Any dictionary variable will be recursively merged with new definitions across the different…
2601 msgid "hash_behaviour"
2605 msgid ":envvar:`ANSIBLE_HASH_BEHAVIOUR`"
2609 msgid "DEFAULT_HOST_LIST"
2614 msgid "Comma separated list of Ansible inventory sources"
2618 msgid "pathlist"
2622 msgid "/usr/local/etc/ansible/hosts"
2626 msgid "inventory"
2630 msgid ":envvar:`ANSIBLE_INVENTORY`"
2634 msgid "DEFAULT_HTTPAPI_PLUGIN_PATH"
2639 msgid "Colon separated paths in which Ansible will search for HttpApi Plugins."
2643 msgid "~/.ansible/plugins/httpapi:/usr/local/share/py38-ansible/plugins/httpapi"
2647 msgid "httpapi_plugins"
2651 msgid ":envvar:`ANSIBLE_HTTPAPI_PLUGINS`"
2655 msgid "DEFAULT_INTERNAL_POLL_INTERVAL"
2659 msgid "This sets the interval (in seconds) of Ansible internal processes polling each other. Lower …
2664 msgid "float"
2668 msgid "0.001"
2672 msgid "2.2"
2676 msgid "internal_poll_interval"
2680 msgid "DEFAULT_INVENTORY_PLUGIN_PATH"
2685 msgid "Colon separated paths in which Ansible will search for Inventory Plugins."
2689 msgid "~/.ansible/plugins/inventory:/usr/local/share/py38-ansible/plugins/inventory"
2693 msgid "inventory_plugins"
2697 msgid ":envvar:`ANSIBLE_INVENTORY_PLUGINS`"
2701 msgid "DEFAULT_JINJA2_EXTENSIONS"
2705 msgid "This is a developer-specific feature that allows enabling additional Jinja2 extensions. See …
2709 msgid "jinja2_extensions"
2713 msgid ":envvar:`ANSIBLE_JINJA2_EXTENSIONS`"
2717 msgid "DEFAULT_JINJA2_NATIVE"
2722 msgid "This option preserves variable types during template operations. This requires Jinja2 >= 2.1…
2726 msgid "jinja2_native"
2730 msgid ":envvar:`ANSIBLE_JINJA2_NATIVE`"
2734 msgid "DEFAULT_KEEP_REMOTE_FILES"
2738 msgid "Enables/disables the cleaning up of the temporary files Ansible used to execute the tasks on…
2742 msgid "keep_remote_files"
2746 msgid ":envvar:`ANSIBLE_KEEP_REMOTE_FILES`"
2750 msgid "DEFAULT_LIBVIRT_LXC_NOSECLABEL"
2756 msgid "This setting causes libvirt to connect to lxc containers by passing --noseclabel to virsh. T…
2761 msgid "[selinux]"
2765 msgid "libvirt_lxc_noseclabel"
2769 msgid ":envvar:`ANSIBLE_LIBVIRT_LXC_NOSECLABEL`"
2773 msgid ":envvar:`LIBVIRT_LXC_NOSECLABEL`"
2782 msgid "environment variables without ``ANSIBLE_`` prefix are deprecated"
2787 msgid "the ``ANSIBLE_LIBVIRT_LXC_NOSECLABEL`` environment variable"
2791 msgid "DEFAULT_LOAD_CALLBACK_PLUGINS"
2796 msgid "Controls whether callback plugins are loaded when running /usr/bin/ansible. This may be used…
2800 msgid "bin_ansible_callbacks"
2804 msgid ":envvar:`ANSIBLE_LOAD_CALLBACK_PLUGINS`"
2808 msgid "DEFAULT_LOCAL_TMP"
2813 msgid "Temporary directory for Ansible to use on the controller."
2817 msgid "tmppath"
2821 msgid "~/.ansible/tmp"
2825 msgid "local_tmp"
2829 msgid ":envvar:`ANSIBLE_LOCAL_TEMP`"
2833 msgid "DEFAULT_LOG_FILTER"
2838 msgid "List of logger names to filter out of the log file"
2842 msgid "log_filter"
2846 msgid ":envvar:`ANSIBLE_LOG_FILTER`"
2850 msgid "DEFAULT_LOG_PATH"
2855 msgid "File to which Ansible will log on the controller. When empty logging is disabled."
2859 msgid "log_path"
2863 msgid ":envvar:`ANSIBLE_LOG_PATH`"
2867 msgid "DEFAULT_LOOKUP_PLUGIN_PATH"
2872 msgid "Colon separated paths in which Ansible will search for Lookup Plugins."
2876 msgid "~/.ansible/plugins/lookup:/usr/local/share/py38-ansible/plugins/lookup"
2880 msgid "lookup_plugins"
2884 msgid ":envvar:`ANSIBLE_LOOKUP_PLUGINS`"
2888 msgid "DEFAULT_MANAGED_STR"
2892 msgid "Sets the macro for the 'ansible_managed' variable available for M(ansible.builtin.template) …
2896 msgid "Ansible managed"
2900 msgid "ansible_managed"
2904 msgid "DEFAULT_MODULE_ARGS"
2909 msgid "This sets the default arguments to pass to the ``ansible`` adhoc binary if no ``-a`` is spec…
2913 msgid "module_args"
2917 msgid ":envvar:`ANSIBLE_MODULE_ARGS`"
2921 msgid "DEFAULT_MODULE_COMPRESSION"
2925 msgid "Compression scheme to use when transferring Python modules to the target."
2929 msgid "ZIP_DEFLATED"
2933 msgid "module_compression"
2937 msgid "DEFAULT_MODULE_NAME"
2941 msgid "Module to use with the ``ansible`` AdHoc command, if none is specified via ``-m``."
2945 msgid "command"
2949 msgid "module_name"
2953 msgid "DEFAULT_MODULE_PATH"
2958 msgid "Colon separated paths in which Ansible will search for Modules."
2962 msgid "~/.ansible/plugins/modules:/usr/local/share/py38-ansible/plugins/modules"
2966 msgid "library"
2970 msgid ":envvar:`ANSIBLE_LIBRARY`"
2974 msgid "DEFAULT_MODULE_UTILS_PATH"
2979 msgid "Colon separated paths in which Ansible will search for Module utils files, which are shared …
2983 msgid "~/.ansible/plugins/module_utils:/usr/local/share/py38-ansible/plugins/module_utils"
2987 msgid "module_utils"
2991 msgid ":envvar:`ANSIBLE_MODULE_UTILS`"
2995 msgid "DEFAULT_NETCONF_PLUGIN_PATH"
3000 msgid "Colon separated paths in which Ansible will search for Netconf Plugins."
3004 msgid "~/.ansible/plugins/netconf:/usr/local/share/py38-ansible/plugins/netconf"
3008 msgid "netconf_plugins"
3012 msgid ":envvar:`ANSIBLE_NETCONF_PLUGINS`"
3016 msgid "DEFAULT_NO_LOG"
3021 msgid "Toggle Ansible's display and logging of task details, mainly used to avoid security disclosu…
3029 msgid "no_log"
3033 msgid ":envvar:`ANSIBLE_NO_LOG`"
3037 msgid "DEFAULT_NO_TARGET_SYSLOG"
3042 msgid "Toggle Ansible logging to syslog on the target when it executes tasks. On Windows hosts this…
3046 msgid "no_target_syslog"
3050 msgid ":envvar:`ANSIBLE_NO_TARGET_SYSLOG`"
3054 msgid "`ansible_no_target_syslog` :Version Added: 2.10"
3058 msgid "DEFAULT_NULL_REPRESENTATION"
3063 msgid "What templating should return as a 'null' value. When not set it will let Jinja2 decide."
3067 msgid "none"
3071 msgid "null_representation"
3075 msgid ":envvar:`ANSIBLE_NULL_REPRESENTATION`"
3079 msgid "DEFAULT_POLL_INTERVAL"
3084 msgid "For asynchronous tasks in Ansible (covered in Asynchronous Actions and Polling), this is how…
3089 msgid "15"
3093 msgid "poll_interval"
3097 msgid ":envvar:`ANSIBLE_POLL_INTERVAL`"
3101 msgid "DEFAULT_PRIVATE_KEY_FILE"
3106 msgid "Option for connections using a certificate or key file to authenticate, rather than an agent…
3110 msgid "private_key_file"
3114 msgid ":envvar:`ANSIBLE_PRIVATE_KEY_FILE`"
3118 msgid "DEFAULT_PRIVATE_ROLE_VARS"
3122 msgid "Makes role variables inaccessible from other roles. This was introduced as a way to reset ro…
3126 msgid "private_role_vars"
3130 msgid ":envvar:`ANSIBLE_PRIVATE_ROLE_VARS`"
3134 msgid "DEFAULT_REMOTE_PORT"
3139 msgid "Port to use in remote connections, when blank it will use the connection plugin default."
3143 msgid "remote_port"
3147 msgid ":envvar:`ANSIBLE_REMOTE_PORT`"
3151 msgid "DEFAULT_REMOTE_USER"
3155 msgid "Sets the login user for the target machines When blank it uses the connection plugin's defau…
3163 msgid "remote_user"
3167 msgid ":envvar:`ANSIBLE_REMOTE_USER`"
3171 msgid "DEFAULT_ROLES_PATH"
3176 msgid "Colon separated paths in which Ansible will search for Roles."
3180 msgid "~/.ansible/roles:/usr/local/share/py38-ansible/roles:/usr/local/etc/ansible/roles"
3184 msgid "roles_path"
3188 msgid ":envvar:`ANSIBLE_ROLES_PATH`"
3192 msgid "DEFAULT_SELINUX_SPECIAL_FS"
3196 msgid "Some filesystems do not support safe operations and/or return inconsistent errors, this sett…
3200 msgid "fuse, nfs, vboxsf, ramfs, 9p, vfat"
3204 msgid "special_context_filesystems"
3208 msgid ":envvar:`ANSIBLE_SELINUX_SPECIAL_FS` :Version Added: 2.9"
3212 msgid "DEFAULT_STDOUT_CALLBACK"
3216 msgid "Set the main callback used to display Ansible output, you can only have one at a time. You c…
3220 msgid "stdout_callback"
3224 msgid ":envvar:`ANSIBLE_STDOUT_CALLBACK`"
3228 msgid "DEFAULT_STRATEGY"
3233 msgid "Set the default strategy used for plays."
3237 msgid "linear"
3241 msgid "2.3"
3246 msgid "strategy"
3250 msgid ":envvar:`ANSIBLE_STRATEGY`"
3254 msgid "DEFAULT_STRATEGY_PLUGIN_PATH"
3259 msgid "Colon separated paths in which Ansible will search for Strategy Plugins."
3263 msgid "~/.ansible/plugins/strategy:/usr/local/share/py38-ansible/plugins/strategy"
3267 msgid "strategy_plugins"
3271 msgid ":envvar:`ANSIBLE_STRATEGY_PLUGINS`"
3275 msgid "DEFAULT_SU"
3280 msgid "Toggle the use of \"su\" for tasks."
3284 msgid "su"
3288 msgid ":envvar:`ANSIBLE_SU`"
3292 msgid "DEFAULT_SYSLOG_FACILITY"
3297 msgid "Syslog facility to use when Ansible logs to the remote target"
3301 msgid "LOG_USER"
3305 msgid "syslog_facility"
3309 msgid ":envvar:`ANSIBLE_SYSLOG_FACILITY`"
3313 msgid "DEFAULT_TASK_INCLUDES_STATIC"
3318 msgid "The `include` tasks can be static or dynamic, this toggles the default expected behaviour if…
3322 msgid "task_includes_static"
3326 msgid ":envvar:`ANSIBLE_TASK_INCLUDES_STATIC`"
3330 msgid "None, as its already built into the decision between include_tasks and import_tasks"
3334 msgid "DEFAULT_TERMINAL_PLUGIN_PATH"
3339 msgid "Colon separated paths in which Ansible will search for Terminal Plugins."
3343 msgid "~/.ansible/plugins/terminal:/usr/local/share/py38-ansible/plugins/terminal"
3347 msgid "terminal_plugins"
3351 msgid ":envvar:`ANSIBLE_TERMINAL_PLUGINS`"
3355 msgid "DEFAULT_TEST_PLUGIN_PATH"
3360 msgid "Colon separated paths in which Ansible will search for Jinja2 Test Plugins."
3364 msgid "~/.ansible/plugins/test:/usr/local/share/py38-ansible/plugins/test"
3368 msgid "test_plugins"
3372 msgid ":envvar:`ANSIBLE_TEST_PLUGINS`"
3376 msgid "DEFAULT_TIMEOUT"
3381 msgid "This is the default timeout for connection plugins to use."
3389 msgid "timeout"
3393 msgid ":envvar:`ANSIBLE_TIMEOUT`"
3397 msgid "DEFAULT_TRANSPORT"
3402 msgid "Default connection plugin to use, the 'smart' option will toggle between 'ssh' and 'paramiko…
3406 msgid "transport"
3410 msgid ":envvar:`ANSIBLE_TRANSPORT`"
3414 msgid "DEFAULT_UNDEFINED_VAR_BEHAVIOR"
3418 msgid "When True, this causes ansible templating to fail steps that reference variable names that a…
3422 msgid "1.3"
3426 msgid "error_on_undefined_vars"
3430 msgid ":envvar:`ANSIBLE_ERROR_ON_UNDEFINED_VARS`"
3434 msgid "DEFAULT_VARS_PLUGIN_PATH"
3439 msgid "Colon separated paths in which Ansible will search for Vars Plugins."
3443 msgid "~/.ansible/plugins/vars:/usr/local/share/py38-ansible/plugins/vars"
3447 msgid "vars_plugins"
3451 msgid ":envvar:`ANSIBLE_VARS_PLUGINS`"
3455 msgid "DEFAULT_VAULT_ENCRYPT_IDENTITY"
3460 msgid "The vault_id to use for encrypting by default. If multiple vault_ids are provided, this spec…
3464 msgid "vault_encrypt_identity"
3468 msgid ":envvar:`ANSIBLE_VAULT_ENCRYPT_IDENTITY`"
3472 msgid "DEFAULT_VAULT_ID_MATCH"
3477 msgid "If true, decrypting vaults with a vault id will only try the password from the matching vaul…
3481 msgid "vault_id_match"
3485 msgid ":envvar:`ANSIBLE_VAULT_ID_MATCH`"
3489 msgid "DEFAULT_VAULT_IDENTITY"
3494 msgid "The label to use for the default vault id label in cases where a vault id label is not provi…
3498 msgid "vault_identity"
3502 msgid ":envvar:`ANSIBLE_VAULT_IDENTITY`"
3506 msgid "DEFAULT_VAULT_IDENTITY_LIST"
3511 msgid "A list of vault-ids to use by default. Equivalent to multiple --vault-id args. Vault-ids are…
3515 msgid "vault_identity_list"
3519 msgid ":envvar:`ANSIBLE_VAULT_IDENTITY_LIST`"
3523 msgid "DEFAULT_VAULT_PASSWORD_FILE"
3528 msgid "The vault password file to use. Equivalent to --vault-password-file or --vault-id"
3532 msgid "vault_password_file"
3536 msgid ":envvar:`ANSIBLE_VAULT_PASSWORD_FILE`"
3540 msgid "DEFAULT_VERBOSITY"
3545 msgid "Sets the default verbosity, equivalent to the number of ``-v`` passed in the command line."
3552 msgid "0"
3556 msgid "verbosity"
3560 msgid ":envvar:`ANSIBLE_VERBOSITY`"
3564 msgid "DEPRECATION_WARNINGS"
3569 msgid "Toggle to control the showing of deprecation warnings"
3573 msgid "deprecation_warnings"
3577 msgid ":envvar:`ANSIBLE_DEPRECATION_WARNINGS`"
3581 msgid "DEVEL_WARNING"
3586 msgid "Toggle to control showing warnings related to running devel"
3590 msgid "devel_warning"
3594 msgid ":envvar:`ANSIBLE_DEVEL_WARNING`"
3598 msgid "DIFF_ALWAYS"
3603 msgid "Configuration toggle to tell modules to show differences when in 'changed' status, equivalen…
3614 msgid "bool"
3619 msgid "[diff]"
3625 msgid "always"
3629 msgid ":envvar:`ANSIBLE_DIFF_ALWAYS`"
3633 msgid "DIFF_CONTEXT"
3638 msgid "How many lines of context to show when displaying the differences between files."
3642 msgid "3"
3646 msgid "context"
3650 msgid ":envvar:`ANSIBLE_DIFF_CONTEXT`"
3654 msgid "DISPLAY_ARGS_TO_STDOUT"
3658 msgid "Normally ``ansible-playbook`` will print a header for each task that is run. These headers w…
3662 msgid "display_args_to_stdout"
3666 msgid ":envvar:`ANSIBLE_DISPLAY_ARGS_TO_STDOUT`"
3670 msgid "DISPLAY_SKIPPED_HOSTS"
3676 msgid "Toggle to control displaying skipped task/host entries in a task in the default callback"
3680 msgid "display_skipped_hosts"
3684 msgid ":envvar:`ANSIBLE_DISPLAY_SKIPPED_HOSTS`"
3688 msgid ":envvar:`DISPLAY_SKIPPED_HOSTS`"
3693 msgid "the ``ANSIBLE_DISPLAY_SKIPPED_HOSTS`` environment variable"
3697 msgid "DOC_FRAGMENT_PLUGIN_PATH"
3702 msgid "Colon separated paths in which Ansible will search for Documentation Fragments Plugins."
3706 msgid "~/.ansible/plugins/doc_fragments:/usr/local/share/py38-ansible/plugins/doc_fragments"
3710 msgid "doc_fragment_plugins"
3714 msgid ":envvar:`ANSIBLE_DOC_FRAGMENT_PLUGINS`"
3718 msgid "DOCSITE_ROOT_URL"
3722 msgid "Root docsite URL used to generate docs URLs in warning/error text; must be an absolute URL w…
3726 msgid "https://docs.ansible.com/ansible/"
3730 msgid "docsite_root_url"
3734 msgid "DUPLICATE_YAML_DICT_KEY"
3738 msgid "By default Ansible will issue a warning when a duplicate dict key is encountered in YAML. Th…
3742 msgid "duplicate_dict_key"
3746 msgid ":envvar:`ANSIBLE_DUPLICATE_YAML_DICT_KEY`"
3750 msgid "ENABLE_TASK_DEBUGGER"
3754 msgid "Whether or not to enable the task debugger, this previously was done as a strategy plugin. N…
3758 msgid "enable_task_debugger"
3762 msgid ":envvar:`ANSIBLE_ENABLE_TASK_DEBUGGER`"
3766 msgid "ERROR_ON_MISSING_HANDLER"
3771 msgid "Toggle to allow missing handlers to become a warning instead of an error when notifying."
3775 msgid "error_on_missing_handler"
3779 msgid ":envvar:`ANSIBLE_ERROR_ON_MISSING_HANDLER`"
3783 msgid "FACTS_MODULES"
3788 msgid "Which modules to run during a play's fact gathering stage, using the default of 'smart' will…
3792 msgid "['smart']"
3796 msgid "facts_modules"
3800 msgid ":envvar:`ANSIBLE_FACTS_MODULES`"
3804 msgid "`ansible_facts_modules`"
3808 msgid "GALAXY_CACHE_DIR"
3812 msgid "The directory that stores cached responses from a Galaxy server. This is only used by the ``…
3816 msgid "~/.ansible/galaxy_cache"
3827 msgid "[galaxy]"
3831 msgid "cache_dir"
3835 msgid ":envvar:`ANSIBLE_GALAXY_CACHE_DIR`"
3839 msgid "GALAXY_DISPLAY_PROGRESS"
3843 msgid "Some steps in ``ansible-galaxy`` display a progress wheel which can cause issues on certain …
3847 msgid "display_progress"
3851 msgid ":envvar:`ANSIBLE_GALAXY_DISPLAY_PROGRESS`"
3855 msgid "GALAXY_IGNORE_CERTS"
3860 msgid "If set to yes, ansible-galaxy will not validate TLS certificates. This can be useful for tes…
3864 msgid "ignore_certs"
3868 msgid ":envvar:`ANSIBLE_GALAXY_IGNORE`"
3872 msgid "GALAXY_ROLE_SKELETON"
3877 msgid "Role or collection skeleton directory to use as a template for the ``init`` action in ``ansi…
3881 msgid "role_skeleton"
3885 msgid ":envvar:`ANSIBLE_GALAXY_ROLE_SKELETON`"
3889 msgid "GALAXY_ROLE_SKELETON_IGNORE"
3894 msgid "patterns of files to ignore inside a Galaxy role or collection skeleton directory"
3898 msgid "['^.git$', '^.*/.git_keep$']"
3902 msgid "role_skeleton_ignore"
3906 msgid ":envvar:`ANSIBLE_GALAXY_ROLE_SKELETON_IGNORE`"
3910 msgid "GALAXY_SERVER"
3915 msgid "URL to prepend when roles don't specify the full URI, assume they are referencing this serve…
3919 msgid "https://galaxy.ansible.com"
3923 msgid "server"
3927 msgid ":envvar:`ANSIBLE_GALAXY_SERVER`"
3931 msgid "GALAXY_SERVER_LIST"
3935 msgid "A list of Galaxy servers to use when installing a collection. The value corresponds to the c…
3939 msgid "server_list"
3943 msgid ":envvar:`ANSIBLE_GALAXY_SERVER_LIST`"
3947 msgid "GALAXY_TOKEN_PATH"
3952 msgid "Local path to galaxy access token file"
3956 msgid "~/.ansible/galaxy_token"
3960 msgid "token_path"
3964 msgid ":envvar:`ANSIBLE_GALAXY_TOKEN_PATH`"
3968 msgid "HOST_KEY_CHECKING"
3973 msgid "Set this to \"False\" if you want to avoid host key checking by the underlying tools Ansible…
3977 msgid "host_key_checking"
3981 msgid ":envvar:`ANSIBLE_HOST_KEY_CHECKING`"
3985 msgid "HOST_PATTERN_MISMATCH"
3990 msgid "This setting changes the behaviour of mismatched host patterns, it allows you to force a fat…
4005 msgid "[inventory]"
4009 msgid "host_pattern_mismatch"
4013 msgid ":envvar:`ANSIBLE_HOST_PATTERN_MISMATCH`"
4017 msgid "INJECT_FACTS_AS_VARS"
4021 msgid "Facts are available inside the `ansible_facts` variable, this setting also pushes them as th…
4025 msgid "inject_facts_as_vars"
4029 msgid ":envvar:`ANSIBLE_INJECT_FACT_VARS`"
4033 msgid "INTERPRETER_PYTHON"
4038 msgid "Path to the Python interpreter to be used for module execution on remote targets, or an auto…
4043 msgid "auto_legacy"
4047 msgid "interpreter_python"
4051 msgid ":envvar:`ANSIBLE_PYTHON_INTERPRETER`"
4055 msgid "`ansible_python_interpreter`"
4059 msgid "INTERPRETER_PYTHON_DISTRO_MAP"
4063 msgid "{'centos': {'6': '/usr/bin/python', '8': '/usr/libexec/platform-python'}, 'debian': {'8': '/…
4067 msgid "INTERPRETER_PYTHON_FALLBACK"
4071 msgid "['/usr/bin/python', 'python3.9', 'python3.8', 'python3.7', 'python3.6', 'python3.5', 'python…
4075 msgid "INVALID_TASK_ATTRIBUTE_FAILED"
4080 msgid "If 'false', invalid attributes for a task will result in warnings instead of errors"
4084 msgid "invalid_task_attribute_failed"
4088 msgid ":envvar:`ANSIBLE_INVALID_TASK_ATTRIBUTE_FAILED`"
4092 msgid "INVENTORY_ANY_UNPARSED_IS_FAILED"
4097 msgid "If 'true', it is a fatal error when any given inventory source cannot be successfully parsed…
4101 msgid "any_unparsed_is_failed"
4105 msgid ":envvar:`ANSIBLE_INVENTORY_ANY_UNPARSED_IS_FAILED`"
4109 msgid "INVENTORY_CACHE_ENABLED"
4114 msgid "Toggle to turn on inventory caching"
4118 msgid "cache"
4122 msgid ":envvar:`ANSIBLE_INVENTORY_CACHE`"
4126 msgid "INVENTORY_CACHE_PLUGIN"
4131 msgid "The plugin for caching inventory. If INVENTORY_CACHE_PLUGIN is not provided CACHE_PLUGIN can…
4135 msgid "cache_plugin"
4139 msgid ":envvar:`ANSIBLE_INVENTORY_CACHE_PLUGIN`"
4143 msgid "INVENTORY_CACHE_PLUGIN_CONNECTION"
4148 msgid "The inventory cache connection. If INVENTORY_CACHE_PLUGIN_CONNECTION is not provided CACHE_P…
4152 msgid "cache_connection"
4156 msgid ":envvar:`ANSIBLE_INVENTORY_CACHE_CONNECTION`"
4160 msgid "INVENTORY_CACHE_PLUGIN_PREFIX"
4165 msgid "The table prefix for the cache plugin. If INVENTORY_CACHE_PLUGIN_PREFIX is not provided CACH…
4169 msgid "cache_prefix"
4173 msgid ":envvar:`ANSIBLE_INVENTORY_CACHE_PLUGIN_PREFIX`"
4177 msgid "INVENTORY_CACHE_TIMEOUT"
4182 msgid "Expiration timeout for the inventory cache plugin data. If INVENTORY_CACHE_TIMEOUT is not pr…
4186 msgid "3600"
4190 msgid "cache_timeout"
4194 msgid ":envvar:`ANSIBLE_INVENTORY_CACHE_TIMEOUT`"
4198 msgid "INVENTORY_ENABLED"
4203 msgid "List of enabled inventory plugins, it also determines the order in which they are used."
4207 msgid "['host_list', 'script', 'auto', 'yaml', 'ini', 'toml']"
4211 msgid "enable_plugins"
4215 msgid ":envvar:`ANSIBLE_INVENTORY_ENABLED`"
4219 msgid "INVENTORY_EXPORT"
4224 msgid "Controls if ansible-inventory will accurately reflect Ansible's view into inventory or its o…
4228 msgid "export"
4232 msgid ":envvar:`ANSIBLE_INVENTORY_EXPORT`"
4236 msgid "INVENTORY_IGNORE_EXTS"
4241 msgid "List of extensions to ignore when using a directory as an inventory source"
4245 msgid "{{(REJECT_EXTS + ('.orig', '.ini', '.cfg', '.retry'))}}"
4249 msgid "inventory_ignore_extensions"
4253 msgid "ignore_extensions"
4257 msgid ":envvar:`ANSIBLE_INVENTORY_IGNORE`"
4261 msgid "INVENTORY_IGNORE_PATTERNS"
4266 msgid "List of patterns to ignore when using a directory as an inventory source"
4270 msgid "inventory_ignore_patterns"
4274 msgid "ignore_patterns"
4278 msgid ":envvar:`ANSIBLE_INVENTORY_IGNORE_REGEX`"
4282 msgid "INVENTORY_UNPARSED_IS_FAILED"
4287 msgid "If 'true' it is a fatal error if every single potential inventory source fails to parse, oth…
4291 msgid "unparsed_is_failed"
4295 msgid ":envvar:`ANSIBLE_INVENTORY_UNPARSED_FAILED`"
4299 msgid "LOCALHOST_WARNING"
4303 msgid "By default Ansible will issue a warning when there are no hosts in the inventory. These warn…
4307 msgid "2.6"
4311 msgid "localhost_warning"
4315 msgid ":envvar:`ANSIBLE_LOCALHOST_WARNING`"
4319 msgid "MAX_FILE_SIZE_FOR_DIFF"
4324 msgid "Maximum size of files to be considered for diff display"
4329 msgid "int"
4333 msgid "104448"
4337 msgid "max_diff_size"
4341 msgid ":envvar:`ANSIBLE_MAX_DIFF_SIZE`"
4345 msgid "MODULE_IGNORE_EXTS"
4349 msgid "List of extensions to ignore when looking for modules to load This is for rejecting script a…
4353 msgid "{{(REJECT_EXTS + ('.yaml', '.yml', '.ini'))}}"
4357 msgid "module_ignore_exts"
4361 msgid ":envvar:`ANSIBLE_MODULE_IGNORE_EXTS`"
4365 msgid "NETCONF_SSH_CONFIG"
4370 msgid "This variable is used to enable bastion/jump host with netconf connection. If set to True th…
4374 msgid "[netconf_connection]"
4378 msgid "ssh_config"
4382 msgid ":envvar:`ANSIBLE_NETCONF_SSH_CONFIG`"
4386 msgid "NETWORK_GROUP_MODULES"
4390 msgid "['eos', 'nxos', 'ios', 'iosxr', 'junos', 'enos', 'ce', 'vyos', 'sros', 'dellos9', 'dellos10'…
4394 msgid "network_group_modules"
4398 msgid ":envvar:`ANSIBLE_NETWORK_GROUP_MODULES`"
4402 msgid ":envvar:`NETWORK_GROUP_MODULES`"
4407 msgid "the ``ANSIBLE_NETWORK_GROUP_MODULES`` environment variable"
4411 msgid "OLD_PLUGIN_CACHE_CLEARING"
4416 msgid "Previouslly Ansible would only clear some of the plugin loading caches when loading new role…
4420 msgid "old_plugin_cache_clear"
4424 msgid ":envvar:`ANSIBLE_OLD_PLUGIN_CACHE_CLEAR`"
4428 msgid "PARAMIKO_HOST_KEY_AUTO_ADD"
4433 msgid "[paramiko_connection]"
4437 msgid "host_key_auto_add"
4441 msgid ":envvar:`ANSIBLE_PARAMIKO_HOST_KEY_AUTO_ADD`"
4445 msgid "PARAMIKO_LOOK_FOR_KEYS"
4449 msgid "look_for_keys"
4453 msgid ":envvar:`ANSIBLE_PARAMIKO_LOOK_FOR_KEYS`"
4457 msgid "PERSISTENT_COMMAND_TIMEOUT"
4462 msgid "This controls the amount of time to wait for response from remote device before timing out p…
4467 msgid "30"
4471 msgid "command_timeout"
4475 msgid ":envvar:`ANSIBLE_PERSISTENT_COMMAND_TIMEOUT`"
4479 msgid "PERSISTENT_CONNECT_RETRY_TIMEOUT"
4484 msgid "This controls the retry timeout for persistent connection to connect to the local domain soc…
4488 msgid "connect_retry_timeout"
4492 msgid ":envvar:`ANSIBLE_PERSISTENT_CONNECT_RETRY_TIMEOUT`"
4496 msgid "PERSISTENT_CONNECT_TIMEOUT"
4501 msgid "This controls how long the persistent connection will remain idle before it is destroyed."
4505 msgid "connect_timeout"
4509 msgid ":envvar:`ANSIBLE_PERSISTENT_CONNECT_TIMEOUT`"
4513 msgid "PERSISTENT_CONTROL_PATH_DIR"
4518 msgid "Path to socket to be used by the connection persistence system."
4522 msgid "~/.ansible/pc"
4526 msgid "control_path_dir"
4530 msgid ":envvar:`ANSIBLE_PERSISTENT_CONTROL_PATH_DIR`"
4534 msgid "PLAYBOOK_DIR"
4539 msgid "A number of non-playbook CLIs have a ``--playbook-dir`` argument; this sets the default valu…
4544 msgid "playbook_dir"
4548 msgid ":envvar:`ANSIBLE_PLAYBOOK_DIR`"
4552 msgid "PLAYBOOK_VARS_ROOT"
4556 msgid "This sets which playbook dirs will be used as a root to process vars plugins, which includes…
4561 msgid "top"
4565 msgid "bottom"
4569 msgid "all"
4573 msgid "2.4.1"
4577 msgid "playbook_vars_root"
4581 msgid ":envvar:`ANSIBLE_PLAYBOOK_VARS_ROOT`"
4585 msgid "PLUGIN_FILTERS_CFG"
4589 msgid "A path to configuration for filtering which plugins installed on the system are allowed to b…
4593 msgid "2.5.0"
4597 msgid "[default]"
4602 msgid "plugin_filters_cfg"
4606 msgid "specifying \"plugin_filters_cfg\" under the \"default\" section is deprecated"
4610 msgid "the \"defaults\" section instead"
4614 msgid "PYTHON_MODULE_RLIMIT_NOFILE"
4619 msgid "Attempts to set RLIMIT_NOFILE soft limit to the specified value when executing Python module…
4623 msgid "python_module_rlimit_nofile"
4627 msgid ":envvar:`ANSIBLE_PYTHON_MODULE_RLIMIT_NOFILE`"
4631 msgid "`ansible_python_module_rlimit_nofile`"
4635 msgid "RETRY_FILES_ENABLED"
4640 msgid "This controls whether a failed Ansible playbook should create a .retry file."
4644 msgid "retry_files_enabled"
4648 msgid ":envvar:`ANSIBLE_RETRY_FILES_ENABLED`"
4652 msgid "RETRY_FILES_SAVE_PATH"
4656 msgid "This sets the path in which Ansible will save .retry files when a playbook fails and retry f…
4660 msgid "retry_files_save_path"
4664 msgid ":envvar:`ANSIBLE_RETRY_FILES_SAVE_PATH`"
4668 msgid "RUN_VARS_PLUGINS"
4672 msgid "This setting can be used to optimize vars_plugin usage depending on user's inventory size an…
4677 msgid "demand"
4681 msgid "start"
4685 msgid "run_vars_plugins"
4689 msgid ":envvar:`ANSIBLE_RUN_VARS_PLUGINS`"
4693 msgid "SHOW_CUSTOM_STATS"
4698 msgid "This adds the custom stats set via the set_stats plugin to the default output"
4702 msgid "show_custom_stats"
4706 msgid ":envvar:`ANSIBLE_SHOW_CUSTOM_STATS`"
4710 msgid "STRING_CONVERSION_ACTION"
4714 msgid "Action to take when a module parameter value is converted to a string (this does not affect …
4718 msgid "string_conversion_action"
4722 msgid ":envvar:`ANSIBLE_STRING_CONVERSION_ACTION`"
4726 msgid "STRING_TYPE_FILTERS"
4730 msgid "This list of filters avoids 'type conversion' when templating variables Useful when you want…
4734 msgid "['string', 'to_json', 'to_nice_json', 'to_yaml', 'to_nice_yaml', 'ppretty', 'json']"
4738 msgid "[jinja2]"
4742 msgid "dont_type_filters"
4746 msgid ":envvar:`ANSIBLE_STRING_TYPE_FILTERS`"
4750 msgid "SYSTEM_WARNINGS"
4754 msgid "Allows disabling of warnings related to potential issues on the system running ansible itsel…
4758 msgid "system_warnings"
4762 msgid ":envvar:`ANSIBLE_SYSTEM_WARNINGS`"
4766 msgid "TAGS_RUN"
4771 msgid "default list of tags to run in your plays, Skip Tags has precedence."
4776 msgid "[tags]"
4780 msgid "run"
4784 msgid ":envvar:`ANSIBLE_RUN_TAGS`"
4788 msgid "TAGS_SKIP"
4793 msgid "default list of tags to skip in your plays, has precedence over Run Tags"
4797 msgid ":envvar:`ANSIBLE_SKIP_TAGS`"
4801 msgid "TASK_DEBUGGER_IGNORE_ERRORS"
4805 msgid "This option defines whether the task debugger will be invoked on a failed task when ignore_e…
4809 msgid "task_debugger_ignore_errors"
4813 msgid ":envvar:`ANSIBLE_TASK_DEBUGGER_IGNORE_ERRORS`"
4817 msgid "TASK_TIMEOUT"
4821 msgid "Set the maximum time (in seconds) that a task can run for. If set to 0 (the default) there i…
4825 msgid "task_timeout"
4829 msgid ":envvar:`ANSIBLE_TASK_TIMEOUT`"
4833 msgid "TRANSFORM_INVALID_GROUP_CHARS"
4837 msgid "Make ansible transform invalid characters in group names supplied by inventory sources. If '…
4842 msgid "never"
4846 msgid "silently"
4850 msgid "force_valid_group_names"
4854 msgid ":envvar:`ANSIBLE_TRANSFORM_INVALID_GROUP_CHARS`"
4858 msgid "USE_PERSISTENT_CONNECTIONS"
4863 msgid "Toggles the use of persistence for connections."
4867 msgid "use_persistent_connections"
4871 msgid ":envvar:`ANSIBLE_USE_PERSISTENT_CONNECTIONS`"
4875 msgid "VARIABLE_PLUGINS_ENABLED"
4880 msgid "Whitelist for variable plugins that require it."
4884 msgid "['host_group_vars']"
4888 msgid "vars_plugins_enabled"
4892 msgid ":envvar:`ANSIBLE_VARS_ENABLED`"
4896 msgid "VARIABLE_PRECEDENCE"
4901 msgid "Allows to change the group variable precedence merge order."
4905 msgid "['all_inventory', 'groups_inventory', 'all_plugins_inventory', 'all_plugins_play', 'groups_p…
4909 msgid "precedence"
4913 msgid ":envvar:`ANSIBLE_PRECEDENCE`"
4917 msgid "VERBOSE_TO_STDERR"
4922 msgid "Force 'verbose' option to use stderr instead of stdout"
4926 msgid "verbose_to_stderr"
4930 msgid ":envvar:`ANSIBLE_VERBOSE_TO_STDERR`"
4934 msgid "WIN_ASYNC_STARTUP_TIMEOUT"
4938 msgid "For asynchronous tasks in Ansible (covered in Asynchronous Actions and Polling), this is how…
4942 msgid "win_async_startup_timeout"
4946 msgid ":envvar:`ANSIBLE_WIN_ASYNC_STARTUP_TIMEOUT`"
4950 msgid "`ansible_win_async_startup_timeout`"
4954 msgid "WORKER_SHUTDOWN_POLL_COUNT"
4958 msgid "The maximum number of times to check Task Queue Manager worker processes to verify they have…
4962 msgid ":envvar:`ANSIBLE_WORKER_SHUTDOWN_POLL_COUNT`"
4966 msgid "WORKER_SHUTDOWN_POLL_DELAY"
4970 msgid "The number of seconds to sleep between polling loops when checking Task Queue Manager worker…
4974 msgid "0.1"
4978 msgid ":envvar:`ANSIBLE_WORKER_SHUTDOWN_POLL_DELAY`"
4982 msgid "YAML_FILENAME_EXTENSIONS"
4986 msgid "Check all of these extensions when looking for 'variable' files which should be YAML or JSON…
4990 msgid "['.yml', '.yaml', '.json']"
4994 msgid "yaml_valid_extensions"
4998 msgid ":envvar:`ANSIBLE_YAML_FILENAME_EXT`"
5002 msgid "Environment Variables"
5006 msgid "Override the default ansible config file"
5010 msgid "Specify where to look for the ansible-connection script. This location will be checked befor…
5014 msgid "See also :ref:`ANSIBLE_CONNECTION_PATH <ANSIBLE_CONNECTION_PATH>`"
5018 msgid "See also :ref:`ANSIBLE_COW_SELECTION <ANSIBLE_COW_SELECTION>`"
5023 msgid "See also :ref:`ANSIBLE_COW_ACCEPTLIST <ANSIBLE_COW_ACCEPTLIST>`"
5027 msgid "See also :ref:`ANSIBLE_FORCE_COLOR <ANSIBLE_FORCE_COLOR>`"
5032 msgid "See also :ref:`ANSIBLE_NOCOLOR <ANSIBLE_NOCOLOR>`"
5036 msgid "See also :ref:`ANSIBLE_NOCOWS <ANSIBLE_NOCOWS>`"
5040 msgid "See also :ref:`ANSIBLE_COW_PATH <ANSIBLE_COW_PATH>`"
5044 msgid "Pipelining, if supported by the connection plugin, reduces the number of network operations …
5048 msgid "See also :ref:`ANSIBLE_PIPELINING <ANSIBLE_PIPELINING>`"
5052 msgid "See also :ref:`ANY_ERRORS_FATAL <ANY_ERRORS_FATAL>`"
5056 msgid "See also :ref:`BECOME_ALLOW_SAME_USER <BECOME_ALLOW_SAME_USER>`"
5060 msgid "See also :ref:`AGNOSTIC_BECOME_PROMPT <AGNOSTIC_BECOME_PROMPT>`"
5064 msgid "See also :ref:`CACHE_PLUGIN <CACHE_PLUGIN>`"
5068 msgid "See also :ref:`CACHE_PLUGIN_CONNECTION <CACHE_PLUGIN_CONNECTION>`"
5072 msgid "See also :ref:`CACHE_PLUGIN_PREFIX <CACHE_PLUGIN_PREFIX>`"
5076 msgid "See also :ref:`CACHE_PLUGIN_TIMEOUT <CACHE_PLUGIN_TIMEOUT>`"
5080 msgid "See also :ref:`COLLECTIONS_SCAN_SYS_PATH <COLLECTIONS_SCAN_SYS_PATH>`"
5085 msgid "See also :ref:`COLLECTIONS_PATHS <COLLECTIONS_PATHS>`"
5089 msgid "See also :ref:`COLLECTIONS_ON_ANSIBLE_VERSION_MISMATCH <COLLECTIONS_ON_ANSIBLE_VERSION_MISMA…
5093 msgid "See also :ref:`COLOR_CHANGED <COLOR_CHANGED>`"
5097 msgid "See also :ref:`COLOR_CONSOLE_PROMPT <COLOR_CONSOLE_PROMPT>`"
5101 msgid "See also :ref:`COLOR_DEBUG <COLOR_DEBUG>`"
5105 msgid "See also :ref:`COLOR_DEPRECATE <COLOR_DEPRECATE>`"
5109 msgid "See also :ref:`COLOR_DIFF_ADD <COLOR_DIFF_ADD>`"
5113 msgid "See also :ref:`COLOR_DIFF_LINES <COLOR_DIFF_LINES>`"
5117 msgid "See also :ref:`COLOR_DIFF_REMOVE <COLOR_DIFF_REMOVE>`"
5121 msgid "See also :ref:`COLOR_ERROR <COLOR_ERROR>`"
5125 msgid "See also :ref:`COLOR_HIGHLIGHT <COLOR_HIGHLIGHT>`"
5129 msgid "See also :ref:`COLOR_OK <COLOR_OK>`"
5133 msgid "See also :ref:`COLOR_SKIP <COLOR_SKIP>`"
5137 msgid "See also :ref:`COLOR_UNREACHABLE <COLOR_UNREACHABLE>`"
5141 msgid "See also :ref:`COLOR_VERBOSE <COLOR_VERBOSE>`"
5145 msgid "See also :ref:`COLOR_WARN <COLOR_WARN>`"
5149 msgid "With this setting on (True), running conditional evaluation 'var' is treated differently tha…
5153 msgid "See also :ref:`CONDITIONAL_BARE_VARS <CONDITIONAL_BARE_VARS>`"
5157 msgid "Sets the output directory on the remote host to generate coverage reports to.Currently only …
5161 msgid "See also :ref:`COVERAGE_REMOTE_OUTPUT <COVERAGE_REMOTE_OUTPUT>`"
5165 msgid "A list of paths for files on the Ansible controller to run coverage for when executing on th…
5169 msgid "See also :ref:`COVERAGE_REMOTE_PATHS <COVERAGE_REMOTE_PATHS>`"
5173 msgid "By default Ansible will issue a warning when received from a task action (module or action p…
5177 msgid "See also :ref:`ACTION_WARNINGS <ACTION_WARNINGS>`"
5181 msgid "Ansible can issue a warning when the shell or command module is used and the command appears…
5185 msgid "See also :ref:`COMMAND_WARNINGS <COMMAND_WARNINGS>`"
5189 msgid "By default Ansible will issue a warning when there are no hosts in the inventory.These warni…
5193 msgid "See also :ref:`LOCALHOST_WARNING <LOCALHOST_WARNING>`"
5197 msgid "See also :ref:`DOC_FRAGMENT_PLUGIN_PATH <DOC_FRAGMENT_PLUGIN_PATH>`"
5201 msgid "See also :ref:`DEFAULT_ACTION_PLUGIN_PATH <DEFAULT_ACTION_PLUGIN_PATH>`"
5205 msgid "See also :ref:`DEFAULT_ASK_PASS <DEFAULT_ASK_PASS>`"
5209 msgid "See also :ref:`DEFAULT_ASK_VAULT_PASS <DEFAULT_ASK_VAULT_PASS>`"
5213 msgid "See also :ref:`DEFAULT_BECOME <DEFAULT_BECOME>`"
5217 msgid "See also :ref:`DEFAULT_BECOME_ASK_PASS <DEFAULT_BECOME_ASK_PASS>`"
5221 msgid "See also :ref:`DEFAULT_BECOME_METHOD <DEFAULT_BECOME_METHOD>`"
5225 msgid "See also :ref:`DEFAULT_BECOME_EXE <DEFAULT_BECOME_EXE>`"
5229 msgid "See also :ref:`DEFAULT_BECOME_FLAGS <DEFAULT_BECOME_FLAGS>`"
5233 msgid "See also :ref:`BECOME_PLUGIN_PATH <BECOME_PLUGIN_PATH>`"
5237 msgid "See also :ref:`DEFAULT_BECOME_USER <DEFAULT_BECOME_USER>`"
5241 msgid "See also :ref:`DEFAULT_CACHE_PLUGIN_PATH <DEFAULT_CACHE_PLUGIN_PATH>`"
5246 msgid "See also :ref:`CALLABLE_ACCEPT_LIST <CALLABLE_ACCEPT_LIST>`"
5250 msgid "See also :ref:`CONTROLLER_PYTHON_WARNING <CONTROLLER_PYTHON_WARNING>`"
5254 msgid "See also :ref:`DEFAULT_CALLBACK_PLUGIN_PATH <DEFAULT_CALLBACK_PLUGIN_PATH>`"
5259 msgid "See also :ref:`CALLBACKS_ENABLED <CALLBACKS_ENABLED>`"
5263 msgid "See also :ref:`DEFAULT_CLICONF_PLUGIN_PATH <DEFAULT_CLICONF_PLUGIN_PATH>`"
5267 msgid "See also :ref:`DEFAULT_CONNECTION_PLUGIN_PATH <DEFAULT_CONNECTION_PLUGIN_PATH>`"
5271 msgid "See also :ref:`DEFAULT_DEBUG <DEFAULT_DEBUG>`"
5275 msgid "See also :ref:`DEFAULT_EXECUTABLE <DEFAULT_EXECUTABLE>`"
5279 msgid "This option allows you to globally configure a custom path for 'local_facts' for the implied…
5283 msgid "See also :ref:`DEFAULT_FACT_PATH <DEFAULT_FACT_PATH>`"
5287 msgid "See also :ref:`DEFAULT_FILTER_PLUGIN_PATH <DEFAULT_FILTER_PLUGIN_PATH>`"
5291 msgid "This option controls if notified handlers run on a host even if a failure occurs on that hos…
5295 msgid "See also :ref:`DEFAULT_FORCE_HANDLERS <DEFAULT_FORCE_HANDLERS>`"
5299 msgid "See also :ref:`DEFAULT_FORKS <DEFAULT_FORKS>`"
5303 msgid "This setting controls the default policy of fact gathering (facts discovered about remote sy…
5307 msgid "See also :ref:`DEFAULT_GATHERING <DEFAULT_GATHERING>`"
5311 msgid "Set the `gather_subset` option for the M(ansible.builtin.setup) task in the implicit fact ga…
5315 msgid "See also :ref:`DEFAULT_GATHER_SUBSET <DEFAULT_GATHER_SUBSET>`"
5319 msgid "Set the timeout in seconds for the implicit fact gathering.It does **not** apply to user def…
5323 msgid "See also :ref:`DEFAULT_GATHER_TIMEOUT <DEFAULT_GATHER_TIMEOUT>`"
5327 msgid "See also :ref:`DEFAULT_HANDLER_INCLUDES_STATIC <DEFAULT_HANDLER_INCLUDES_STATIC>`"
5331 msgid "This setting controls how duplicate definitions of dictionary variables (aka hash, map, asso…
5335 msgid "See also :ref:`DEFAULT_HASH_BEHAVIOUR <DEFAULT_HASH_BEHAVIOUR>`"
5339 msgid "See also :ref:`DEFAULT_HOST_LIST <DEFAULT_HOST_LIST>`"
5343 msgid "See also :ref:`DEFAULT_HTTPAPI_PLUGIN_PATH <DEFAULT_HTTPAPI_PLUGIN_PATH>`"
5347 msgid "See also :ref:`DEFAULT_INVENTORY_PLUGIN_PATH <DEFAULT_INVENTORY_PLUGIN_PATH>`"
5351 msgid "This is a developer-specific feature that allows enabling additional Jinja2 extensions.See t…
5355 msgid "See also :ref:`DEFAULT_JINJA2_EXTENSIONS <DEFAULT_JINJA2_EXTENSIONS>`"
5359 msgid "See also :ref:`DEFAULT_JINJA2_NATIVE <DEFAULT_JINJA2_NATIVE>`"
5363 msgid "Enables/disables the cleaning up of the temporary files Ansible used to execute the tasks on…
5367 msgid "See also :ref:`DEFAULT_KEEP_REMOTE_FILES <DEFAULT_KEEP_REMOTE_FILES>`"
5372 msgid "See also :ref:`DEFAULT_LIBVIRT_LXC_NOSECLABEL <DEFAULT_LIBVIRT_LXC_NOSECLABEL>`"
5376 msgid "See also :ref:`DEFAULT_LOAD_CALLBACK_PLUGINS <DEFAULT_LOAD_CALLBACK_PLUGINS>`"
5380 msgid "See also :ref:`DEFAULT_LOCAL_TMP <DEFAULT_LOCAL_TMP>`"
5384 msgid "See also :ref:`DEFAULT_LOG_PATH <DEFAULT_LOG_PATH>`"
5388 msgid "See also :ref:`DEFAULT_LOG_FILTER <DEFAULT_LOG_FILTER>`"
5392 msgid "See also :ref:`DEFAULT_LOOKUP_PLUGIN_PATH <DEFAULT_LOOKUP_PLUGIN_PATH>`"
5396 msgid "See also :ref:`DEFAULT_MODULE_ARGS <DEFAULT_MODULE_ARGS>`"
5400 msgid "See also :ref:`DEFAULT_MODULE_PATH <DEFAULT_MODULE_PATH>`"
5404 msgid "See also :ref:`DEFAULT_MODULE_UTILS_PATH <DEFAULT_MODULE_UTILS_PATH>`"
5408 msgid "See also :ref:`DEFAULT_NETCONF_PLUGIN_PATH <DEFAULT_NETCONF_PLUGIN_PATH>`"
5412 msgid "See also :ref:`DEFAULT_NO_LOG <DEFAULT_NO_LOG>`"
5416 msgid "See also :ref:`DEFAULT_NO_TARGET_SYSLOG <DEFAULT_NO_TARGET_SYSLOG>`"
5420 msgid "See also :ref:`DEFAULT_NULL_REPRESENTATION <DEFAULT_NULL_REPRESENTATION>`"
5424 msgid "See also :ref:`DEFAULT_POLL_INTERVAL <DEFAULT_POLL_INTERVAL>`"
5428 msgid "See also :ref:`DEFAULT_PRIVATE_KEY_FILE <DEFAULT_PRIVATE_KEY_FILE>`"
5432 msgid "Makes role variables inaccessible from other roles.This was introduced as a way to reset rol…
5436 msgid "See also :ref:`DEFAULT_PRIVATE_ROLE_VARS <DEFAULT_PRIVATE_ROLE_VARS>`"
5440 msgid "See also :ref:`DEFAULT_REMOTE_PORT <DEFAULT_REMOTE_PORT>`"
5444 msgid "Sets the login user for the target machinesWhen blank it uses the connection plugin's defaul…
5448 msgid "See also :ref:`DEFAULT_REMOTE_USER <DEFAULT_REMOTE_USER>`"
5452 msgid "See also :ref:`DEFAULT_ROLES_PATH <DEFAULT_ROLES_PATH>`"
5456 msgid "Some filesystems do not support safe operations and/or return inconsistent errors, this sett…
5460 msgid "See also :ref:`DEFAULT_SELINUX_SPECIAL_FS <DEFAULT_SELINUX_SPECIAL_FS>`"
5464 msgid "Set the main callback used to display Ansible output, you can only have one at a time.You ca…
5468 msgid "See also :ref:`DEFAULT_STDOUT_CALLBACK <DEFAULT_STDOUT_CALLBACK>`"
5472 msgid "Whether or not to enable the task debugger, this previously was done as a strategy plugin.No…
5476 msgid "See also :ref:`ENABLE_TASK_DEBUGGER <ENABLE_TASK_DEBUGGER>`"
5480 msgid "This option defines whether the task debugger will be invoked on a failed task when ignore_e…
5484 msgid "See also :ref:`TASK_DEBUGGER_IGNORE_ERRORS <TASK_DEBUGGER_IGNORE_ERRORS>`"
5488 msgid "See also :ref:`DEFAULT_STRATEGY <DEFAULT_STRATEGY>`"
5492 msgid "See also :ref:`DEFAULT_STRATEGY_PLUGIN_PATH <DEFAULT_STRATEGY_PLUGIN_PATH>`"
5496 msgid "See also :ref:`DEFAULT_SU <DEFAULT_SU>`"
5500 msgid "See also :ref:`DEFAULT_SYSLOG_FACILITY <DEFAULT_SYSLOG_FACILITY>`"
5504 msgid "See also :ref:`DEFAULT_TASK_INCLUDES_STATIC <DEFAULT_TASK_INCLUDES_STATIC>`"
5508 msgid "See also :ref:`DEFAULT_TERMINAL_PLUGIN_PATH <DEFAULT_TERMINAL_PLUGIN_PATH>`"
5512 msgid "See also :ref:`DEFAULT_TEST_PLUGIN_PATH <DEFAULT_TEST_PLUGIN_PATH>`"
5516 msgid "See also :ref:`DEFAULT_TIMEOUT <DEFAULT_TIMEOUT>`"
5520 msgid "See also :ref:`DEFAULT_TRANSPORT <DEFAULT_TRANSPORT>`"
5524 msgid "When True, this causes ansible templating to fail steps that reference variable names that a…
5528 msgid "See also :ref:`DEFAULT_UNDEFINED_VAR_BEHAVIOR <DEFAULT_UNDEFINED_VAR_BEHAVIOR>`"
5532 msgid "See also :ref:`DEFAULT_VARS_PLUGIN_PATH <DEFAULT_VARS_PLUGIN_PATH>`"
5536 msgid "See also :ref:`DEFAULT_VAULT_ID_MATCH <DEFAULT_VAULT_ID_MATCH>`"
5540 msgid "See also :ref:`DEFAULT_VAULT_IDENTITY <DEFAULT_VAULT_IDENTITY>`"
5544 msgid "See also :ref:`DEFAULT_VAULT_ENCRYPT_IDENTITY <DEFAULT_VAULT_ENCRYPT_IDENTITY>`"
5548 msgid "See also :ref:`DEFAULT_VAULT_IDENTITY_LIST <DEFAULT_VAULT_IDENTITY_LIST>`"
5552 msgid "See also :ref:`DEFAULT_VAULT_PASSWORD_FILE <DEFAULT_VAULT_PASSWORD_FILE>`"
5556 msgid "See also :ref:`DEFAULT_VERBOSITY <DEFAULT_VERBOSITY>`"
5560 msgid "See also :ref:`DEPRECATION_WARNINGS <DEPRECATION_WARNINGS>`"
5564 msgid "See also :ref:`DEVEL_WARNING <DEVEL_WARNING>`"
5568 msgid "See also :ref:`DIFF_ALWAYS <DIFF_ALWAYS>`"
5572 msgid "See also :ref:`DIFF_CONTEXT <DIFF_CONTEXT>`"
5576 msgid "Normally ``ansible-playbook`` will print a header for each task that is run. These headers w…
5580 msgid "See also :ref:`DISPLAY_ARGS_TO_STDOUT <DISPLAY_ARGS_TO_STDOUT>`"
5585 msgid "See also :ref:`DISPLAY_SKIPPED_HOSTS <DISPLAY_SKIPPED_HOSTS>`"
5589 msgid "By default Ansible will issue a warning when a duplicate dict key is encountered in YAML.The…
5593 msgid "See also :ref:`DUPLICATE_YAML_DICT_KEY <DUPLICATE_YAML_DICT_KEY>`"
5597 msgid "See also :ref:`ERROR_ON_MISSING_HANDLER <ERROR_ON_MISSING_HANDLER>`"
5601 msgid "See also :ref:`FACTS_MODULES <FACTS_MODULES>`"
5605 msgid "See also :ref:`GALAXY_IGNORE_CERTS <GALAXY_IGNORE_CERTS>`"
5609 msgid "See also :ref:`GALAXY_ROLE_SKELETON <GALAXY_ROLE_SKELETON>`"
5613 msgid "See also :ref:`GALAXY_ROLE_SKELETON_IGNORE <GALAXY_ROLE_SKELETON_IGNORE>`"
5617 msgid "See also :ref:`GALAXY_SERVER <GALAXY_SERVER>`"
5621 msgid "A list of Galaxy servers to use when installing a collection.The value corresponds to the co…
5625 msgid "See also :ref:`GALAXY_SERVER_LIST <GALAXY_SERVER_LIST>`"
5629 msgid "See also :ref:`GALAXY_TOKEN_PATH <GALAXY_TOKEN_PATH>`"
5633 msgid "Some steps in ``ansible-galaxy`` display a progress wheel which can cause issues on certain …
5637 msgid "See also :ref:`GALAXY_DISPLAY_PROGRESS <GALAXY_DISPLAY_PROGRESS>`"
5641 msgid "The directory that stores cached responses from a Galaxy server.This is only used by the ``a…
5645 msgid "See also :ref:`GALAXY_CACHE_DIR <GALAXY_CACHE_DIR>`"
5649 msgid "See also :ref:`HOST_KEY_CHECKING <HOST_KEY_CHECKING>`"
5653 msgid "See also :ref:`HOST_PATTERN_MISMATCH <HOST_PATTERN_MISMATCH>`"
5657 msgid "See also :ref:`INTERPRETER_PYTHON <INTERPRETER_PYTHON>`"
5661 msgid "Make ansible transform invalid characters in group names supplied by inventory sources.If 'n…
5665 msgid "See also :ref:`TRANSFORM_INVALID_GROUP_CHARS <TRANSFORM_INVALID_GROUP_CHARS>`"
5669 msgid "See also :ref:`INVALID_TASK_ATTRIBUTE_FAILED <INVALID_TASK_ATTRIBUTE_FAILED>`"
5673 msgid "See also :ref:`INVENTORY_ANY_UNPARSED_IS_FAILED <INVENTORY_ANY_UNPARSED_IS_FAILED>`"
5677 msgid "See also :ref:`INVENTORY_CACHE_ENABLED <INVENTORY_CACHE_ENABLED>`"
5681 msgid "See also :ref:`INVENTORY_CACHE_PLUGIN <INVENTORY_CACHE_PLUGIN>`"
5685 msgid "See also :ref:`INVENTORY_CACHE_PLUGIN_CONNECTION <INVENTORY_CACHE_PLUGIN_CONNECTION>`"
5689 msgid "See also :ref:`INVENTORY_CACHE_PLUGIN_PREFIX <INVENTORY_CACHE_PLUGIN_PREFIX>`"
5693 msgid "See also :ref:`INVENTORY_CACHE_TIMEOUT <INVENTORY_CACHE_TIMEOUT>`"
5697 msgid "See also :ref:`INVENTORY_ENABLED <INVENTORY_ENABLED>`"
5701 msgid "See also :ref:`INVENTORY_EXPORT <INVENTORY_EXPORT>`"
5705 msgid "See also :ref:`INVENTORY_IGNORE_EXTS <INVENTORY_IGNORE_EXTS>`"
5709 msgid "See also :ref:`INVENTORY_IGNORE_PATTERNS <INVENTORY_IGNORE_PATTERNS>`"
5713 msgid "See also :ref:`INVENTORY_UNPARSED_IS_FAILED <INVENTORY_UNPARSED_IS_FAILED>`"
5717 msgid "See also :ref:`MAX_FILE_SIZE_FOR_DIFF <MAX_FILE_SIZE_FOR_DIFF>`"
5722 msgid "See also :ref:`NETWORK_GROUP_MODULES <NETWORK_GROUP_MODULES>`"
5726 msgid "Facts are available inside the `ansible_facts` variable, this setting also pushes them as th…
5730 msgid "See also :ref:`INJECT_FACTS_AS_VARS <INJECT_FACTS_AS_VARS>`"
5734 msgid "List of extensions to ignore when looking for modules to loadThis is for rejecting script an…
5738 msgid "See also :ref:`MODULE_IGNORE_EXTS <MODULE_IGNORE_EXTS>`"
5742 msgid "See also :ref:`OLD_PLUGIN_CACHE_CLEARING <OLD_PLUGIN_CACHE_CLEARING>`"
5746 msgid "See also :ref:`PARAMIKO_HOST_KEY_AUTO_ADD <PARAMIKO_HOST_KEY_AUTO_ADD>`"
5750 msgid "See also :ref:`PARAMIKO_LOOK_FOR_KEYS <PARAMIKO_LOOK_FOR_KEYS>`"
5754 msgid "See also :ref:`PERSISTENT_CONTROL_PATH_DIR <PERSISTENT_CONTROL_PATH_DIR>`"
5758 msgid "See also :ref:`PERSISTENT_CONNECT_TIMEOUT <PERSISTENT_CONNECT_TIMEOUT>`"
5762 msgid "See also :ref:`PERSISTENT_CONNECT_RETRY_TIMEOUT <PERSISTENT_CONNECT_RETRY_TIMEOUT>`"
5766 msgid "See also :ref:`PERSISTENT_COMMAND_TIMEOUT <PERSISTENT_COMMAND_TIMEOUT>`"
5770 msgid "See also :ref:`PLAYBOOK_DIR <PLAYBOOK_DIR>`"
5774 msgid "This sets which playbook dirs will be used as a root to process vars plugins, which includes…
5778 msgid "See also :ref:`PLAYBOOK_VARS_ROOT <PLAYBOOK_VARS_ROOT>`"
5782 msgid "See also :ref:`PYTHON_MODULE_RLIMIT_NOFILE <PYTHON_MODULE_RLIMIT_NOFILE>`"
5786 msgid "See also :ref:`RETRY_FILES_ENABLED <RETRY_FILES_ENABLED>`"
5790 msgid "This sets the path in which Ansible will save .retry files when a playbook fails and retry f…
5794 msgid "See also :ref:`RETRY_FILES_SAVE_PATH <RETRY_FILES_SAVE_PATH>`"
5798 msgid "This setting can be used to optimize vars_plugin usage depending on user's inventory size an…
5802 msgid "See also :ref:`RUN_VARS_PLUGINS <RUN_VARS_PLUGINS>`"
5806 msgid "See also :ref:`SHOW_CUSTOM_STATS <SHOW_CUSTOM_STATS>`"
5810 msgid "This list of filters avoids 'type conversion' when templating variablesUseful when you want …
5814 msgid "See also :ref:`STRING_TYPE_FILTERS <STRING_TYPE_FILTERS>`"
5818 msgid "Allows disabling of warnings related to potential issues on the system running ansible itsel…
5822 msgid "See also :ref:`SYSTEM_WARNINGS <SYSTEM_WARNINGS>`"
5826 msgid "See also :ref:`TAGS_RUN <TAGS_RUN>`"
5830 msgid "See also :ref:`TAGS_SKIP <TAGS_SKIP>`"
5834 msgid "Set the maximum time (in seconds) that a task can run for.If set to 0 (the default) there is…
5838 msgid "See also :ref:`TASK_TIMEOUT <TASK_TIMEOUT>`"
5842 msgid "The maximum number of times to check Task Queue Manager worker processes to verify they have…
5846 msgid "See also :ref:`WORKER_SHUTDOWN_POLL_COUNT <WORKER_SHUTDOWN_POLL_COUNT>`"
5850 msgid "The number of seconds to sleep between polling loops when checking Task Queue Manager worker…
5854 msgid "See also :ref:`WORKER_SHUTDOWN_POLL_DELAY <WORKER_SHUTDOWN_POLL_DELAY>`"
5858 msgid "See also :ref:`USE_PERSISTENT_CONNECTIONS <USE_PERSISTENT_CONNECTIONS>`"
5862 msgid "See also :ref:`VARIABLE_PLUGINS_ENABLED <VARIABLE_PLUGINS_ENABLED>`"
5866 msgid "See also :ref:`VARIABLE_PRECEDENCE <VARIABLE_PRECEDENCE>`"
5870 msgid "For asynchronous tasks in Ansible (covered in Asynchronous Actions and Polling), this is how…
5874 msgid "See also :ref:`WIN_ASYNC_STARTUP_TIMEOUT <WIN_ASYNC_STARTUP_TIMEOUT>`"
5878 msgid "Check all of these extensions when looking for 'variable' files which should be YAML or JSON…
5882 msgid "See also :ref:`YAML_FILENAME_EXTENSIONS <YAML_FILENAME_EXTENSIONS>`"
5886 msgid "See also :ref:`NETCONF_SSH_CONFIG <NETCONF_SSH_CONFIG>`"
5890 msgid "Action to take when a module parameter value is converted to a string (this does not affect …
5894 msgid "See also :ref:`STRING_CONVERSION_ACTION <STRING_CONVERSION_ACTION>`"
5898 msgid "See also :ref:`VERBOSE_TO_STDERR <VERBOSE_TO_STDERR>`"
5902 msgid "Frequently Asked Questions"
5906 msgid "Here are some commonly asked questions and their answers."
5910 msgid "Where did all the modules go?"
5914 msgid "In July, 2019, we announced that collections would be the `future of Ansible content deliver…
5918 msgid "To learn more about using collections, see :ref:`collections`."
5922 msgid "To learn more about developing collections, see :ref:`developing_collections`."
5926 msgid "To learn more about contributing to existing collections, see the individual collection repo…
5930 msgid "Where did this specific module go?"
5934 msgid "IF you are searching for a specific module, you can check the `runtime.yml <https://github.c…
5938 msgid "How can I set the PATH or any other environment variable for a task or entire play?"
5942 msgid "Setting environment variables can be done with the `environment` keyword. It can be used at …
5946 msgid "starting in 2.0.1 the setup task from ``gather_facts`` also inherits the environment directi…
5950 msgid "How do I handle different machines needing different user accounts or ports to log in with?"
5954 msgid "Setting inventory variables in the inventory file is the easiest way."
5958 msgid "For instance, suppose these hosts have different usernames and ports:"
5962 msgid "You can also dictate the connection type to be used, if you want:"
5966 msgid "You may also wish to keep these in group variables instead, or file them in a group_vars/<gr…
5970 msgid "How do I get ansible to reuse connections, enable Kerberized SSH, or have Ansible pay attent…
5974 msgid "Switch your default connection type in the configuration file to ``ssh``, or use ``-c ssh`` …
5978 msgid "Paramiko is great for starting out, but the OpenSSH type offers many advanced options. You w…
5982 msgid "We keep paramiko as the default as if you are first installing Ansible on these enterprise o…
5986 msgid "How do I configure a jump host to access servers that I have no direct access to?"
5990 msgid "You can set a ``ProxyCommand`` in the ``ansible_ssh_common_args`` inventory variable. Any ar…
5994 msgid "You can create `group_vars/gatewayed.yml` with the following contents::"
5998 msgid "Ansible will append these arguments to the command line when trying to connect to any hosts …
6002 msgid "Note that ``ssh -W`` is available only with OpenSSH 5.4 or later. With older versions, it's …
6006 msgid "With earlier versions of Ansible, it was necessary to configure a suitable ``ProxyCommand`` …
6010 msgid "How do I get Ansible to notice a dead target in a timely manner?"
6014 msgid "You can add ``-o ServerAliveInterval=NumberOfSeconds`` in ``ssh_args`` from ``ansible.cfg``.…
6018 msgid "How do I speed up run of ansible for servers from cloud providers (EC2, openstack,.. )?"
6022 msgid "Don't try to manage a fleet of machines of a cloud provider from your laptop. Rather connect…
6026 msgid "How do I handle not having a Python interpreter at /usr/bin/python on a remote machine?"
6030 msgid "While you can write Ansible modules in any language, most Ansible modules are written in Pyt…
6034 msgid "By default, Ansible assumes it can find a :command:`/usr/bin/python` on your remote system t…
6038 msgid "Setting the inventory variable ``ansible_python_interpreter`` on any host will tell Ansible …
6042 msgid "Some platforms may only have Python 3 installed by default. If it is not installed as :comma…
6046 msgid "Do not replace the shebang lines of your python modules. Ansible will do this for you automa…
6050 msgid "Also, this works for ANY interpreter, for example ruby: ``ansible_ruby_interpreter``, perl: …
6054 msgid "Keep in mind that if you put ``env`` in your module shebang line (``#!/usr/bin/env <other>``…
6058 msgid "How do I handle the package dependencies required by Ansible package dependencies during Ans…
6062 msgid "While installing Ansible, sometimes you may encounter errors such as `No package 'libffi' fo…
6066 msgid "In order to solve these kinds of dependency issues, you might need to install required packa…
6070 msgid "Refer to the documentation of the respective package for such dependencies and their install…
6074 msgid "Common Platform Issues"
6078 msgid "What customer platforms does Red Hat support?"
6082 msgid "A number of them! For a definitive list please see this `Knowledge Base article <https://acc…
6086 msgid "Running in a virtualenv"
6090 msgid "You can install Ansible into a virtualenv on the controller quite simply:"
6094 msgid "If you want to run under Python 3 instead of Python 2 you may want to change that slightly:"
6098 msgid "If you need to use any libraries which are not available via pip (for instance, SELinux Pyth…
6102 msgid "When you create the virtualenv, specify ``--system-site-packages`` to make use of any librar…
6106 msgid "Copy those files in manually from the system. For instance, for SELinux bindings you might d…
6110 msgid "Running on BSD"
6114 msgid ":ref:`working_with_bsd`"
6118 msgid "Running on Solaris"
6122 msgid "By default, Solaris 10 and earlier run a non-POSIX shell which does not correctly expand the…
6126 msgid "You can set ``remote_tmp`` to a path that will expand correctly with the shell you are using…
6130 msgid "In Ansible 2.5 and later, you can also set it per-host in inventory like this::"
6134 msgid "You can set :ref:`ansible_shell_executable<ansible_shell_executable>` to the path to a POSIX…
6138 msgid "(bash, ksh, and zsh should also be POSIX compatible if you have any of those installed)."
6142 msgid "Running on z/OS"
6146 msgid "There are a few common errors that one might run into when trying to execute Ansible on z/OS…
6150 msgid "Version 2.7.6 of python for z/OS will not work with Ansible because it represents strings in…
6154 msgid "To get around this limitation, download and install a later version of `python for z/OS <htt…
6158 msgid "When ``pipelining = False`` in `/usr/local/etc/ansible/ansible.cfg` then Ansible modules are…
6162 msgid "SyntaxError: Non-UTF-8 code starting with \\'\\\\x83\\' in file /a/user1/.ansible/tmp/ansibl…
6166 msgid "To fix it set ``pipelining = True`` in `/usr/local/etc/ansible/ansible.cfg`."
6170 msgid "Python interpret cannot be found in default location ``/usr/bin/python`` on target host."
6174 msgid "/usr/bin/python: EDC5129I No such file or directory"
6178 msgid "To fix this set the path to the python installation in your inventory like so::"
6182 msgid "Start of python fails with ``The module libpython2.7.so was not found.``"
6186 msgid "EE3501S The module libpython2.7.so was not found."
6190 msgid "On z/OS, you must execute python from gnu bash. If gnu bash is installed at ``/usr/lpp/bash`…
6194 msgid "Running under fakeroot"
6198 msgid "Some issues arise as ``fakeroot`` does not create a full nor POSIX compliant system by defau…
6202 msgid "For example, in the ansible config file (or via environment variable) you can set::"
6206 msgid "What is the best way to make content reusable/redistributable?"
6210 msgid "If you have not done so already, read all about \"Roles\" in the playbooks documentation. Th…
6214 msgid "If some of these plugin types look strange to you, see the API documentation for more detail…
6218 msgid "Where does the configuration file live and what can I configure in it?"
6222 msgid "See :ref:`intro_configuration`."
6226 msgid "How do I disable cowsay?"
6230 msgid "If cowsay is installed, Ansible takes it upon itself to make your day happier when running p…
6234 msgid "How do I see a list of all of the ansible\\_ variables?"
6238 msgid "Ansible by default gathers \"facts\" about the machines under management, and these facts ca…
6242 msgid "This will print out a dictionary of all of the facts that are available for that particular …
6246 msgid "How do I see all the inventory variables defined for my host?"
6250 msgid "By running the following command, you can see inventory variables for a host:"
6254 msgid "How do I see all the variables specific to my host?"
6258 msgid "To see all host specific variables, which might include facts and other sources:"
6262 msgid "Unless you are using a fact cache, you normally need to use a play that gathers facts first,…
6266 msgid "How do I loop over a list of hosts in a group, inside of a template?"
6270 msgid "A pretty common pattern is to iterate over a list of hosts inside of a host group, perhaps t…
6274 msgid "If you need to access facts about these hosts, for instance, the IP address of each hostname…
6278 msgid "Then you can use the facts inside your template, like this:"
6282 msgid "How do I access a variable name programmatically?"
6286 msgid "An example may come up where we need to get the ipv4 address of an arbitrary interface, wher…
6290 msgid "The trick about going through hostvars is necessary because it's a dictionary of the entire …
6294 msgid "In the example above, if your interface names have dashes, you must replace them with unders…
6298 msgid "Also see dynamic_variables_."
6302 msgid "How do I access a group variable?"
6306 msgid "Technically, you don't, Ansible does not really use groups directly. Groups are labels for h…
6310 msgid "That said, you could just access the variable by selecting a host that is part of that group…
6314 msgid "How do I access a variable of the first host in a group?"
6318 msgid "What happens if we want the ip address of the first webserver in the webservers group?  Well…
6322 msgid "Anyway, here's the trick:"
6326 msgid "Notice how we're pulling out the hostname of the first machine of the webservers group. If y…
6330 msgid "Notice how we interchanged the bracket syntax for dots -- that can be done anywhere."
6334 msgid "How do I copy files recursively onto a target host?"
6338 msgid "The ``copy`` module has a recursive parameter. However, take a look at the ``synchronize`` m…
6342 msgid "How do I access shell environment variables?"
6346 msgid "**On controller machine :** Access existing variables from controller use the ``env`` lookup…
6350 msgid "**On target machines :** Environment variables are available via facts in the ``ansible_env`…
6354 msgid "If you need to set environment variables for TASK execution, see :ref:`playbooks_environment…
6358 msgid "How do I generate encrypted passwords for the user module?"
6362 msgid "Ansible ad hoc command is the easiest option:"
6366 msgid "The ``mkpasswd`` utility that is available on most Linux systems is also a great option:"
6370 msgid "If this utility is not installed on your system (for example, you are using macOS) then you …
6374 msgid "Once the library is ready, SHA512 password values can then be generated as follows:"
6378 msgid "Use the integrated :ref:`hash_filters` to generate a hashed version of a password. You shoul…
6382 msgid "In OpenBSD, a similar option is available in the base system called ``encrypt (1)``"
6386 msgid "Ansible allows dot notation and array notation for variables. Which notation should I use?"
6390 msgid "The dot notation comes from Jinja and works fine for variables without special characters. I…
6394 msgid "Also array notation allows for dynamic variable composition, see dynamic_variables_."
6398 msgid "Another problem with 'dot notation' is that some keys can cause problems because they collid…
6402 msgid "When is it unsafe to bulk-set task arguments from a variable?"
6406 msgid "You can set all of a task's arguments from a dictionary-typed variable. This technique can b…
6410 msgid "This particular example is safe. However, constructing tasks like this is risky because the …
6414 msgid "set bulk variables at a level of precedence greater than ``host facts`` in the order of prec…
6418 msgid "disable the :ref:`inject_facts_as_vars` configuration setting to prevent fact values from co…
6422 msgid "Can I get training on Ansible?"
6426 msgid "Yes! See our `services page <https://www.ansible.com/products/consulting>`_ for information …
6430 msgid "We also offer free web-based training classes on a regular basis. See our `webinar page <htt…
6434 msgid "Is there a web interface / REST API / GUI?"
6438 msgid "Yes! Ansible, Inc makes a great product that makes Ansible even more powerful and easy to us…
6442 msgid "How do I keep secret data in my playbook?"
6446 msgid "If you would like to keep secret data in your Ansible content and still share it publicly or…
6450 msgid "If you have a task that you don't want to show the results or command given to it when using…
6454 msgid "This can be used to keep verbose output but hide sensitive information from others who would…
6458 msgid "The ``no_log`` attribute can also apply to an entire play::"
6462 msgid "Though this will make the play somewhat difficult to debug. It's recommended that this be ap…
6466 msgid "When should I use {{ }}? Also, how to interpolate variables or dynamic variable names"
6470 msgid "A steadfast rule is 'always use ``{{ }}`` except when ``when:``'. Conditionals are always ru…
6474 msgid "In most other cases you should always use the brackets, even if previously you could use var…
6478 msgid "Another rule is 'moustaches don't stack'. We often see this:"
6482 msgid "The above DOES NOT WORK as you expect, if you need to use a dynamic variable use the followi…
6486 msgid "For 'non host vars' you can use the :ref:`vars lookup<vars_lookup>` plugin:"
6490 msgid "Why don't you ship ansible in wheel format (or other packaging format) ?"
6494 msgid "In most cases it has to do with maintainability. There are many ways to ship software and we…
6498 msgid "How do I get the original ansible_host when I delegate a task?"
6502 msgid "As the documentation states, connection variables are taken from the ``delegate_to`` host so…
6506 msgid "This works for all overridden connection variables, like ``ansible_user``, ``ansible_port``,…
6510 msgid "How do I fix 'protocol error: filename does not match request' when fetching a file?"
6514 msgid "Since release ``7.9p1`` of OpenSSH there is a `bug <https://bugzilla.mindrot.org/show_bug.cg…
6518 msgid "In these releases, SCP tries to validate that the path of the file to fetch matches the requ…
6522 msgid "Use SFTP instead of SCP by setting ``scp_if_ssh`` to ``smart`` (which tries SFTP first) or t…
6526 msgid "Rely on the default setting, which is ``smart`` - this works if ``scp_if_ssh`` is not explic…
6530 msgid "Set a :ref:`host variable <host_variables>` or :ref:`group variable <group_variables>` in in…
6534 msgid "Set an environment variable on your control node: ``export ANSIBLE_SCP_IF_SSH=False``"
6538 msgid "Pass an environment variable when you run Ansible: ``ANSIBLE_SCP_IF_SSH=smart ansible-playbo…
6542 msgid "Modify your ``ansible.cfg`` file: add ``scp_if_ssh=False`` to the ``[ssh_connection]`` secti…
6546 msgid "If you must use SCP, set the ``-T`` arg to tell the SCP client to ignore path validation. Yo…
6550 msgid "Set a :ref:`host variable <host_variables>` or :ref:`group variable <group_variables>`: ``an…
6554 msgid "Export or pass an environment variable: ``ANSIBLE_SCP_EXTRA_ARGS=-T``"
6558 msgid "Modify your ``ansible.cfg`` file: add ``scp_extra_args=-T`` to the ``[ssh_connection]`` sect…
6562 msgid "If you see an ``invalid argument`` error when using ``-T``, then your SCP client is not perf…
6566 msgid "Does Ansible support multiple factor authentication 2FA/MFA/biometrics/finterprint/usbkey/OT…
6570 msgid "No, Ansible is designed to execute multiple tasks against multiple targets, minimizing user …
6574 msgid "In such environments we recommend securing around Ansible's execution but still allowing it …
6578 msgid "How do I submit a change to the documentation?"
6582 msgid "Documentation for Ansible is kept in the main project git repository, and complete instructi…
6586 msgid "I don't see my question here"
6590 msgid "Please see the section below for a link to IRC and the Google Group, where you can ask your …
6596 msgid "An introduction to playbooks"
6601 msgid ":ref:`playbooks_best_practices`"
6606 msgid "Tips and tricks for playbooks"
6611 msgid "`User Mailing List <https://groups.google.com/group/ansible-project>`_"
6617 msgid "Have a question?  Stop by the google group!"
6621 msgid "Controlling how Ansible behaves: precedence rules"
6625 msgid "To give you maximum flexibility in managing your environments, Ansible offers many ways to c…
6629 msgid "These precedence rules apply to any setting that can be defined in multiple ways (by configu…
6633 msgid "Precedence categories"
6637 msgid "Ansible offers four sources for controlling its behavior. In order of precedence from lowest…
6642 msgid "Configuration settings"
6647 msgid "Command-line options"
6652 msgid "Playbook keywords"
6656 msgid "Each category overrides any information from all lower-precedence categories. For example, a…
6660 msgid "Within each precedence category, specific rules apply. However, generally speaking, 'last de…
6664 msgid ":ref:`Configuration settings<ansible_configuration_settings>` include both values from the `…
6668 msgid "Environment variables have a higher precedence than entries in ``ansible.cfg``. If you have …
6672 msgid "Any command-line option will override any configuration setting."
6676 msgid "When you type something directly at the command line, you may feel that your hand-crafted va…
6680 msgid "You can override all other settings from all other sources in all other precedence categorie…
6684 msgid "At the command line, if you pass multiple values for a parameter that accepts only a single …
6688 msgid "Some parameters allow multiple values. In this case, Ansible will append all values from the…
6692 msgid "The help for each :ref:`command-line tool<command_line_tools>` lists available options for t…
6696 msgid "Any :ref:`playbook keyword<playbook_keywords>` will override any command-line option and any…
6700 msgid "Within playbook keywords, precedence flows with the playbook itself; the more specific wins …
6704 msgid "play (most general)"
6708 msgid "blocks/includes/imports/roles (optional and can contain tasks and each other)"
6712 msgid "tasks (most specific)"
6716 msgid "A simple example::"
6720 msgid "In this example, the ``connection`` keyword is set to ``ssh`` at the play level. The first t…
6724 msgid "Remember that these are KEYWORDS, not variables. Both playbooks and variable files are defin…
6728 msgid "Any variable will override any playbook keyword, any command-line option, and any configurat…
6732 msgid "Variables that have equivalent playbook keywords, command-line options, and configuration se…
6736 msgid "Connection variables, like all variables, can be set in multiple ways and places. You can de…
6740 msgid "When set in a playbook, variables follow the same inheritance rules as playbook keywords. Yo…
6744 msgid "Variable scope: how long is a value available?"
6748 msgid "Variable values set in a playbook exist only within the playbook object that defines them. T…
6752 msgid "Variable values associated directly with a host or group, including variables defined in inv…
6756 msgid "Using ``-e`` extra variables at the command line"
6760 msgid "To override all other settings in all other categories, you can use extra variables: ``--ext…
6764 msgid "You must specify both the variable name and the value with ``--extra-vars``."
6768 msgid "Glossary"
6772 msgid "The following is a list (and re-explanation) of term definitions used elsewhere in the Ansib…
6776 msgid "Consult the documentation home page for the full documentation and to see the terms in conte…
6780 msgid "Action"
6784 msgid "An action is a part of a task that specifies which of the modules to run and which arguments…
6788 msgid "Ad Hoc"
6792 msgid "Refers to running Ansible to perform some quick command, using :command:`/usr/bin/ansible`, …
6796 msgid "Ansible (the package)"
6800 msgid "A software package (Python, deb, rpm, and so on) that contains ansible-core and a select gro…
6804 msgid "ansible-base"
6808 msgid "Used only for 2.10. The installable package (RPM/Python/Deb package) generated from the `ans…
6812 msgid "ansible-core"
6816 msgid "Name used starting with 2.11. The installable package (RPM/Python/Deb package) generated fro…
6820 msgid "Ansible Galaxy"
6824 msgid "An `online resource <galaxy.ansible.com>`_ for finding and sharing Ansible community content…
6828 msgid "Async"
6832 msgid "Refers to a task that is configured to run in the background rather than waiting for complet…
6836 msgid "Callback Plugin"
6840 msgid "Refers to some user-written code that can intercept results from Ansible and do something wi…
6844 msgid "Check Mode"
6848 msgid "Refers to running Ansible with the ``--check`` option, which does not make any changes on th…
6852 msgid "Collection"
6856 msgid "A packaging format for bundling and distributing Ansible content, including plugins, roles, …
6860 msgid "Collection name"
6864 msgid "The second part of a Fully Qualified Collection Name. The collection name divides the collec…
6868 msgid "community.general (collection)"
6872 msgid "A special collection managed by the Ansible Community Team containing all the modules and pl…
6876 msgid "community.network (collection)"
6880 msgid "Similar to ``community.general``, focusing on network content. `community.network <https://g…
6884 msgid "Connection Plugin"
6888 msgid "By default, Ansible talks to remote machines through pluggable libraries.  Ansible uses nati…
6892 msgid "Conditionals"
6896 msgid "A conditional is an expression that evaluates to true or false that decides whether a given …
6900 msgid "Declarative"
6904 msgid "An approach to achieving a task that uses a description of the final state rather than a des…
6908 msgid "Diff Mode"
6912 msgid "A ``--diff`` flag can be passed to Ansible to show what changed on modules that support it. …
6916 msgid "Executor"
6920 msgid "A core software component of Ansible that is the power behind :command:`/usr/bin/ansible` di…
6925 msgid "Facts"
6929 msgid "Facts are simply things that are discovered about remote nodes.  While they can be used in :…
6933 msgid "Filter Plugin"
6937 msgid "A filter plugin is something that most users will never need to understand.  These allow for…
6941 msgid "Forks"
6945 msgid "Ansible talks to remote nodes in parallel and the level of parallelism can be set either by …
6949 msgid "Fully Qualified Collection Name (FQCN)"
6953 msgid "The full definition of a module, plugin, or role hosted within a collection, in the form <na…
6957 msgid "Gather Facts (Boolean)"
6961 msgid ":term:`Facts` are mentioned above.  Sometimes when running a multi-play :term:`playbook <pla…
6965 msgid "Globbing"
6969 msgid "Globbing is a way to select lots of hosts based on wildcards, rather than the name of the ho…
6973 msgid "Group"
6977 msgid "A group consists of several hosts assigned to a pool that can be conveniently targeted toget…
6981 msgid "Group Vars"
6985 msgid "The :file:`group_vars/` files are files that live in a directory alongside an inventory file…
6989 msgid "Handlers"
6993 msgid "Handlers are just like regular tasks in an Ansible :term:`playbook <playbooks>` (see :term:`…
6997 msgid "Host"
7001 msgid "A host is simply a remote machine that Ansible manages.  They can have individual variables …
7005 msgid "Host Specifier"
7009 msgid "Each :term:`Play <plays>` in Ansible maps a series of :term:`tasks` (which define the role, …
7013 msgid "This ``hosts:`` directive in each play is often called the hosts specifier."
7017 msgid "It may select one system, many systems, one or more groups, or even some hosts that are in o…
7021 msgid "Host Vars"
7025 msgid "Just like :term:`Group Vars`, a directory alongside the inventory file named :file:`host_var…
7029 msgid "Idempotency"
7033 msgid "An operation is idempotent if the result of performing it once is exactly the same as the re…
7037 msgid "Includes"
7041 msgid "The idea that :term:`playbook <playbooks>` files (which are nothing more than lists of :term…
7045 msgid "Inventory"
7049 msgid "A file (by default, Ansible uses a simple INI format) that describes :term:`Hosts <Host>` an…
7053 msgid "Inventory Script"
7057 msgid "A very simple program (or a complicated one) that looks up :term:`hosts <Host>`, :term:`grou…
7061 msgid "Jinja2"
7065 msgid "Jinja2 is the preferred templating language of Ansible's template module.  It is a very simp…
7069 msgid "JSON"
7073 msgid "Ansible uses JSON for return data from remote modules.  This allows modules to be written in…
7077 msgid "Lazy Evaluation"
7081 msgid "In general, Ansible evaluates any variables in :term:`playbook <playbooks>` content at the l…
7085 msgid "Library"
7089 msgid "A collection of modules made available to :command:`/usr/bin/ansible` or an Ansible :term:`p…
7093 msgid "Limit Groups"
7097 msgid "By passing ``--limit somegroup`` to :command:`ansible` or :command:`ansible-playbook`, the c…
7101 msgid "Local Action"
7105 msgid "A local_action directive in a :term:`playbook <playbooks>` targeting remote machines means t…
7109 msgid "Local Connection"
7113 msgid "By using ``connection: local`` in a :term:`playbook <playbooks>`, or passing ``-c local`` to…
7117 msgid "Lookup Plugin"
7121 msgid "A lookup plugin is a way to get data into Ansible from the outside world. Lookup plugins are…
7125 msgid "Loops"
7129 msgid "Generally, Ansible is not a programming language. It prefers to be more declarative, though …
7133 msgid "Modules"
7137 msgid "Modules are the units of work that Ansible ships out to remote machines.   Modules are kicke…
7141 msgid "Multi-Tier"
7145 msgid "The concept that IT systems are not managed one system at a time, but by interactions betwee…
7149 msgid "Namespace"
7153 msgid "The first part of a fully qualified collection name, the namespace usually reflects a functi…
7157 msgid "Notify"
7161 msgid "The act of a :term:`task <tasks>` registering a change event and informing a :term:`handler …
7165 msgid "Orchestration"
7169 msgid "Many software automation systems use this word to mean different things.  Ansible uses it as…
7173 msgid "paramiko"
7177 msgid "By default, Ansible manages machines over SSH.   The library that Ansible uses by default to…
7181 msgid "Playbooks"
7185 msgid "Playbooks are the language by which Ansible orchestrates, configures, administers, or deploy…
7189 msgid "Plays"
7193 msgid "A :term:`playbook <playbooks>` is a list of plays.  A play is minimally a mapping between a …
7197 msgid "Pull Mode"
7201 msgid "By default, Ansible runs in :term:`push mode`, which allows it very fine-grained control ove…
7205 msgid ":command:`ansible-pull` works by checking configuration orders out of git on a crontab and t…
7209 msgid "Push Mode"
7213 msgid "Push mode is the default mode of Ansible. In fact, it's not really a mode at all -- it's jus…
7217 msgid "Register Variable"
7221 msgid "The result of running any :term:`task <tasks>` in Ansible can be stored in a variable for us…
7225 msgid "Resource Model"
7229 msgid "Ansible modules work in terms of resources.   For instance, the :ref:`file module <file_modu…
7233 msgid "Roles"
7237 msgid "Roles are units of organization in Ansible.  Assigning a role to a group of :term:`hosts <Ho…
7241 msgid "Rolling Update"
7245 msgid "The act of addressing a number of nodes in a group N at a time to avoid updating them all at…
7249 msgid "Serial"
7253 msgid ":term:`Rolling Update`"
7257 msgid "Sudo"
7261 msgid "Ansible does not require root logins, and since it's daemonless, definitely does not require…
7265 msgid "SSH (Native)"
7269 msgid "Native OpenSSH as an Ansible transport is specified with ``-c ssh`` (or a config file, or a …
7273 msgid "Tags"
7277 msgid "Ansible allows tagging resources in a :term:`playbook <playbooks>` with arbitrary keywords, …
7282 msgid "Task"
7286 msgid ":term:`Playbooks` exist to run tasks.  Tasks combine an :term:`action` (a module and its arg…
7290 msgid "Tasks"
7294 msgid "A list of :term:`Task`."
7298 msgid "Templates"
7302 msgid "Ansible can easily transfer files to remote systems but often it is desirable to substitute …
7306 msgid "Transport"
7310 msgid "Ansible uses :term:``Connection Plugins`` to define types of available transports.  These ar…
7314 msgid "When"
7318 msgid "An optional conditional statement attached to a :term:`task <tasks>` that is used to determi…
7322 msgid "Vars (Variables)"
7326 msgid "As opposed to :term:`Facts`, variables are names of values (they can be simple scalar values…
7330 msgid "YAML"
7334 msgid "Ansible does not want to force people to write programming language code to automate infrast…
7338 msgid ":ref:`ansible_faq`"
7342 msgid "Frequently asked questions"
7346 msgid "`User Mailing List <https://groups.google.com/group/ansible-devel>`_"
7350 msgid "Interpreter Discovery"
7354 msgid "Most Ansible modules that execute under a POSIX environment require a Python interpreter on …
7358 msgid "To control the discovery behavior:"
7362 msgid "for individual hosts and groups, use the ``ansible_python_interpreter`` inventory variable"
7366 msgid "globally, use the ``interpreter_python`` key in the ``[defaults]`` section of ``ansible.cfg`…
7370 msgid "Use one of the following values:"
7374 msgid "Detects the target OS platform, distribution, and version, then consults a table listing the…
7378 msgid "auto"
7382 msgid "Detects the target OS platform, distribution, and version, then consults a table listing the…
7386 msgid "auto_legacy_silent"
7390 msgid "Same as ``auto_legacy``, but does not issue warnings."
7394 msgid "auto_silent"
7398 msgid "Same as ``auto``, but does not issue warnings."
7402 msgid "You can still set ``ansible_python_interpreter`` to a specific path at any variable level (f…
7406 msgid "Logging Ansible output"
7410 msgid "By default Ansible sends output about plays, tasks, and module arguments to your screen (STD…
7414 msgid "To save Ansible output in a single log on the control node, set the ``log_path`` :ref:`confi…
7418 msgid "To save Ansible output in separate logs, one on each managed node, set the ``no_target_syslo…
7422 msgid "To save Ansible output to a secure database, use :ref:`Ansible Tower <ansible_tower>`. Tower…
7426 msgid "Protecting sensitive data with ``no_log``"
7430 msgid "If you save Ansible output to a log, you expose any secret data in your Ansible output, such…
7434 msgid "Ansible Reference: Module Utilities"
7438 msgid "This page documents utilities intended to be helpful when writing Ansible modules in Python."
7442 msgid "AnsibleModule"
7446 msgid "To use this functionality, include ``from ansible.module_utils.basic import AnsibleModule`` …
7450 msgid "Common code for quickly building an ansible module in Python (although you can write modules…
7454 msgid "See :ref:`developing_modules_general` for a general introduction and :ref:`developing_progra…
7458 msgid "for results that are files, supplement the info about the file in the return path with stats…
7462 msgid "atomically move src to dest, copying attributes from dest, returns true on success it uses o…
7466 msgid "make a date-marked backup of the specified file, return True or False on success or failure"
7470 msgid "Convert the argument to a boolean"
7474 msgid "Return hex digest of local file for a digest_method specified by name, or None if file is no…
7478 msgid "return from the module, without error"
7482 msgid "return from the module, with an error message"
7486 msgid "Takes a path and returns it's mount point"
7512 msgid "Parameters"
7516 msgid "a string type with a filesystem path"
7539 msgid "Returns"
7543 msgid "the path to the mount point as a text type"
7547 msgid "Find system executable in PATH."
7551 msgid "The executable to find."
7555 msgid "if executable is not found and required is ``True``, fail_json"
7559 msgid "optional list of directories to search in addition to ``PATH``"
7563 msgid "if found return full path; otherwise return None"
7567 msgid "is the given path executable?"
7571 msgid "The path of the file to check."
7575 msgid "Limitations:"
7579 msgid "Does not account for FSACLs."
7583 msgid "Most times we really want to know \"Can the current user execute this file\".  This function…
7587 msgid "Returns a tuple containing (True, selinux_context) if the given path is on a NFS or other 's…
7591 msgid "many modules deal with files, this encapsulates common options that the file module accepts …
7595 msgid "Allows to overwrite the path/dest module argument by providing path."
7599 msgid "Return MD5 hex digest of local file using digest_from_file()."
7603 msgid "Do not use this function unless you have no other choice for:"
7607 msgid "Optional backwards compatibility"
7611 msgid "Compatibility with a third party protocol"
7615 msgid "This function will not work on systems complying with FIPS-140-2."
7619 msgid "Most uses of this function can use the module.sha1 function instead."
7623 msgid "Copy a file with preserved ownership, permissions and context"
7627 msgid "Execute a command, returns rc, stdout, and stderr."
7631 msgid "is the command to run * If args is a list, the command will be run with shell=False. * If ar…
7635 msgid "kw check_rc"
7639 msgid "Whether to call fail_json in case of non zero RC. Default False"
7643 msgid "kw close_fds"
7647 msgid "See documentation for subprocess.Popen(). Default True"
7651 msgid "kw executable"
7655 msgid "See documentation for subprocess.Popen(). Default None"
7659 msgid "kw data"
7663 msgid "If given, information to write to the stdin of the command"
7667 msgid "kw binary_data"
7671 msgid "If False, append a newline to the data.  Default False"
7675 msgid "kw path_prefix"
7679 msgid "If given, additional path to find the command in. This adds to the PATH environment variable…
7683 msgid "kw cwd"
7687 msgid "If given, working directory to run the command inside"
7691 msgid "kw use_unsafe_shell"
7695 msgid "See `args` parameter.  Default False"
7699 msgid "kw prompt_regex"
7703 msgid "Regex string (not a compiled regex) which can be used to detect prompts in the stdout which …
7707 msgid "kw environ_update"
7711 msgid "dictionary to *update* os.environ with"
7715 msgid "kw umask"
7719 msgid "Umask to be used when running the command. Default None"
7723 msgid "kw encoding"
7727 msgid "Since we return native strings, on python3 we need to know the encoding to use to transform …
7731 msgid "kw errors"
7735 msgid "Since we return native strings, on python3 we need to transform stdout and stderr from bytes…
7739 msgid "kw expand_user_and_vars"
7743 msgid "When ``use_unsafe_shell=False`` this argument dictates whether ``~`` is expanded in paths an…
7747 msgid "kw pass_fds"
7751 msgid "When running on Python 3 this argument dictates which file descriptors should be passed to a…
7755 msgid "kw before_communicate_callback"
7759 msgid "This function will be called after ``Popen`` object will be created but before communicating…
7763 msgid "kw ignore_invalid_cwd"
7767 msgid "This flag indicates whether an invalid ``cwd`` (non-existent or not a directory) should be i…
7771 msgid "A 3-tuple of return code (integer), stdout (native string), and stderr (native string).  On …
7775 msgid "Return SHA1 hex digest of local file using digest_from_file()."
7779 msgid "Return SHA-256 hex digest of local file using digest_from_file()."
7783 msgid "Basic"
7787 msgid "To use this functionality, include ``import ansible.module_utils.basic`` in your module."
7791 msgid "**Deprecated**: Use ansible.module_utils.common._utils.get_all_subclasses instead"
7795 msgid "**Deprecated** Use :py:func:`platform.system` directly."
7799 msgid "Name of the platform the module is running on in a native string"
7803 msgid "Returns a native string that labels the platform (\"Linux\", \"Solaris\", etc). Currently, t…
7807 msgid "Remove strings that look like passwords from log messages"
7811 msgid "**Deprecated**: Use ansible.module_utils.common.sys_info.get_platform_subclass instead"
7815 msgid "Argument Spec"
7819 msgid "Classes and functions for validating parameters against an argument spec."
7823 msgid "ArgumentSpecValidator"
7827 msgid "Argument spec validation class"
7831 msgid "Creates a validator based on the ``argument_spec`` that can be used to validate a number of …
7835 msgid "Specification of valid parameters and their type. May include nested argument specs."
7839 msgid "List or list of lists of terms that should not be provided together."
7843 msgid "List of lists of terms that are required together."
7847 msgid "List of lists of terms, one of which in each list is required."
7851 msgid "List of lists of ``[parameter, value, [parameters]]`` where one of ``[parameters]`` is requi…
7855 msgid "Dictionary of parameter names that contain a list of parameters required by each key in the …
7859 msgid "Validate ``parameters`` against argument spec."
7863 msgid "Error messages in the :class:`ValidationResult` may contain no_log values and should be sani…
7867 msgid "Parameters to validate against the argument spec"
7871 msgid ":class:`ValidationResult` containing validated parameters."
7875 msgid "Simple Example"
7879 msgid "ValidationResult"
7883 msgid "Result of argument spec validation."
7887 msgid "This is the object returned by :func:`ArgumentSpecValidator.validate() <ansible.module_utils…
7891 msgid "Terms to be validated and coerced to the correct type."
7895 msgid ":class:`set` of values marked as ``no_log`` in the argument spec. This is a temporary holdin…
7899 msgid ":class:`~ansible.module_utils.errors.AnsibleValidationErrorMultiple` containing all :class:`…
7904 msgid "Validated and coerced parameters."
7909 msgid ":class:`set` of unsupported parameter names."
7913 msgid ":class:`list` of all error messages from each exception in :attr:`errors`."
7917 msgid ":class:`dict` of type names, such as ``'str'``, and the default function used to check that …
7921 msgid "Load value from environment variable"
7925 msgid "Remove strings in ``no_log_strings`` from value."
7929 msgid "If value is a container type, then remove a lot more."
7933 msgid "Use of ``deferred_removals`` exists, rather than a pure recursive solution, because of the p…
7937 msgid "Sanitize the keys in a container object by removing ``no_log`` values from key names."
7941 msgid "This is a companion function to the :func:`remove_values` function. Similar to that function…
7945 msgid "The container object to sanitize. Non-container objects are returned unmodified."
7949 msgid "A set of string values we do not want logged."
7953 msgid "A set of string values of keys to not sanitize."
7957 msgid "An object with sanitized keys."
7961 msgid "Validation"
7965 msgid "Standalone functions for validating various parameter types."
7969 msgid "This is for checking for required params when we can not check via argspec because we need m…
7973 msgid "Raises :class:`TypeError` if any required parameters are missing"
7984 msgid "Dictionary of parameters"
7988 msgid "List of parameters to look for in the given parameters."
7996 msgid "Empty list or raises :class:`TypeError` if the check fails."
8000 msgid "Check mutually exclusive terms against argument parameters"
8004 msgid "Accepts a single list or list of lists that are groups of terms that should be mutually excl…
8008 msgid "List of mutually exclusive parameters"
8012 msgid "Check all parameters in argument_spec and return a list of parameters that are required but …
8017 msgid "Raises :class:`TypeError` if the check fails"
8021 msgid "Argument spec dictionary containing all parameters and their specification"
8025 msgid "For each key in requirements, check the corresponding list to see if they exist in parameter…
8029 msgid "Accepts a single string or list of values for each key."
8033 msgid "Dictionary of requirements"
8037 msgid "Empty dictionary or raises :class:`TypeError` if the"
8041 msgid "Check parameters that are conditionally required"
8045 msgid "List of lists specifying a parameter, value, parameters required when the given parameter is…
8049 msgid "Example"
8053 msgid "Empty list or raises :class:`TypeError` if the check fails. The results attribute of the exc…
8057 msgid "Empty list or raises :class:`TypeError` if the check fails. The results attribute of the exc…
8061 msgid "key missing"
8065 msgid "List of parameters that are required but missing"
8069 msgid "key requires"
8073 msgid "'any' or 'all'"
8077 msgid "key parameter"
8081 msgid "Parameter name that has the requirement"
8085 msgid "key value"
8089 msgid "Original value of the parameter"
8093 msgid "key requirements"
8097 msgid "Original required parameters"
8101 msgid "Check each list of terms to ensure at least one exists in the given module parameters"
8105 msgid "Accepts a list of lists or tuples"
8109 msgid "List of lists of terms to check. For each list of terms, at least one is required."
8113 msgid "List of strings of parent key names if ``terms`` are in a sub spec."
8117 msgid "Check each list of terms to ensure every parameter in each list exists in the given paramete…
8121 msgid "Accepts a list of lists or tuples."
8125 msgid "List of lists of terms to check. Each list should include parameters that are all required w…
8129 msgid "Convert a human-readable string bits value to bits in integer."
8133 msgid "Example: ``check_type_bits('1Mb')`` returns integer 1048576."
8137 msgid "Raises :class:`TypeError` if unable to covert the value."
8141 msgid "Verify that the value is a bool or convert it to a bool and return it."
8145 msgid "Raises :class:`TypeError` if unable to convert to a bool"
8149 msgid "String, int, or float to convert to bool. Valid booleans include: '1', 'on', 1, '0', 0, 'n',…
8153 msgid "Boolean True or False"
8157 msgid "Convert a human-readable string value to bytes"
8162 msgid "Raises :class:`TypeError` if unable to covert the value"
8166 msgid "Verify that value is a dict or convert it to a dict and return it."
8170 msgid "Raises :class:`TypeError` if unable to convert to a dict"
8174 msgid "Dict or string to convert to a dict. Accepts ``k1=v2, k2=v2``."
8178 msgid "value converted to a dictionary"
8182 msgid "Verify that value is a float or convert it to a float and return it"
8186 msgid "Raises :class:`TypeError` if unable to convert to a float"
8190 msgid "float, int, str, or bytes to verify or convert and return."
8194 msgid "float of given value."
8198 msgid "Verify that the value is an integer and return it or convert the value to an integer and ret…
8202 msgid "Raises :class:`TypeError` if unable to convert to an int"
8206 msgid "String or int to convert of verify"
8210 msgid "int of given value"
8214 msgid "Return a jsonified string. Sometimes the controller turns a json string into a dict/list so …
8218 msgid "Verify that the value is a list or convert to a list"
8222 msgid "A comma separated string will be split into a list. Raises a :class:`TypeError` if unable to…
8226 msgid "Value to validate or convert to a list"
8230 msgid "Original value if it is already a list, single item list if a float, int, or string without …
8234 msgid "Verify the provided value is a string or convert it to a string, then return the expanded pa…
8238 msgid "Returns the raw value"
8242 msgid "Verify that the value is a string or convert to a string."
8246 msgid "Since unexpected changes can sometimes happen when converting to a string, ``allow_conversio…
8250 msgid "Value to validate or convert to a string"
8254 msgid "Whether to convert the string and return it or raise a TypeError"
8258 msgid "Original value if it is a string, the value converted to a string if allow_conversion=True, …
8262 msgid "Count the number of occurrences of a key in a given dictionary"
8266 msgid "String or iterable of values to check"
8270 msgid "An integer that is the number of occurrences of the terms values in the provided dictionary."
8274 msgid "Errors"
8278 msgid "Fallback validator was not found"
8282 msgid "Single argument spec validation error"
8287 msgid "The error message passed in when the exception was raised."
8291 msgid "Multiple argument spec validation errors"
8295 msgid ":class:`list` of :class:`AnsibleValidationError` objects"
8299 msgid "The first message from the first error in ``errors``."
8303 msgid ":class:`list` of each error message in ``errors``."
8307 msgid "Append a new error to ``self.errors``."
8311 msgid "Only :class:`AnsibleValidationError` should be added."
8315 msgid "Append each item in ``errors`` to ``self.errors``. Only :class:`AnsibleValidationError` shou…
8319 msgid "Error handling aliases"
8323 msgid "Error with parameter type"
8327 msgid "Error with parameter value"
8331 msgid "Error when validating elements"
8335 msgid "Mutually exclusive parameters were supplied"
8339 msgid "Error converting no_log values"
8343 msgid "Error with parameters that are required by other parameters"
8347 msgid "A required parameter was assigned a default value"
8351 msgid "Missing a required parameter"
8355 msgid "Error with conditionally required parameters"
8359 msgid "Error with parameters where at least one is required"
8363 msgid "Error with parameters that are required together"
8367 msgid "Incorrect type for subparameter"
8371 msgid "Unsupported parameters were supplied"
8375 msgid "Playbook Keywords"
8379 msgid "These are the keywords available on common playbook objects. Keywords are one of several sou…
8383 msgid "Please note:"
8387 msgid "Aliases for the directives are not reflected here, nor are mutable one. For example, :term:`…
8391 msgid "The keywords do not have ``version_added`` information at this time"
8395 msgid "Some keywords set defaults for the objects inside of them rather than for the objects themse…
8399 msgid "Play"
8406 msgid "Force any un-handled task errors on any host to propagate to all hosts and end the play."
8413 msgid "Boolean that controls if privilege escalation is used or not on :term:`Task` execution. Impl…
8420 msgid "Path to the executable used to elevate privileges. Implemented by the become plugin. See :re…
8427 msgid "A string of flag(s) to pass to the privilege escalation program when :term:`become` is True."
8434 msgid "Which method of privilege escalation to use (such as sudo or su)."
8441 msgid "User that you 'become' after using privilege escalation. The remote/login user must have per…
8448 msgid "check_mode"
8455 msgid "A boolean that controls if a task is executed in 'check' mode. See :ref:`check_mode_dry`."
8462 msgid "collections"
8469 msgid "List of collection namespaces to search for modules, plugins, and roles. See :ref:`collectio…
8476 msgid "Tasks within a role do not inherit the value of ``collections`` from the play. To have a rol…
8483 msgid "connection"
8490 msgid "Allows you to change the connection plugin used for tasks to execute on the target. See :ref…
8497 msgid "debugger"
8504 msgid "Enable debugging tasks based on state of the task result. See :ref:`playbook_debugger`."
8511 msgid "Toggle to make tasks return 'diff' information or not."
8518 msgid "environment"
8525 msgid "A dictionary that gets converted into environment vars to be provided for the task upon exec…
8529 msgid "Set the fact path option for the fact gathering plugin controlled by :term:`gather_facts`."
8533 msgid "Will force notified handler execution for hosts even if they failed during the play. Will no…
8537 msgid "gather_facts"
8541 msgid "A boolean that controls if the play will automatically run the 'setup' task to gather facts …
8545 msgid "Allows you to pass subset options to the  fact gathering plugin controlled by :term:`gather_…
8549 msgid "Allows you to set the timeout for the fact gathering plugin controlled by :term:`gather_fact…
8553 msgid "handlers"
8557 msgid "A section with tasks that are treated as handlers, these won't get executed normally, only w…
8561 msgid "hosts"
8565 msgid "A list of groups, hosts or host pattern that translates into a list of hosts that are the pl…
8572 msgid "ignore_errors"
8579 msgid "Boolean that allows you to ignore task failures and continue with play. It does not affect c…
8586 msgid "ignore_unreachable"
8593 msgid "Boolean that allows you to ignore task failures due to an unreachable host and continue with…
8597 msgid "max_fail_percentage"
8601 msgid "can be used to abort the run after a given percentage of hosts in the current batch has fail…
8608 msgid "module_defaults"
8615 msgid "Specifies default parameter values for modules."
8622 msgid "Identifier. Can be used for documentation, or in tasks/handlers."
8629 msgid "Boolean that controls information disclosure."
8633 msgid "order"
8637 msgid "Controls the sorting of hosts as they are used for executing the play. Possible values are i…
8644 msgid "port"
8651 msgid "Used to override the default port used in a connection."
8655 msgid "post_tasks"
8659 msgid "A list of tasks to execute after the :term:`tasks` section."
8663 msgid "pre_tasks"
8667 msgid "A list of tasks to execute before :term:`roles`."
8674 msgid "User used to log into the target via the connection plugin."
8678 msgid "roles"
8682 msgid "List of roles to be imported into the play"
8689 msgid "run_once"
8696 msgid "Boolean that will bypass the host loop, forcing the task to attempt to execute on the first …
8700 msgid "serial"
8704 msgid "Explicitly define how Ansible batches the execution of the current play on the play's target"
8708 msgid ":ref:`rolling_update_batch_size`"
8712 msgid "Allows you to choose the connection plugin to use for the play."
8719 msgid "tags"
8726 msgid "Tags applied to the task or included tasks, this allows selecting subsets of tasks from the …
8730 msgid "tasks"
8734 msgid "Main list of tasks to execute in the play, they run after :term:`roles` and before :term:`po…
8741 msgid "throttle"
8748 msgid "Limit number of concurrent task runs on task, block and playbook level. This is independent …
8755 msgid "Time limit for task to execute in, if exceeded Ansible will interrupt and fail the task."
8762 msgid "vars"
8769 msgid "Dictionary/map of variables"
8773 msgid "vars_files"
8777 msgid "List of files that contain vars to include in the play."
8781 msgid "vars_prompt"
8785 msgid "list of variables to prompt for."
8789 msgid "Role"
8795 msgid "delegate_facts"
8801 msgid "Boolean that allows you to apply facts to a delegated host instead of inventory_hostname."
8807 msgid "delegate_to"
8813 msgid "Host to execute task instead of the target (inventory_hostname). Connection vars from the de…
8819 msgid "when"
8825 msgid "Conditional expression, determines if an iteration of a task is run or not."
8829 msgid "Block"
8833 msgid "List of tasks, in a block, that execute no matter if there is an error in the block or not."
8837 msgid "block"
8841 msgid "List of tasks in a block."
8846 msgid "notify"
8851 msgid "List of handlers to notify when the task returns a 'changed=True' status."
8855 msgid "rescue"
8859 msgid "List of tasks in a :term:`block` that run if there is a task error in the main :term:`block`…
8863 msgid "action"
8867 msgid "The 'action' to execute for a task, it normally translates into a C(module) or action plugin…
8871 msgid "args"
8875 msgid "A secondary way to add arguments into a task. Takes a dictionary in which keys map to option…
8879 msgid "async"
8883 msgid "Run a task asynchronously if the C(action) supports this; value is maximum runtime in second…
8887 msgid "changed_when"
8891 msgid "Conditional expression that overrides the task's normal 'changed' status."
8895 msgid "delay"
8899 msgid "Number of seconds to delay between retries. This setting is only used in combination with :t…
8903 msgid "failed_when"
8907 msgid "Conditional expression that overrides the task's normal 'failed' status."
8911 msgid "local_action"
8915 msgid "Same as action but also implies ``delegate_to: localhost``"
8919 msgid "loop"
8923 msgid "Takes a list for the task to iterate over, saving each list element into the ``item`` variab…
8927 msgid "loop_control"
8931 msgid "Several keys here allow you to modify/set loop behaviour in a task."
8935 msgid ":ref:`loop_control`"
8939 msgid "poll"
8943 msgid "Sets the polling interval in seconds for async tasks (default 10s)."
8947 msgid "register"
8951 msgid "Name of variable that will contain task status and module return data."
8955 msgid "retries"
8959 msgid "Number of retries before giving up in a :term:`until` loop. This setting is only used in com…
8963 msgid "until"
8967 msgid "This keyword implies a ':term:`retries` loop' that will go on until the condition supplied h…
8971 msgid "with_<lookup_plugin>"
8975 msgid "The same as ``loop`` but magically adds the output of any lookup plugin to generate the item…
8979 msgid "Python 3 Support"
8983 msgid "Ansible 2.5 and above work with Python 3. Previous to 2.5, using Python 3 was considered a t…
8987 msgid "On the controller we support Python 3.5 or greater and Python 2.7 or greater. Module-side, w…
8991 msgid "On the controller side"
8995 msgid "The easiest way to run :command:`/usr/bin/ansible` under Python 3 is to install it with the …
8999 msgid "If you are running Ansible :ref:`from_source` and want to use Python 3 with your source chec…
9003 msgid "Individual Linux distribution packages may be packaged for Python2 or Python3.  When running…
9007 msgid "Using Python 3 on the managed machines with commands and playbooks"
9011 msgid "Ansible will automatically detect and use Python 3 on many platforms that ship with it. To e…
9015 msgid ":ref:`interpreter_discovery` for more information."
9019 msgid ":ref:`intro_inventory` for more information."
9023 msgid "Run your command or playbook:"
9027 msgid "Note that you can also use the `-e` command line option to manually set the python interpret…
9031 msgid "What to do if an incompatibility is found"
9035 msgid "We have spent several releases squashing bugs and adding new tests so that Ansible's core fe…
9039 msgid "If you find a bug running under Python 3 you can submit a bug report on `Ansible's GitHub pr…
9043 msgid "If you would like to fix the code and submit a pull request on github, you can refer to :ref…
9047 msgid "Releases and maintenance"
9051 msgid "Please go to `the devel release and maintenance page <https://docs.ansible.com/ansible/devel…
9055 msgid "This link takes you to a different version of the Ansible documentation. Use the version sel…
9059 msgid ":ref:`community_committer_guidelines`"
9063 msgid "Guidelines for Ansible core contributors and maintainers"
9067 msgid ":ref:`testing_strategies`"
9071 msgid "Testing strategies"
9075 msgid ":ref:`ansible_community_guide`"
9079 msgid "Community information and contributing"
9083 msgid "`Development Mailing List <https://groups.google.com/group/ansible-devel>`_"
9087 msgid "Mailing list for development topics"
9091 msgid "Special Variables"
9095 msgid "Magic variables"
9099 msgid "These variables cannot be set directly by the user; Ansible will always override them to ref…
9103 msgid "ansible_check_mode"
9107 msgid "Boolean that indicates if we are in check mode or not"
9111 msgid "ansible_config_file"
9115 msgid "The full path of used Ansible configuration file"
9119 msgid "ansible_dependent_role_names"
9123 msgid "The names of the roles currently imported into the current play as dependencies of other pla…
9127 msgid "ansible_diff_mode"
9131 msgid "Boolean that indicates if we are in diff mode or not"
9135 msgid "ansible_forks"
9139 msgid "Integer reflecting the number of maximum forks available to this run"
9143 msgid "ansible_inventory_sources"
9147 msgid "List of sources used as inventory"
9151 msgid "ansible_limit"
9155 msgid "Contents of the ``--limit`` CLI option for the current execution of Ansible"
9159 msgid "ansible_loop"
9163 msgid "A dictionary/map containing extended loop information when enabled via ``loop_control.extend…
9167 msgid "ansible_loop_var"
9171 msgid "The name of the value provided to ``loop_control.loop_var``. Added in ``2.8``"
9175 msgid "ansible_index_var"
9179 msgid "The name of the value provided to ``loop_control.index_var``. Added in ``2.9``"
9183 msgid "ansible_parent_role_names"
9187 msgid "When the current role is being executed by means of an :ref:`include_role <include_role_modu…
9191 msgid "For example: When role **A** includes role **B**, inside role B, ``ansible_parent_role_names…
9195 msgid "ansible_parent_role_paths"
9199 msgid "When the current role is being executed by means of an :ref:`include_role <include_role_modu…
9203 msgid "ansible_play_batch"
9207 msgid "List of active hosts in the current play run limited by the serial, aka 'batch'. Failed/Unre…
9211 msgid "ansible_play_hosts"
9215 msgid "List of hosts in the current play run, not limited by the serial. Failed/Unreachable hosts a…
9219 msgid "ansible_play_hosts_all"
9223 msgid "List of all the hosts that were targeted by the play"
9227 msgid "ansible_play_role_names"
9231 msgid "The names of the roles currently imported into the current play. This list does **not** cont…
9235 msgid "ansible_playbook_python"
9239 msgid "The path to the python interpreter being used by Ansible on the controller"
9243 msgid "ansible_role_names"
9247 msgid "The names of the roles currently imported into the current play, or roles referenced as depe…
9251 msgid "ansible_role_name"
9255 msgid "The fully qualified collection role name, in the format of ``namespace.collection.role_name`…
9259 msgid "ansible_collection_name"
9263 msgid "The name of the collection the task that is executing is a part of. In the format of ``names…
9267 msgid "ansible_run_tags"
9271 msgid "Contents of the ``--tags`` CLI option, which specifies which tags will be included for the c…
9275 msgid "ansible_search_path"
9279 msgid "Current search path for action plugins and lookups, in other words, where we search for rela…
9283 msgid "ansible_skip_tags"
9287 msgid "Contents of the ``--skip-tags`` CLI option, which specifies which tags will be skipped for t…
9291 msgid "ansible_verbosity"
9295 msgid "Current verbosity setting for Ansible"
9299 msgid "ansible_version"
9303 msgid "Dictionary/map that contains information about the current running version of ansible, it ha…
9307 msgid "group_names"
9311 msgid "List of groups the current host is part of"
9315 msgid "groups"
9319 msgid "A dictionary/map with all the groups in inventory and each group has the list of hosts that …
9323 msgid "hostvars"
9327 msgid "A dictionary/map with all the hosts in inventory and variables assigned to them"
9331 msgid "inventory_hostname"
9335 msgid "The inventory name for the 'current' host being iterated over in the play"
9339 msgid "inventory_hostname_short"
9343 msgid "The short version of `inventory_hostname`"
9347 msgid "inventory_dir"
9351 msgid "The directory of the inventory source in which the `inventory_hostname` was first defined"
9355 msgid "inventory_file"
9359 msgid "The file name of the inventory source in which the `inventory_hostname` was first defined"
9363 msgid "omit"
9367 msgid "Special variable that allows you to 'omit' an option in a task, for example ``- user: name=b…
9371 msgid "play_hosts"
9375 msgid "Deprecated, the same as ansible_play_batch"
9379 msgid "ansible_play_name"
9383 msgid "The name of the currently executed play. Added in ``2.8``. (`name` attribute of the play, no…
9387 msgid "The path to the directory of the playbook that was passed to the ``ansible-playbook`` comman…
9391 msgid "role_name"
9395 msgid "The name of the role currently being executed."
9399 msgid "role_names"
9403 msgid "Deprecated, the same as ansible_play_role_names"
9407 msgid "role_path"
9411 msgid "The path to the dir of the currently running role"
9415 msgid "These are variables that contain information pertinent to the current host (`inventory_hostn…
9419 msgid "Contains any facts gathered or cached for the `inventory_hostname` Facts are normally gather…
9423 msgid "ansible_local"
9427 msgid "Contains any 'local facts' gathered or cached for the `inventory_hostname`. The keys availab…
9431 msgid "Connection variables"
9435 msgid "Connection variables are normally used to set the specifics on how to execute actions on a t…
9439 msgid "ansible_become_user"
9443 msgid "The user Ansible 'becomes' after using privilege escalation. This must be available to the '…
9447 msgid "ansible_connection"
9451 msgid "The connection plugin actually used for the task on the target host."
9455 msgid "ansible_host"
9459 msgid "The ip/name of the target host to use instead of `inventory_hostname`."
9463 msgid "ansible_python_interpreter"
9467 msgid "The path to the Python executable Ansible should use on the target host."
9471 msgid "ansible_user"
9475 msgid "The user Ansible 'logs in' as."
9479 msgid "Testing Strategies"
9483 msgid "Integrating Testing With Ansible Playbooks"
9487 msgid "Many times, people ask, \"how can I best integrate testing with Ansible playbooks?\"  There …
9491 msgid "This is a chapter about testing the application you are deploying, not the chapter on how to…
9495 msgid "By incorporating a degree of testing into your deployment workflow, there will be fewer surp…
9499 msgid "The Right Level of Testing"
9503 msgid "Ansible resources are models of desired-state.  As such, it should not be necessary to test …
9507 msgid "If you think the service may not be started, the best thing to do is request it to be starte…
9511 msgid "Check Mode As A Drift Test"
9515 msgid "In the above setup, `--check` mode in Ansible can be used as a layer of testing as well.  If…
9519 msgid "This can let you know up front if there is any need to deploy onto the given system.  Ordina…
9523 msgid "Modules That Are Useful for Testing"
9527 msgid "Certain playbook modules are particularly good for testing.  Below is an example that ensure…
9531 msgid "Here's an example of using the URI module to make sure a web service returns::"
9535 msgid "It's easy to push an arbitrary script (in any language) on a remote host and the script will…
9539 msgid "If using roles (you should be, roles are great!), scripts pushed by the script module can li…
9543 msgid "And the assert module makes it very easy to validate various kinds of truth::"
9547 msgid "Should you feel the need to test for the existence of files that are not declaratively set b…
9551 msgid "As mentioned above, there's no need to check things like the return codes of commands.  Ansi…
9555 msgid "Ansible is a fail-fast system, so when there is an error creating that user, it will stop th…
9559 msgid "Testing Lifecycle"
9563 msgid "If writing some degree of basic validation of your application into your playbooks, they wil…
9567 msgid "As such, deploying into a local development VM and a staging environment will both validate …
9571 msgid "Your workflow may be something like this::"
9575 msgid "Something like an integration test battery should be written by your QA team if you are a pr…
9579 msgid "However, it does make sense to include some basic health checks into your playbooks, and in …
9583 msgid "Integrating Testing With Rolling Updates"
9587 msgid "If you have read into :ref:`playbooks_delegation` it may quickly become apparent that the ro…
9591 msgid "This is the great culmination of embedded tests::"
9595 msgid "Of course in the above, the \"take out of the pool\" and \"add back\" steps would be replace…
9599 msgid "However, what you can see from the above is that tests are used as a gate -- if the \"apply_…
9603 msgid "Read the delegation chapter about \"max_fail_percentage\" and you can also control how many …
9607 msgid "This above approach can also be modified to run a step from a testing machine remotely again…
9611 msgid "In the above example, a script is run from the testing server against a remote node prior to…
9615 msgid "In the event of a problem, fix the few servers that fail using Ansible's automatically gener…
9619 msgid "Achieving Continuous Deployment"
9623 msgid "If desired, the above techniques may be extended to enable continuous deployment practices."
9627 msgid "The workflow may look like this::"
9631 msgid "Some Ansible users use the above approach to deploy a half-dozen or dozen times an hour with…
9635 msgid "If you are still doing a large amount of manual QA, you should still make the decision on wh…
9639 msgid "Conclusion"
9643 msgid "Ansible believes you should not need another framework to validate basic things of your infr…
9647 msgid "However, as Ansible is designed as a multi-tier orchestration system, it makes it very easy …
9651 msgid "Finally, because Ansible errors propagate all the way up to the return code of the Ansible p…
9655 msgid "The focus should not be on infrastructure testing, but on application testing, so we strongl…
9659 msgid "In all, testing is a very organizational and site-specific thing.  Everybody should be doing…
9663 msgid ":ref:`playbooks_delegation`"
9667 msgid "Delegation, useful for working with load balancers, clouds, and locally executed steps."
9671 msgid "Red Hat Ansible Tower"
9675 msgid "`Red Hat Ansible Tower <https://www.ansible.com/products/tower>`_ is a web console and REST …
9679 msgid "Ansible Tower gives you role-based access control, including control over the use of securel…
9683 msgid "It logs all of your jobs, integrates well with LDAP, SAML, and other authentication sources,…
9687 msgid "Ansible Tower is the downstream Red-Hat supported product version of Ansible AWX. Find out m…
9690 #~ msgid "ANSIBLE_SSH_ARGS"
9693 #~ msgid "If set, this will override the Ansible default ssh arguments. In particular, users may wi…
9696 #~ msgid "-C -o ControlMaster=auto -o ControlPersist=60s"
9699 #~ msgid "[ssh_connection]"
9702 #~ msgid "ssh_args"
9705 #~ msgid ":envvar:`ANSIBLE_SSH_ARGS`"
9708 #~ msgid "ANSIBLE_SSH_CONTROL_PATH"
9711 #~ msgid "This is the location to save ssh's ControlPath sockets, it uses ssh's variable substituti…
9714 #~ msgid "control_path"
9717 #~ msgid ":envvar:`ANSIBLE_SSH_CONTROL_PATH`"
9720 #~ msgid "ANSIBLE_SSH_CONTROL_PATH_DIR"
9723 #~ msgid "This sets the directory to use for ssh control path if the control path setting is null. …
9726 #~ msgid "~/.ansible/cp"
9729 #~ msgid ":envvar:`ANSIBLE_SSH_CONTROL_PATH_DIR`"
9732 #~ msgid "ANSIBLE_SSH_EXECUTABLE"
9735 #~ msgid "This defines the location of the ssh binary. It defaults to `ssh` which will use the firs…
9738 #~ msgid "ssh"
9741 #~ msgid "ssh_executable"
9744 #~ msgid ":envvar:`ANSIBLE_SSH_EXECUTABLE`"
9747 #~ msgid "ANSIBLE_SSH_RETRIES"
9750 #~ msgid "Number of attempts to establish a connection before we give up and report the host as 'UN…
9753 #~ msgid ":envvar:`ANSIBLE_SSH_RETRIES`"
9756 #~ msgid "DEFAULT_SCP_IF_SSH"
9759 #~ msgid "Preferred method to use when transferring files over ssh. When set to smart, Ansible will…
9762 #~ msgid "scp_if_ssh"
9765 #~ msgid ":envvar:`ANSIBLE_SCP_IF_SSH`"
9768 #~ msgid "DEFAULT_SFTP_BATCH_MODE"
9771 #~ msgid "sftp_batch_mode"
9774 #~ msgid ":envvar:`ANSIBLE_SFTP_BATCH_MODE`"
9777 #~ msgid "DEFAULT_SSH_TRANSFER_METHOD"
9780 #~ msgid "unused?"
9783 #~ msgid "transfer_method"
9786 #~ msgid ":envvar:`ANSIBLE_SSH_TRANSFER_METHOD`"
9789 #~ msgid "If set, this will override the Ansible default ssh arguments.In particular, users may wis…
9792 #~ msgid "See also :ref:`ANSIBLE_SSH_ARGS <ANSIBLE_SSH_ARGS>`"
9795 #~ msgid "This is the location to save ssh's ControlPath sockets, it uses ssh's variable substituti…
9798 #~ msgid "See also :ref:`ANSIBLE_SSH_CONTROL_PATH <ANSIBLE_SSH_CONTROL_PATH>`"
9801 #~ msgid "This sets the directory to use for ssh control path if the control path setting is null.A…
9804 #~ msgid "See also :ref:`ANSIBLE_SSH_CONTROL_PATH_DIR <ANSIBLE_SSH_CONTROL_PATH_DIR>`"
9807 #~ msgid "This defines the location of the ssh binary. It defaults to `ssh` which will use the firs…
9810 #~ msgid "See also :ref:`ANSIBLE_SSH_EXECUTABLE <ANSIBLE_SSH_EXECUTABLE>`"
9813 #~ msgid "See also :ref:`ANSIBLE_SSH_RETRIES <ANSIBLE_SSH_RETRIES>`"
9816 #~ msgid "Preferred method to use when transferring files over ssh.When set to smart, Ansible will …
9819 #~ msgid "See also :ref:`DEFAULT_SCP_IF_SSH <DEFAULT_SCP_IF_SSH>`"
9822 #~ msgid "See also :ref:`DEFAULT_SFTP_BATCH_MODE <DEFAULT_SFTP_BATCH_MODE>`"
9825 #~ msgid "See also :ref:`DEFAULT_SSH_TRANSFER_METHOD <DEFAULT_SSH_TRANSFER_METHOD>`"
9828 #~ msgid "This makes the temporary files created on the machine world-readable and will issue a war…
9831 #~ msgid "moved to a per plugin approach that is more flexible"
9834 #~ msgid "mostly the same config will work, but now controlled from the plugin itself and not using…
9837 #~ msgid "connection_facts_modules"
9840 #~ msgid ":envvar:`ANSIBLE_CONNECTION_FACTS_MODULES`"
9843 #~ msgid "See also :ref:`CONNECTION_FACTS_MODULES <CONNECTION_FACTS_MODULES>`"
9846 #~ msgid "New for 2.10. The installable package (RPM/Python/Deb package) generated from the `ansibl…
9849 #~ msgid "This section describes the Ansible and ``ansible-core`` releases. Ansible is the package …
9852 #~ msgid "Ansible release cycle"
9855 #~ msgid "Ansible is developed and released on a flexible release cycle. This cycle can be extended…
9858 #~ msgid "For Ansible version 2.10 or later, the major release is maintained for one release cycle.…
9861 #~ msgid "If you are using a release of Ansible that is no longer maintained, we strongly encourage…
9864 #~ msgid "Older, unmaintained versions of Ansible can contain unfixed security vulnerabilities (*CV…
9867 #~ msgid "You can refer to the :ref:`porting guides<porting_guides>` for tips on updating your Ansi…
9870 #~ msgid "This table links to the release notes for each major Ansible release. These release notes…
9873 #~ msgid "Ansible Release"
9876 #~ msgid "Status"
9879 #~ msgid "devel"
9882 #~ msgid "In development (2.11 unreleased, trunk)"
9885 #~ msgid "`2.10 Release Notes`_"
9888 #~ msgid "In development (2.10 alpha/beta)"
9891 #~ msgid "`2.9 Release Notes`_"
9894 #~ msgid "Maintained (security **and** general bug fixes)"
9897 #~ msgid "`2.8 Release Notes`_"
9900 #~ msgid "Maintained (security fixes)"
9903 #~ msgid "`2.7 Release Notes`_"
9906 #~ msgid "Unmaintained (end of life)"
9909 #~ msgid "`2.6 Release Notes`_"
9912 #~ msgid "`2.5 Release Notes`_"
9915 #~ msgid "<2.5"
9918 #~ msgid "ansible-core release cycle"
9921 #~ msgid "``ansible-core`` is developed and released on a flexible release cycle. This cycle can be…
9924 #~ msgid "``ansible-core`` has a graduated maintenance structure that extends to three major releas…
9927 #~ msgid "If you are using a release of ``ansible-core`` that is no longer maintained, we strongly …
9930 #~ msgid "Older, unmaintained versions of ``ansible-core`` can contain unfixed security vulnerabili…
9933 #~ msgid "You can refer to the :ref:`porting guides<porting_guides>` for tips on updating your Ansi…
9936 #~ msgid "You can install ``ansible-core`` with ``pip``. See :ref:`intro_installation_guide` for de…
9939 #~ msgid "``ansible-core`` maintenance continues for 3 releases.  Thus the latest release receives …
9942 #~ msgid "This table links to the release notes for each major ``ansible-core`` release. These rele…
9945 #~ msgid "``ansible-core`` / ``ansible-base`` Release"
9948 #~ msgid "In development (ansible-core 2.11 unreleased, trunk)"
9951 #~ msgid "`2.10 ansible-base Release Notes`_"
9954 #~ msgid "Development and stable version maintenance workflow"
9957 #~ msgid "The Ansible community develops and maintains Ansible and ``ansible-core`` on GitHub_."
9960 #~ msgid "Collection updates (new modules, plugins, features and bugfixes) will always be integrate…
9963 #~ msgid "Ansible and ``ansible-core`` provide bugfixes and security improvements for the most rece…
9966 #~ msgid "The fixes that land in maintained stable branches will eventually be released as a new ve…
9969 #~ msgid "Note that while there are no guarantees for providing fixes for unmaintained releases of …
9972 #~ msgid "Changelogs"
9975 #~ msgid "We generate changelogs based on fragments. Here is the generated changelog for 2.9_ as an…
9978 #~ msgid "We've got :ref:`examples and instructions on creating changelog fragments <changelogs_how…
9981 #~ msgid "Release candidates"
9984 #~ msgid "Before a new release or version of Ansible or ``ansible-core`` can be done, it will typic…
9987 #~ msgid "This provides the Ansible community the opportunity to test these releases and report bug…
9990 #~ msgid "Ansible and ``ansible-core`` tag the first release candidate (``RC1``) which is usually s…
9993 #~ msgid "If there are major problems with the first candidate, a second candidate will be tagged (…
9996 #~ msgid "More release candidates can be tagged as required, so long as there are bugs that the Ans…
9999 #~ msgid "Feature freeze"
10002 #~ msgid "While there is a pending release candidate, the focus of core developers and maintainers …
10005 #~ msgid "Merging new features or fixes that are not related to the release candidate may be delaye…
10008 #~ msgid "Deprecation Cycle"
10011 #~ msgid "Sometimes we need to remove a feature, normally in favor of a reimplementation that we ho…
10014 #~ msgid "Ansible deprecation cycle"
10017 #~ msgid "Since Ansible is a package of individual collections, the deprecation cycle depends on th…
10020 #~ msgid "ansible-core deprecation cycle"
10023 #~ msgid "The cycle is normally across 4 feature releases (2.x.y, where the x marks a feature relea…
10026 #~ msgid "For modules/plugins, we keep the documentation after the removal for users of older versi…
10029 #~ msgid "`irc.freenode.net <http://irc.freenode.net>`_"