2017-08-15 20:38:59 +00:00
# Copyright (c) 2017 Ansible Project
# GNU General Public License v3.0+ (see COPYING or https://www.gnu.org/licenses/gpl-3.0.txt)
---
2017-06-14 15:08:34 +00:00
ACCELERATE_CONNECT_TIMEOUT :
default : 1.0
2017-08-15 20:38:59 +00:00
description :
2017-06-14 15:08:34 +00:00
- This setting controls the timeout for the socket connect call, and should be kept relatively low.
The connection to the accelerate_port will be attempted 3 times before Ansible will fall back to ssh or paramiko
(depending on your default connection setting) to try and start the accelerate daemon remotely.
- Note, this value can be set to less than one second, however it is probably not a good idea to do so
unless you’ re on a very fast and reliable LAN. If you’ re connecting to systems over the internet, it may be necessary to increase this timeout.
env : [ {name : ACCELERATE_CONNECT_TIMEOUT }]
ini :
- {key: accelerate_connect_timeout, section : accelerate}
2017-08-15 20:38:59 +00:00
type : float
deprecated :
why : Removing accelerate as a connection method, settings not needed either.
version : "2.5"
alternatives : ssh and paramiko
2017-06-14 15:08:34 +00:00
version_added : "1.4"
ACCELERATE_DAEMON_TIMEOUT :
default : 30
2017-08-15 20:38:59 +00:00
description :
2017-06-14 15:08:34 +00:00
- This setting controls the timeout for the accelerated daemon, as measured in minutes. The default daemon timeout is 30 minutes.
- Prior to 1.6, the timeout was hard-coded from the time of the daemon’ s launch.
- For version 1.6+, the timeout is now based on the last activity to the daemon and is configurable via this option.
env : [ {name : ACCELERATE_DAEMON_TIMEOUT}]
ini :
- {key: accelerate_daemon_timeout, section : accelerate}
2017-08-15 20:38:59 +00:00
type : integer
deprecated :
why : Removing accelerate as a connection method, settings not needed either.
version : "2.5"
alternatives : ssh and paramiko
2017-06-14 15:08:34 +00:00
version_added : "1.6"
ACCELERATE_KEYS_DIR :
default : ~/.fireball.keys
2017-08-15 20:38:59 +00:00
description : ''
deprecated :
why : Removing accelerate as a connection method, settings not needed either.
version : "2.5"
alternatives : ssh and paramiko
2017-06-14 15:08:34 +00:00
env : [ {name : ACCELERATE_KEYS_DIR}]
ini :
- {key: accelerate_keys_dir, section : accelerate}
ACCELERATE_KEYS_DIR_PERMS :
default : '700'
2017-08-15 20:38:59 +00:00
description: 'TODO : write it'
2017-06-14 15:08:34 +00:00
env : [ {name : ACCELERATE_KEYS_DIR_PERMS}]
ini :
- {key: accelerate_keys_dir_perms, section : accelerate}
2017-08-15 20:38:59 +00:00
deprecated :
why : Removing accelerate as a connection method, settings not needed either.
version : "2.5"
alternatives : ssh and paramiko
2017-06-14 15:08:34 +00:00
ACCELERATE_KEYS_FILE_PERMS :
default : '600'
2017-08-15 20:38:59 +00:00
description: 'TODO : write it'
2017-06-14 15:08:34 +00:00
env : [ {name : ACCELERATE_KEYS_FILE_PERMS}]
ini :
- {key: accelerate_keys_file_perms, section : accelerate}
2017-08-15 20:38:59 +00:00
deprecated :
why : Removing accelerate as a connection method, settings not needed either.
version : "2.5"
alternatives : ssh and paramiko
2017-06-14 15:08:34 +00:00
ACCELERATE_MULTI_KEY :
default : False
2017-08-15 20:38:59 +00:00
description: 'TODO : write it'
2017-06-14 15:08:34 +00:00
env : [ {name : ACCELERATE_MULTI_KEY}]
ini :
- {key: accelerate_multi_key, section : accelerate}
2017-08-15 20:38:59 +00:00
type : boolean
deprecated :
why : Removing accelerate as a connection method, settings not needed either.
version : "2.5"
alternatives : ssh and paramiko
2017-06-14 15:08:34 +00:00
ACCELERATE_PORT :
default : 5099
2017-08-15 20:38:59 +00:00
description: 'TODO : write it'
2017-06-14 15:08:34 +00:00
env : [ {name : ACCELERATE_PORT}]
ini :
- {key: accelerate_port, section : accelerate}
2017-08-15 20:38:59 +00:00
type : integer
deprecated :
why : Removing accelerate as a connection method, settings not needed either.
version : "2.5"
alternatives : ssh and paramiko
2017-06-14 15:08:34 +00:00
ACCELERATE_TIMEOUT :
default : 30
2017-08-15 20:38:59 +00:00
description: 'TODO : write it'
2017-06-14 15:08:34 +00:00
env : [ {name : ACCELERATE_TIMEOUT}]
ini :
- {key: accelerate_timeout, section : accelerate}
2017-08-15 20:38:59 +00:00
type : integer
deprecated :
why : Removing accelerate as a connection method, settings not needed either.
version : "2.5"
alternatives : ssh and paramiko
2017-06-14 15:08:34 +00:00
ALLOW_WORLD_READABLE_TMPFILES :
default : False
2017-08-15 20:38:59 +00:00
description :
2017-07-07 00:21:53 +00:00
- This makes the temporary files created on the machine to be world readable and will issue a warning instead of failing the task.
- It is useful when becoming an unprivileged user.
2017-06-14 15:08:34 +00:00
env : [ ]
ini :
- {key: allow_world_readable_tmpfiles, section : defaults}
2017-08-15 20:38:59 +00:00
type : boolean
2017-06-14 15:08:34 +00:00
yaml : {key : defaults.allow_world_readable_tmpfiles}
2017-07-07 00:21:53 +00:00
version_added : "2.1"
2017-06-14 15:08:34 +00:00
ANSIBLE_COW_SELECTION :
default : default
2017-08-15 20:38:59 +00:00
description : This allows you to chose a specific cowsay stencil for the banners or use 'random' to cycle through them.
2017-06-14 15:08:34 +00:00
env : [ {name : ANSIBLE_COW_SELECTION}]
ini :
- {key: cow_selection, section : defaults}
yaml : {key : defaults.cow_selection}
ANSIBLE_COW_WHITELIST :
default : [ 'bud-frogs' , 'bunny' , 'cheese' , 'daemon' , 'default' , 'dragon' , 'elephant-in-snake' , 'elephant' , 'eyes' , 'hellokitty' , 'kitty' , 'luke-koala' , 'meow' , 'milk' , 'moofasa' , 'moose' , 'ren' , 'sheep' , 'small' , 'stegosaurus' , 'stimpy' , 'supermilker' , 'three-eyes' , 'turkey' , 'turtle' , 'tux' , 'udder' , 'vader-koala' , 'vader' , 'www' ]
2017-08-15 20:38:59 +00:00
description : White list of cowsay templates that are 'safe' to use, set to empty list if you want to enable all installed templates.
2017-06-14 15:08:34 +00:00
env : [ {name : ANSIBLE_COW_WHITELIST}]
ini :
- {key: cow_whitelist, section : defaults}
2017-08-15 20:38:59 +00:00
type : list
2017-06-14 15:08:34 +00:00
yaml : {key : defaults.cow_whitelist}
ANSIBLE_FORCE_COLOR :
2017-07-07 00:21:53 +00:00
default : False
2017-08-15 20:38:59 +00:00
description : This options forces color mode even when running without a TTY
2017-06-14 15:08:34 +00:00
env : [ {name : ANSIBLE_FORCE_COLOR}]
ini :
- {key: force_color, section : defaults}
2017-08-15 20:38:59 +00:00
type : boolean
2017-06-14 15:08:34 +00:00
yaml : {key : defaults.force_color}
ANSIBLE_NOCOLOR :
2017-07-07 00:21:53 +00:00
default : False
2017-08-15 20:38:59 +00:00
description : This setting allows suppressing colorizing output, which is used to give a better indication of failure and status information.
2017-06-14 15:08:34 +00:00
env : [ {name : ANSIBLE_NOCOLOR}]
ini :
- {key: nocolor, section : defaults}
2017-08-15 20:38:59 +00:00
type : boolean
2017-06-14 15:08:34 +00:00
yaml : {key : defaults.nocolor}
ANSIBLE_NOCOWS :
2017-07-07 00:21:53 +00:00
default : False
2017-08-15 20:38:59 +00:00
description : If you have cowsay installed but want to avoid the 'cows' (why????), use this.
2017-06-14 15:08:34 +00:00
env : [ {name : ANSIBLE_NOCOWS}]
ini :
- {key: nocows, section : defaults}
2017-08-15 20:38:59 +00:00
type : boolean
2017-06-14 15:08:34 +00:00
yaml : {key : defaults.nocows}
2017-08-15 20:38:59 +00:00
ANSIBLE_PIPELINING :
default : False
description :
- Pipelining, if supported by the connection plugin, reduces the number of network operations required to execute a module on the remote server,
by executing many Ansible modules without actual file transfer.
- This can result in a very significant performance improvement when enabled.
- However this conflicts with privilege escalation (become). For example, when using “sudo:” operations you must first
disable ‘ requiretty’ in /etc/sudoers on all managed hosts, which is why it is disabled by default.
env : [ {name : ANSIBLE_PIPELINING}]
ini :
- {key: pipelining, section : connection}
type : boolean
yaml : {key : plugins.connection.pipelining}
2017-06-14 15:08:34 +00:00
ANSIBLE_SSH_ARGS :
default : -C -o ControlMaster=auto -o ControlPersist=60s
2017-08-15 20:38:59 +00:00
description :
2017-07-07 00:21:53 +00:00
- If set, this will override the Ansible default ssh arguments.
- In particular, users may wish to raise the ControlPersist time to encourage performance. A value of 30 minutes may be appropriate.
- Be aware that if `-o ControlPath` is set in ssh_args, the control path setting is not used.
2017-06-14 15:08:34 +00:00
env : [ {name : ANSIBLE_SSH_ARGS}]
ini :
- {key: ssh_args, section : ssh_connection}
yaml : {key : ssh_connection.ssh_args}
ANSIBLE_SSH_CONTROL_PATH :
2017-08-15 20:38:59 +00:00
# TODO: move to ssh plugin
2017-07-07 00:21:53 +00:00
default : null
2017-08-15 20:38:59 +00:00
description :
2017-07-07 00:21:53 +00:00
- This is the location to save ssh's ControlPath sockets, it uses ssh's variable substitution.
- Since 2.3, if null, ansible will generate a unique hash. Use `%(directory)s` to indicate where to use the control dir path setting.
- Before 2.3 it defaulted to `control_path=%(directory)s/ansible-ssh-%%h-%%p-%%r`.
- Be aware that this setting is ignored if `-o ControlPath` is set in ssh args.
2017-06-14 15:08:34 +00:00
env : [ {name : ANSIBLE_SSH_CONTROL_PATH}]
ini :
- {key: control_path, section : ssh_connection}
yaml : {key : ssh_connection.control_path}
ANSIBLE_SSH_CONTROL_PATH_DIR :
2017-08-15 20:38:59 +00:00
# TODO: move to ssh plugin
2017-06-14 15:08:34 +00:00
default : ~/.ansible/cp
2017-08-15 20:38:59 +00:00
description :
2017-07-07 00:21:53 +00:00
- This sets the directory to use for ssh control path if the control path setting is null.
- Also, provides the `%(directory)s` variable for the control path setting.
2017-06-14 15:08:34 +00:00
env : [ {name : ANSIBLE_SSH_CONTROL_PATH_DIR}]
ini :
- {key: control_path_dir, section : ssh_connection}
yaml : {key : ssh_connection.control_path_dir}
ANSIBLE_SSH_EXECUTABLE :
default : ssh
2017-08-15 20:38:59 +00:00
description :
2017-07-07 00:21:53 +00:00
- This defines the location of the ssh binary. It defaults to `ssh` which will use the first ssh binary available in $PATH.
- This option is usually not required, it might be useful when access to system ssh is restricted,
or when using ssh wrappers to connect to remote hosts.
2017-06-14 15:08:34 +00:00
env : [ {name : ANSIBLE_SSH_EXECUTABLE}]
ini :
- {key: ssh_executable, section : ssh_connection}
yaml : {key : ssh_connection.ssh_executable}
2017-07-07 00:21:53 +00:00
version_added : "2.2"
2017-06-14 15:08:34 +00:00
ANSIBLE_SSH_PIPELINING :
default : False
2017-08-15 20:38:59 +00:00
description :
2017-07-07 00:21:53 +00:00
- Pipelining reduces the number of SSH operations required to execute a module on the remote server,
by executing many Ansible modules without actual file transfer.
- This can result in a very significant performance improvement when enabled.
- However this conflicts with privilege escalation (become). For example, when using “sudo:” operations you must first disable ‘ requiretty’ in /etc/sudoers on all managed hosts, which is why it is disabled by default.
2017-06-14 15:08:34 +00:00
env : [ {name : ANSIBLE_SSH_PIPELINING}]
ini :
- {key: pipelining, section : ssh_connection}
2017-08-15 20:38:59 +00:00
type : boolean
2017-06-14 15:08:34 +00:00
yaml : {key : ssh_connection.pipelining}
ANSIBLE_SSH_RETRIES :
default : 0
2017-08-15 20:38:59 +00:00
description: 'TODO : write it'
2017-06-14 15:08:34 +00:00
env : [ {name : ANSIBLE_SSH_RETRIES}]
ini :
- {key: retries, section : ssh_connection}
2017-08-15 20:38:59 +00:00
type : integer
2017-06-14 15:08:34 +00:00
yaml : {key : ssh_connection.retries}
2017-05-10 22:08:42 +00:00
ANY_ERRORS_FATAL :
2017-07-11 23:43:48 +00:00
default : False
2017-08-15 20:38:59 +00:00
description : Sets the default value for the any_errors_fatal keyword
2017-07-11 23:43:48 +00:00
env :
- name : ANSIBLE_ANY_ERRORS_FATAL
ini :
- section : defaults
key : any_errors_fatal
2017-08-15 20:38:59 +00:00
type : boolean
2017-07-11 23:43:48 +00:00
yaml : {key : errors.anyerrors_fatal}
version_added : "2.4"
2017-06-14 15:08:34 +00:00
BECOME_ALLOW_SAME_USER :
default : False
2017-08-15 20:38:59 +00:00
description : This setting controls if become is skipped when remote user and become user are the same.
2017-06-14 15:08:34 +00:00
env : [ {name : ANSIBLE_BECOME_ALLOW_SAME_USER}]
ini :
- {key: become_allow_same_user, section : privilege_escalation}
2017-08-15 20:38:59 +00:00
type : boolean
2017-06-14 15:08:34 +00:00
yaml : {key : privilege_escalation.become_allow_same_user}
CACHE_PLUGIN :
default : memory
2017-08-15 20:38:59 +00:00
description : Chooses which cache plugin to use
2017-06-14 15:08:34 +00:00
env : [ {name : ANSIBLE_CACHE_PLUGIN}]
ini :
- {key: fact_caching, section : defaults}
yaml : {key : defaults.fact_caching}
CACHE_PLUGIN_CONNECTION :
2017-07-11 23:43:48 +00:00
default :
2017-08-15 20:38:59 +00:00
description : Defines connection or path information for the cache plugin
2017-06-14 15:08:34 +00:00
env : [ {name : ANSIBLE_CACHE_PLUGIN_CONNECTION}]
ini :
- {key: fact_caching_connection, section : defaults}
yaml : {key : defaults.fact_caching_connection}
CACHE_PLUGIN_PREFIX :
default : ansible_facts
2017-08-15 20:38:59 +00:00
description : Prefix to use for cache plugin files/tables
2017-06-14 15:08:34 +00:00
env : [ {name : ANSIBLE_CACHE_PLUGIN_PREFIX}]
ini :
- {key: fact_caching_prefix, section : defaults}
yaml : {key : defaults.fact_caching_prefix}
CACHE_PLUGIN_TIMEOUT :
default : 86400
2017-08-15 20:38:59 +00:00
description : Expiration timeout for the cache plugin data
2017-06-14 15:08:34 +00:00
env : [ {name : ANSIBLE_CACHE_PLUGIN_TIMEOUT}]
ini :
- {key: fact_caching_timeout, section : defaults}
2017-08-15 20:38:59 +00:00
type : integer
2017-06-14 15:08:34 +00:00
yaml : {key : defaults.fact_caching_timeout}
COLOR_CHANGED :
default : yellow
2017-08-15 20:38:59 +00:00
description : Defines the color to use on 'Changed' status
2017-06-14 15:08:34 +00:00
env : [ {name : ANSIBLE_COLOR_CHANGED}]
ini :
- {key: changed, section : colors}
2017-07-11 23:43:48 +00:00
yaml : {key : display.colors.changed}
2017-06-14 15:08:34 +00:00
COLOR_DEBUG :
default : dark gray
2017-08-15 20:38:59 +00:00
description : Defines the color to use when emitting debug messages
2017-06-14 15:08:34 +00:00
env : [ {name : ANSIBLE_COLOR_DEBUG}]
ini :
- {key: debug, section : colors}
yaml : {key : colors.debug}
COLOR_DEPRECATE :
default : purple
2017-08-15 20:38:59 +00:00
description : Defines the color to use when emitting deprecation messages
2017-06-14 15:08:34 +00:00
env : [ {name : ANSIBLE_COLOR_DEPRECATE}]
ini :
- {key: deprecate, section : colors}
yaml : {key : colors.deprecate}
COLOR_DIFF_ADD :
default : green
2017-08-15 20:38:59 +00:00
description : Defines the color to use when showing added lines in diffs
2017-06-14 15:08:34 +00:00
env : [ {name : ANSIBLE_COLOR_DIFF_ADD}]
ini :
- {key: diff_add, section : colors}
yaml : {key : colors.diff_add}
COLOR_DIFF_LINES :
default : cyan
2017-08-15 20:38:59 +00:00
description : Defines the color to use when showing diffs
2017-06-14 15:08:34 +00:00
env : [ {name : ANSIBLE_COLOR_DIFF_LINES}]
ini :
- {key: diff_lines, section : colors}
yaml : {key : colors.diff_lines}
COLOR_DIFF_REMOVE :
default : red
2017-08-15 20:38:59 +00:00
description : Defines the color to use when showing removed lines in diffs
2017-06-14 15:08:34 +00:00
env : [ {name : ANSIBLE_COLOR_DIFF_REMOVE}]
ini :
- {key: diff_remove, section : colors}
yaml : {key : colors.diff_remove}
COLOR_ERROR :
default : red
2017-08-15 20:38:59 +00:00
description : Defines the color to use when emitting error messages
2017-06-14 15:08:34 +00:00
env : [ {name : ANSIBLE_COLOR_ERROR}]
ini :
- {key: error, section : colors}
yaml : {key : colors.error}
COLOR_HIGHLIGHT :
default : white
2017-08-15 20:38:59 +00:00
description: 'TODO : write it'
2017-06-14 15:08:34 +00:00
env : [ {name : ANSIBLE_COLOR_HIGHLIGHT}]
ini :
- {key: highlight, section : colors}
yaml : {key : colors.highlight}
COLOR_OK :
default : green
2017-08-15 20:38:59 +00:00
description : Defines the color to use when showing 'OK' status
2017-06-14 15:08:34 +00:00
env : [ {name : ANSIBLE_COLOR_OK}]
ini :
- {key: ok, section : colors}
yaml : {key : colors.ok}
COLOR_SKIP :
default : cyan
2017-08-15 20:38:59 +00:00
description : Defines the color to use when showing 'Skipped' status
2017-06-14 15:08:34 +00:00
env : [ {name : ANSIBLE_COLOR_SKIP}]
ini :
- {key: skip, section : colors}
yaml : {key : colors.skip}
COLOR_UNREACHABLE :
default : bright red
2017-08-15 20:38:59 +00:00
description : Defines the color to use on 'Unreachable' status
2017-06-14 15:08:34 +00:00
env : [ {name : ANSIBLE_COLOR_UNREACHABLE}]
ini :
- {key: unreachable, section : colors}
yaml : {key : colors.unreachable}
COLOR_VERBOSE :
default : blue
2017-08-15 20:38:59 +00:00
description : Defines the color to use when emitting verbose messages
2017-06-14 15:08:34 +00:00
env : [ {name : ANSIBLE_COLOR_VERBOSE}]
ini :
- {key: verbose, section : colors}
yaml : {key : colors.verbose}
COLOR_WARN :
default : bright purple
2017-08-15 20:38:59 +00:00
description : Defines the color to use when emitting warning messages
2017-06-14 15:08:34 +00:00
env : [ {name : ANSIBLE_COLOR_WARN}]
ini :
- {key: warn, section : colors}
yaml : {key : colors.warn}
COMMAND_WARNINGS :
default : True
2017-08-15 20:38:59 +00:00
description: 'TODO : write it'
2017-06-14 15:08:34 +00:00
env : [ {name : ANSIBLE_COMMAND_WARNINGS}]
ini :
- {key: command_warnings, section : defaults}
2017-08-15 20:38:59 +00:00
type : boolean
2017-06-14 15:08:34 +00:00
yaml : {key : defaults.command_warnings}
DEFAULT_ACTION_PLUGIN_PATH :
default : ~/.ansible/plugins/action:/usr/share/ansible/plugins/action
2017-08-15 20:38:59 +00:00
description : Colon separated paths in which Ansible will search for Action Plugins.
2017-06-14 15:08:34 +00:00
env : [ {name : ANSIBLE_ACTION_PLUGINS}]
ini :
- {key: action_plugins, section : defaults}
2017-08-15 20:38:59 +00:00
type : pathlist
2017-06-14 15:08:34 +00:00
yaml : {key : defaults.action_plugins}
DEFAULT_ALLOW_UNSAFE_LOOKUPS :
default : False
2017-08-15 20:38:59 +00:00
description: 'TODO : write it'
2017-06-14 15:08:34 +00:00
env : [ ]
ini :
- {key: allow_unsafe_lookups, section : defaults}
2017-08-15 20:38:59 +00:00
type : boolean
2017-06-14 15:08:34 +00:00
yaml : {key : defaults.allow_unsafe_lookups}
DEFAULT_ASK_PASS :
default : False
2017-08-15 20:38:59 +00:00
description: 'TODO : write it'
2017-06-14 15:08:34 +00:00
env : [ {name : ANSIBLE_ASK_PASS}]
ini :
- {key: ask_pass, section : defaults}
2017-08-15 20:38:59 +00:00
type : boolean
2017-06-14 15:08:34 +00:00
yaml : {key : defaults.ask_pass}
DEFAULT_ASK_SUDO_PASS :
default : False
2017-08-15 20:38:59 +00:00
deprecated :
why : In favor of become which is a generic framework
version : "2.8"
alternatives : become
description: 'TODO : write it'
2017-06-14 15:08:34 +00:00
env : [ {name : ANSIBLE_ASK_SUDO_PASS}]
ini :
- {key: ask_sudo_pass, section : defaults}
2017-08-15 20:38:59 +00:00
type : boolean
2017-06-14 15:08:34 +00:00
DEFAULT_ASK_SU_PASS :
default : False
2017-08-15 20:38:59 +00:00
deprecated :
why : In favor of become which is a generic framework
version : "2.8"
alternatives : become
description: 'TODO : write it'
2017-06-14 15:08:34 +00:00
env : [ {name : ANSIBLE_ASK_SU_PASS}]
ini :
- {key: ask_su_pass, section : defaults}
2017-08-15 20:38:59 +00:00
type : boolean
2017-06-14 15:08:34 +00:00
DEFAULT_ASK_VAULT_PASS :
default : False
2017-08-15 20:38:59 +00:00
description: 'TODO : write it'
2017-06-14 15:08:34 +00:00
env : [ {name : ANSIBLE_ASK_VAULT_PASS}]
ini :
- {key: ask_vault_pass, section : defaults}
2017-08-15 20:38:59 +00:00
type : boolean
2017-06-14 15:08:34 +00:00
yaml : {key : defaults.ask_vault_pass}
DEFAULT_BECOME :
default : False
2017-08-15 20:38:59 +00:00
description : Toggles the use of privilege escalation, allowing you to 'become' another user after login.
2017-06-14 15:08:34 +00:00
env : [ {name : ANSIBLE_BECOME}]
ini :
- {key: become, section : privilege_escalation}
2017-08-15 20:38:59 +00:00
type : boolean
2017-06-14 15:08:34 +00:00
yaml : {key : privilege_escalation.become}
DEFAULT_BECOME_ASK_PASS :
default : False
2017-08-15 20:38:59 +00:00
description : Toggle to prompt for privilege escalation password.
2017-06-14 15:08:34 +00:00
env : [ {name : ANSIBLE_BECOME_ASK_PASS}]
ini :
- {key: become_ask_pass, section : privilege_escalation}
2017-08-15 20:38:59 +00:00
type : boolean
2017-06-14 15:08:34 +00:00
yaml : {key : privilege_escalation.become_ask_pass}
2017-08-15 20:38:59 +00:00
DEFAULT_BECOME_METHOD :
default : 'sudo'
description : Privilege escalation method to use when `become` is enabled.
env : [ {name : ANSIBLE_BECOME_METHOD}]
ini :
- {section: privilege_escalation, key : become_method}
yaml : {key : privilege_escalation.become_method}
2017-06-14 15:08:34 +00:00
DEFAULT_BECOME_EXE :
2017-08-15 20:38:59 +00:00
default : ~
description : 'executable to use for privilege escalation, otherwise Ansible will depend on PATh'
2017-06-14 15:08:34 +00:00
env : [ {name : ANSIBLE_BECOME_EXE}]
ini :
- {key: become_exe, section : privilege_escalation}
yaml : {key : privilege_escalation.become_exe}
DEFAULT_BECOME_FLAGS :
2017-08-15 20:38:59 +00:00
default : ~
description : Flags to pass to the privilege escalation executable.
2017-06-14 15:08:34 +00:00
env : [ {name : ANSIBLE_BECOME_FLAGS}]
ini :
- {key: become_flags, section : privilege_escalation}
yaml : {key : privilege_escalation.become_flags}
DEFAULT_BECOME_USER :
default : root
2017-08-15 20:38:59 +00:00
description : User your become when using privilege escalation, most systems will use 'root' when no user is specified.
2017-06-14 15:08:34 +00:00
env : [ {name : ANSIBLE_BECOME_USER}]
ini :
- {key: become_user, section : privilege_escalation}
yaml : {key : privilege_escalation.become_user}
DEFAULT_CACHE_PLUGIN_PATH :
default : ~/.ansible/plugins/cache:/usr/share/ansible/plugins/cache
2017-08-15 20:38:59 +00:00
description: 'TODO : write it'
2017-06-14 15:08:34 +00:00
env : [ {name : ANSIBLE_CACHE_PLUGINS}]
ini :
- {key: cache_plugins, section : defaults}
2017-08-15 20:38:59 +00:00
type : pathlist
2017-06-14 15:08:34 +00:00
yaml : {key : defaults.cache_plugins}
DEFAULT_CALLABLE_WHITELIST :
default : [ ]
2017-08-15 20:38:59 +00:00
description: 'TODO : write it'
2017-06-14 15:08:34 +00:00
env : [ {name : ANSIBLE_CALLABLE_WHITELIST}]
ini :
- {key: callable_whitelist, section : defaults}
2017-08-15 20:38:59 +00:00
type : list
2017-06-14 15:08:34 +00:00
yaml : {key : defaults.callable_whitelist}
DEFAULT_CALLBACK_PLUGIN_PATH :
default : ~/.ansible/plugins/callback:/usr/share/ansible/plugins/callback
2017-08-15 20:38:59 +00:00
description: 'TODO : write it'
2017-06-14 15:08:34 +00:00
env : [ {name : ANSIBLE_CALLBACK_PLUGINS}]
ini :
- {key: callback_plugins, section : defaults}
2017-08-15 20:38:59 +00:00
type : pathlist
2017-06-14 15:08:34 +00:00
yaml : {key : defaults.callback_plugins}
DEFAULT_CALLBACK_WHITELIST :
default : [ ]
2017-08-15 20:38:59 +00:00
description: 'TODO : write it'
2017-06-14 15:08:34 +00:00
env : [ {name : ANSIBLE_CALLBACK_WHITELIST}]
ini :
- {key: callback_whitelist, section : defaults}
2017-08-15 20:38:59 +00:00
type : list
2017-06-14 15:08:34 +00:00
yaml : {key : defaults.callback_whitelist}
DEFAULT_CONNECTION_PLUGIN_PATH :
default : ~/.ansible/plugins/connection:/usr/share/ansible/plugins/connection
2017-08-15 20:38:59 +00:00
description: 'TODO : write it'
2017-06-14 15:08:34 +00:00
env : [ {name : ANSIBLE_CONNECTION_PLUGINS}]
ini :
- {key: connection_plugins, section : defaults}
2017-08-15 20:38:59 +00:00
type : pathlist
2017-06-14 15:08:34 +00:00
yaml : {key : defaults.connection_plugins}
DEFAULT_DEBUG :
default : False
2017-08-15 20:38:59 +00:00
description : Toggles debug output in Ansible, VERY verbose and can hinder multiprocessing.
2017-06-14 15:08:34 +00:00
env : [ {name : ANSIBLE_DEBUG}]
ini :
- {key: debug, section : defaults}
2017-08-15 20:38:59 +00:00
type : boolean
2017-06-14 15:08:34 +00:00
yaml : {key : defaults.debug}
DEFAULT_EXECUTABLE :
default : /bin/sh
2017-08-15 20:38:59 +00:00
description: 'TODO : write it'
2017-06-14 15:08:34 +00:00
env : [ {name : ANSIBLE_EXECUTABLE}]
ini :
- {key: executable, section : defaults}
yaml : {key : defaults.executable}
DEFAULT_FACT_PATH :
2017-07-18 01:23:38 +00:00
default :
2017-08-15 20:38:59 +00:00
description: 'TODO : write it'
2017-06-14 15:08:34 +00:00
env : [ {name : ANSIBLE_FACT_PATH}]
ini :
- {key: fact_path, section : defaults}
2017-08-15 20:38:59 +00:00
type : path
2017-06-14 15:08:34 +00:00
yaml : {key : defaults.fact_path}
DEFAULT_FILTER_PLUGIN_PATH :
default : ~/.ansible/plugins/filter:/usr/share/ansible/plugins/filter
2017-08-15 20:38:59 +00:00
description: 'TODO : write it'
2017-06-14 15:08:34 +00:00
env : [ {name : ANSIBLE_FILTER_PLUGINS}]
ini :
- {key: filter_plugins, section : defaults}
2017-08-15 20:38:59 +00:00
type : pathlist
2017-06-14 15:08:34 +00:00
yaml : {key : defaults.filter_plugins}
DEFAULT_FORCE_HANDLERS :
default : False
2017-08-15 20:38:59 +00:00
description: 'TODO : write it'
2017-06-14 15:08:34 +00:00
env : [ {name : ANSIBLE_FORCE_HANDLERS}]
ini :
- {key: force_handlers, section : defaults}
2017-08-15 20:38:59 +00:00
type : boolean
2017-06-14 15:08:34 +00:00
yaml : {key : defaults.force_handlers}
DEFAULT_FORKS :
default : 5
2017-08-15 20:38:59 +00:00
description : Maximum number of forks Ansible will use to execute tasks on target hosts.
2017-06-14 15:08:34 +00:00
env : [ {name : ANSIBLE_FORKS}]
ini :
- {key: forks, section : defaults}
2017-08-15 20:38:59 +00:00
type : integer
2017-06-14 15:08:34 +00:00
yaml : {key : defaults.forks}
DEFAULT_GATHERING :
default : 'implicit'
2017-08-15 20:38:59 +00:00
description: 'TODO : write it'
2017-06-14 15:08:34 +00:00
env : [ {name : ANSIBLE_GATHERING}]
ini :
- key : gathering
section : defaults
yaml : {key : defaults.gathering}
DEFAULT_GATHER_SUBSET :
default : 'all'
2017-08-15 20:38:59 +00:00
description: 'TODO : write it'
2017-06-14 15:08:34 +00:00
env : [ {name : ANSIBLE_GATHER_SUBSET}]
ini :
- key : gather_subset
section : defaults
yaml : {key : defaults.gather_subset}
DEFAULT_GATHER_TIMEOUT :
default : 10
2017-08-15 20:38:59 +00:00
description: 'TODO : write it'
2017-06-14 15:08:34 +00:00
env : [ {name : ANSIBLE_GATHER_TIMEOUT}]
ini :
- {key: gather_timeout, section : defaults}
2017-08-15 20:38:59 +00:00
type : integer
2017-06-14 15:08:34 +00:00
yaml : {key : defaults.gather_timeout}
DEFAULT_HANDLER_INCLUDES_STATIC :
default : False
2017-08-15 20:38:59 +00:00
description: 'TODO : write it'
2017-06-14 15:08:34 +00:00
env : [ {name : ANSIBLE_HANDLER_INCLUDES_STATIC}]
ini :
- {key: handler_includes_static, section : defaults}
2017-08-15 20:38:59 +00:00
type : boolean
2017-06-14 15:08:34 +00:00
yaml : {key : defaults.handler_includes_static}
2017-08-15 20:38:59 +00:00
deprecated :
why : include itself is deprecated and this setting will not matter in the future
version : "2.8"
alternatives : none as its already built into the decision between include_tasks and import_tasks
2017-06-14 15:08:34 +00:00
DEFAULT_HASH_BEHAVIOUR :
default : replace
2017-08-15 20:38:59 +00:00
description: 'TODO : write it'
2017-06-14 15:08:34 +00:00
env : [ {name : ANSIBLE_HASH_BEHAVIOUR}]
ini :
- {key: hash_behaviour, section : defaults}
yaml : {key : defaults.hash_behaviour}
DEFAULT_HOST_LIST :
default : /etc/ansible/hosts
2017-08-15 20:38:59 +00:00
description : Location of the Ansible inventory source.
2017-06-14 15:08:34 +00:00
env : [ {name : ANSIBLE_INVENTORY}]
expand_relative_paths : True
ini :
- {key: inventory, section : defaults}
2017-08-15 20:38:59 +00:00
type : path
2017-06-14 15:08:34 +00:00
yaml : {key : defaults.inventory}
DEFAULT_INTERNAL_POLL_INTERVAL :
default : 0.001
2017-08-15 20:38:59 +00:00
description: 'TODO : write it'
2017-06-14 15:08:34 +00:00
env : [ ]
ini :
- {key: internal_poll_interval, section : defaults}
2017-08-15 20:38:59 +00:00
type : float
2017-06-14 15:08:34 +00:00
yaml : {key : defaults.internal_poll_interval}
DEFAULT_INVENTORY_PLUGIN_PATH :
default : ~/.ansible/plugins/inventory:/usr/share/ansible/plugins/inventory
2017-08-15 20:38:59 +00:00
description: 'TODO : write it'
2017-06-14 15:08:34 +00:00
env : [ {name : ANSIBLE_INVENTORY_PLUGINS}]
ini :
- {key: inventory_plugins, section : defaults}
2017-08-15 20:38:59 +00:00
type : pathlist
2017-06-14 15:08:34 +00:00
yaml : {key : defaults.inventory_plugins}
DEFAULT_JINJA2_EXTENSIONS :
2017-07-18 01:23:38 +00:00
default :
2017-08-15 20:38:59 +00:00
description: 'TODO : write it'
2017-06-14 15:08:34 +00:00
env : [ {name : ANSIBLE_JINJA2_EXTENSIONS}]
ini :
- {key: jinja2_extensions, section : defaults}
yaml : {key : defaults.jinja2_extensions}
DEFAULT_KEEP_REMOTE_FILES :
default : False
2017-08-15 20:38:59 +00:00
description : Enables/disables the cleaning up of the temporary files Ansible used to execute the tasks on the remote.
2017-06-14 15:08:34 +00:00
env : [ {name : ANSIBLE_KEEP_REMOTE_FILES}]
ini :
- {key: keep_remote_files, section : defaults}
2017-08-15 20:38:59 +00:00
type : boolean
2017-06-14 15:08:34 +00:00
yaml : {key : defaults.keep_remote_files}
DEFAULT_LIBVIRT_LXC_NOSECLABEL :
default : False
2017-08-15 20:38:59 +00:00
description: 'TODO : write it'
2017-06-14 15:08:34 +00:00
env : [ {name : LIBVIRT_LXC_NOSECLABEL}]
ini :
- {key: libvirt_lxc_noseclabel, section : selinux}
2017-08-15 20:38:59 +00:00
type : boolean
2017-06-14 15:08:34 +00:00
yaml : {key : selinux.libvirt_lxc_noseclabel}
DEFAULT_LOAD_CALLBACK_PLUGINS :
default : False
2017-08-15 20:38:59 +00:00
description: 'TODO : write it'
2017-06-14 15:08:34 +00:00
env : [ {name : ANSIBLE_LOAD_CALLBACK_PLUGINS}]
ini :
- {key: bin_ansible_callbacks, section : defaults}
2017-08-15 20:38:59 +00:00
type : boolean
2017-06-14 15:08:34 +00:00
yaml : {key : defaults.bin_ansible_callbacks}
DEFAULT_LOCAL_TMP :
default : ~/.ansible/tmp
2017-08-15 20:38:59 +00:00
description : Temporary directory for Ansible to use on the controller.
2017-06-14 15:08:34 +00:00
env : [ {name : ANSIBLE_LOCAL_TEMP}]
ini :
- {key: local_tmp, section : defaults}
2017-08-15 20:38:59 +00:00
type : tmppath
2017-06-14 15:08:34 +00:00
yaml : {key : defaults.local_tmp}
DEFAULT_LOG_PATH :
default : ''
2017-08-15 20:38:59 +00:00
description : File to which Ansible will log on the controller. When empty logging is disabled.
2017-06-14 15:08:34 +00:00
env : [ {name : ANSIBLE_LOG_PATH}]
ini :
- {key: log_path, section : defaults}
2017-08-15 20:38:59 +00:00
type : path
2017-06-14 15:08:34 +00:00
yaml : {key : defaults.log_path}
DEFAULT_LOOKUP_PLUGIN_PATH :
default : ~/.ansible/plugins/lookup:/usr/share/ansible/plugins/lookup
2017-08-15 20:38:59 +00:00
description: 'TODO : write it'
2017-06-14 15:08:34 +00:00
env : [ {name : ANSIBLE_LOOKUP_PLUGINS}]
ini :
- {key: lookup_plugins, section : defaults}
2017-08-15 20:38:59 +00:00
type : pathlist
2017-06-14 15:08:34 +00:00
yaml : {key : defaults.lookup_plugins}
DEFAULT_MANAGED_STR :
default : Ansible managed
2017-08-15 20:38:59 +00:00
description : Sets the macro for the 'ansible_managed' variable available for 'tempalte' tasks.
2017-06-14 15:08:34 +00:00
env : [ ]
ini :
- {key: ansible_managed, section : defaults}
yaml : {key : defaults.ansible_managed}
DEFAULT_MODULE_ARGS :
default : ''
2017-08-15 20:38:59 +00:00
description: 'TODO : write it'
2017-06-14 15:08:34 +00:00
env : [ {name : ANSIBLE_MODULE_ARGS}]
ini :
- {key: module_args, section : defaults}
yaml : {key : defaults.module_args}
DEFAULT_MODULE_COMPRESSION :
default : ZIP_DEFLATED
2017-08-15 20:38:59 +00:00
description: 'TODO : write it'
2017-06-14 15:08:34 +00:00
env : [ ]
ini :
- {key: module_compression, section : defaults}
yaml : {key : defaults.module_compression}
DEFAULT_MODULE_LANG :
2017-08-15 20:38:59 +00:00
# TODO: allow setting to function: os.getenv('LANG', 'en_US.UTF-8')
default : eval(os.getenv('LANG', 'en_US.UTF-8'))
description : "Language locale setting to use for modules when they execute on the target, if empty it defaults to 'en_US.UTF-8'"
2017-06-14 15:08:34 +00:00
env : [ {name : ANSIBLE_MODULE_LANG}]
ini :
- {key: module_lang, section : defaults}
yaml : {key : defaults.module_lang}
DEFAULT_MODULE_NAME :
default : command
2017-08-15 20:38:59 +00:00
description : Module to use with the `ansible` AdHoc command, if none is specified.
2017-06-14 15:08:34 +00:00
env : [ ]
ini :
- {key: module_name, section : defaults}
yaml : {key : defaults.module_name}
DEFAULT_MODULE_PATH :
default : ~/.ansible/plugins/modules:/usr/share/ansible/plugins/modules
2017-08-15 20:38:59 +00:00
description: 'TODO : write it'
2017-06-14 15:08:34 +00:00
env : [ {name : ANSIBLE_LIBRARY}]
ini :
- {key: library, section : defaults}
2017-08-15 20:38:59 +00:00
type : pathlist
2017-06-14 15:08:34 +00:00
yaml : {key : defaults.library}
DEFAULT_MODULE_SET_LOCALE :
default : False
2017-08-15 20:38:59 +00:00
description : Controls if we set locale for modules when executing on the target.
2017-06-14 15:08:34 +00:00
env : [ {name : ANSIBLE_MODULE_SET_LOCALE}]
ini :
- {key: module_set_locale, section : defaults}
2017-08-15 20:38:59 +00:00
type : boolean
2017-06-14 15:08:34 +00:00
yaml : {key : defaults.module_set_locale}
DEFAULT_MODULE_UTILS_PATH :
default : ~/.ansible/plugins/module_utils:/usr/share/ansible/plugins/module_utils
2017-08-15 20:38:59 +00:00
description: 'TODO : write it'
2017-06-14 15:08:34 +00:00
env : [ {name : ANSIBLE_MODULE_UTILS}]
ini :
- {key: module_utils, section : defaults}
2017-08-15 20:38:59 +00:00
type : pathlist
2017-06-14 15:08:34 +00:00
yaml : {key : defaults.module_utils}
DEFAULT_NO_LOG :
default : False
2017-08-15 20:38:59 +00:00
description : Toggle Ansible's display and logging of task details, mainly used to avoid security disclosures.
2017-06-14 15:08:34 +00:00
env : [ {name : ANSIBLE_NO_LOG}]
ini :
- {key: no_log, section : defaults}
2017-08-15 20:38:59 +00:00
type : boolean
2017-06-14 15:08:34 +00:00
yaml : {key : defaults.no_log}
DEFAULT_NO_TARGET_SYSLOG :
default : False
2017-08-15 20:38:59 +00:00
description : Toggle Ansbile logging to syslog on the target when it executes tasks.
2017-06-14 15:08:34 +00:00
env : [ {name : ANSIBLE_NO_TARGET_SYSLOG}]
ini :
- {key: no_target_syslog, section : defaults}
2017-08-15 20:38:59 +00:00
type : boolean
2017-06-14 15:08:34 +00:00
yaml : {key : defaults.no_target_syslog}
DEFAULT_NULL_REPRESENTATION :
2017-07-18 01:23:38 +00:00
default :
2017-08-15 20:38:59 +00:00
description: 'TODO : write it'
2017-06-14 15:08:34 +00:00
env : [ {name : ANSIBLE_NULL_REPRESENTATION}]
ini :
- {key: null_representation, section : defaults}
2017-08-15 20:38:59 +00:00
type : none
2017-06-14 15:08:34 +00:00
yaml : {key : defaults.null_representation}
DEFAULT_POLL_INTERVAL :
default : 15
2017-08-15 20:38:59 +00:00
description: 'TODO : write it'
2017-06-14 15:08:34 +00:00
env : [ {name : ANSIBLE_POLL_INTERVAL}]
ini :
- {key: poll_interval, section : defaults}
2017-08-15 20:38:59 +00:00
type : integer
2017-06-14 15:08:34 +00:00
yaml : {key : defaults.poll_interval}
DEFAULT_PRIVATE_KEY_FILE :
2017-07-18 01:23:38 +00:00
default :
2017-08-15 20:38:59 +00:00
description: 'TODO : write it'
2017-06-14 15:08:34 +00:00
env : [ {name : ANSIBLE_PRIVATE_KEY_FILE}]
ini :
- {key: private_key_file, section : defaults}
2017-08-15 20:38:59 +00:00
type : path
2017-06-14 15:08:34 +00:00
yaml : {key : defaults.private_key_file}
DEFAULT_PRIVATE_ROLE_VARS :
default : False
2017-08-15 20:38:59 +00:00
description: 'TODO : write it'
2017-06-14 15:08:34 +00:00
env : [ {name : ANSIBLE_PRIVATE_ROLE_VARS}]
ini :
- {key: private_role_vars, section : defaults}
2017-08-15 20:38:59 +00:00
type : boolean
2017-06-14 15:08:34 +00:00
yaml : {key : defaults.private_role_vars}
DEFAULT_REMOTE_PORT :
2017-07-18 01:23:38 +00:00
default :
2017-08-15 20:38:59 +00:00
description : Port to use in remote connections, when blank it will use the connection plugin default.
2017-06-14 15:08:34 +00:00
env : [ {name : ANSIBLE_REMOTE_PORT}]
ini :
- {key: remote_port, section : defaults}
2017-08-15 20:38:59 +00:00
type : integer
2017-06-14 15:08:34 +00:00
yaml : {key : defaults.remote_port}
DEFAULT_REMOTE_TMP :
default : ~/.ansible/tmp
2017-08-15 20:38:59 +00:00
description :
- Temporary directory to use on targets when executing tasks.
- In some cases Ansible may still choose to use a system temporary dir to avoid permission issues.
2017-06-14 15:08:34 +00:00
env : [ {name : ANSIBLE_REMOTE_TEMP}]
ini :
- {key: remote_tmp, section : defaults}
2017-07-13 22:31:10 +00:00
vars :
- name : ansible_remote_tmp
2017-06-14 15:08:34 +00:00
yaml : {key : defaults.remote_tmp}
DEFAULT_REMOTE_USER :
2017-07-18 01:23:38 +00:00
default :
2017-08-15 20:38:59 +00:00
description :
- Sets the login user for the target machines
- When blank it uses the connection plugin's default, normally the user currently executing Ansible.
2017-06-14 15:08:34 +00:00
env : [ {name : ANSIBLE_REMOTE_USER}]
ini :
- {key: remote_user, section : defaults}
yaml : {key : defaults.remote_user}
DEFAULT_ROLES_PATH :
default : ~/.ansible/roles:/usr/share/ansible/roles:/etc/ansible/roles
2017-08-15 20:38:59 +00:00
description: 'TODO : write it'
2017-06-14 15:08:34 +00:00
env : [ {name : ANSIBLE_ROLES_PATH}]
expand_relative_paths : True
ini :
- {key: roles_path, section : defaults}
2017-08-15 20:38:59 +00:00
type : pathlist
2017-06-14 15:08:34 +00:00
yaml : {key : defaults.roles_path}
DEFAULT_SCP_IF_SSH :
default : smart
2017-08-15 20:38:59 +00:00
description :
- "Prefered method to use when transfering files over ssh"
- When set to smart, Ansible will try them until one succeeds or they all fail
- If set to True, it will force 'scp', if False it will use 'sftp'
2017-06-14 15:08:34 +00:00
env : [ {name : ANSIBLE_SCP_IF_SSH}]
ini :
- {key: scp_if_ssh, section : ssh_connection}
yaml : {key : ssh_connection.scp_if_ssh}
DEFAULT_SELINUX_SPECIAL_FS :
default : fuse, nfs, vboxsf, ramfs, 9p
2017-08-15 20:38:59 +00:00
description :
- "Some filesystems do not support safe operations and/or return inconsistent errors,
this setting makes Ansible 'tolerate' those in the list w/o causing fatal errors."
- Data corruption may occur and writes are not always verified when a filesystem is in the list.
2017-06-14 15:08:34 +00:00
env : [ ]
ini :
- {key: special_context_filesystems, section : selinux}
2017-08-15 20:38:59 +00:00
type : list
2017-06-14 15:08:34 +00:00
yaml : {key : selinux.special_context_filesystems}
DEFAULT_SFTP_BATCH_MODE :
default : True
2017-08-15 20:38:59 +00:00
description: 'TODO : write it'
2017-06-14 15:08:34 +00:00
env : [ {name : ANSIBLE_SFTP_BATCH_MODE}]
ini :
- {key: sftp_batch_mode, section : ssh_connection}
2017-08-15 20:38:59 +00:00
type : boolean
2017-06-14 15:08:34 +00:00
yaml : {key : ssh_connection.sftp_batch_mode}
DEFAULT_SQUASH_ACTIONS :
default : apk, apt, dnf, homebrew, openbsd_pkg, pacman, pkgng, yum, zypper
2017-08-15 20:38:59 +00:00
description :
- Ansible can optimise actions that call modules that support list parameters when using with_ looping.
Instead of calling the module once for each item, the module is called once with the full list.
- The default value for this setting is only for certain package managers, but it can be used for any module
- Currently, this is only supported for modules that have a name or pkg parameter, and only when the item is the only thing being passed to the parameter.
2017-06-14 15:08:34 +00:00
env : [ {name : ANSIBLE_SQUASH_ACTIONS}]
ini :
- {key: squash_actions, section : defaults}
2017-08-15 20:38:59 +00:00
type : list
2017-06-14 15:08:34 +00:00
yaml : {key : defaults.squash_actions}
2017-08-15 20:38:59 +00:00
version_added : "2.0"
2017-06-14 15:08:34 +00:00
DEFAULT_SSH_TRANSFER_METHOD :
2017-07-18 01:23:38 +00:00
default :
2017-08-15 20:38:59 +00:00
description : 'unused?'
# - "Prefered method to use when transfering files over ssh"
# - Setting to smart will try them until one succeeds or they all fail
#choices: ['sftp', 'scp', 'dd', 'smart']
2017-06-14 15:08:34 +00:00
env : [ {name : ANSIBLE_SSH_TRANSFER_METHOD}]
ini :
- {key: transfer_method, section : ssh_connection}
yaml : {key : ssh_connection.transfer_method}
DEFAULT_STDOUT_CALLBACK :
default : default
2017-08-15 20:38:59 +00:00
description :
- "Set the main callback used to display Ansible output, you can only have one at a time."
- You can have many other callbacks, but just one can be in charge of stdout.
2017-06-14 15:08:34 +00:00
env : [ {name : ANSIBLE_STDOUT_CALLBACK}]
ini :
- {key: stdout_callback, section : defaults}
yaml : {key : defaults.stdout_callback}
DEFAULT_STRATEGY :
2017-08-15 20:38:59 +00:00
default : 'linear'
description : Set the default strategy used for plays.
2017-06-14 15:08:34 +00:00
env : [ {name : ANSIBLE_STRATEGY}]
ini :
- {key: strategy, section : defaults}
yaml : {key : defaults.strategy}
2017-08-15 20:38:59 +00:00
version_added : "2.3"
2017-06-14 15:08:34 +00:00
DEFAULT_STRATEGY_PLUGIN_PATH :
default : ~/.ansible/plugins/strategy:/usr/share/ansible/plugins/strategy
2017-08-15 20:38:59 +00:00
description: 'TODO : write it'
2017-06-14 15:08:34 +00:00
env : [ {name : ANSIBLE_STRATEGY_PLUGINS}]
ini :
- {key: strategy_plugins, section : defaults}
2017-08-15 20:38:59 +00:00
type : pathlist
2017-06-14 15:08:34 +00:00
yaml : {key : defaults.strategy_plugins}
DEFAULT_SU :
default : False
2017-08-15 20:38:59 +00:00
description : 'Toggle the use of "su" for tasks.'
2017-06-14 15:08:34 +00:00
env : [ {name : ANSIBLE_SU}]
ini :
- {key: su, section : defaults}
2017-08-15 20:38:59 +00:00
type : boolean
2017-06-14 15:08:34 +00:00
yaml : {key : defaults.su}
DEFAULT_SUDO :
default : False
2017-08-15 20:38:59 +00:00
deprecated :
why : In favor of become which is a generic framework
version : "2.8"
alternatives : become
description : 'Toggle the use of "sudo" for tasks.'
2017-06-14 15:08:34 +00:00
env : [ {name : ANSIBLE_SUDO}]
ini :
- {key: sudo, section : defaults}
2017-08-15 20:38:59 +00:00
type : boolean
2017-06-14 15:08:34 +00:00
DEFAULT_SUDO_EXE :
2017-08-15 20:38:59 +00:00
default : sudo
deprecated :
why : In favor of become which is a generic framework
version : "2.8"
alternatives : become
description : 'specify an "sudo" executable, otherwise it relies on PATH.'
2017-06-14 15:08:34 +00:00
env : [ {name : ANSIBLE_SUDO_EXE}]
ini :
- {key: sudo_exe, section : defaults}
DEFAULT_SUDO_FLAGS :
2017-08-15 20:38:59 +00:00
default : '-H -S -n'
deprecated :
why : In favor of become which is a generic framework
version : "2.8"
alternatives : become
description : 'Flags to pass to "sudo"'
2017-06-14 15:08:34 +00:00
env : [ {name : ANSIBLE_SUDO_FLAGS}]
ini :
- {key: sudo_flags, section : defaults}
DEFAULT_SUDO_USER :
2017-08-15 20:38:59 +00:00
default :
deprecated :
why : In favor of become which is a generic framework
version : "2.8"
alternatives : become
description : 'User you become when using "sudo", leaving it blank will use the default configured on the target (normally root)'
2017-06-14 15:08:34 +00:00
env : [ {name : ANSIBLE_SUDO_USER}]
ini :
- {key: sudo_user, section : defaults}
DEFAULT_SU_EXE :
2017-08-15 20:38:59 +00:00
default : su
deprecated :
why : In favor of become which is a generic framework
version : "2.8"
alternatives : become
description : 'specify an "su" executable, otherwise it relies on PATH.'
2017-06-14 15:08:34 +00:00
env : [ {name : ANSIBLE_SU_EXE}]
ini :
- {key: su_exe, section : defaults}
DEFAULT_SU_FLAGS :
2017-08-15 20:38:59 +00:00
default : ~
deprecated :
why : In favor of become which is a generic framework
version : "2.8"
alternatives : become
description : 'Flags to pass to su'
2017-06-14 15:08:34 +00:00
env : [ {name : ANSIBLE_SU_FLAGS}]
ini :
- {key: su_flags, section : defaults}
DEFAULT_SU_USER :
2017-08-15 20:38:59 +00:00
default :
description : 'User you become when using "su", leaving it blank will use the default configured on the target (normally root)'
2017-06-14 15:08:34 +00:00
env : [ {name : ANSIBLE_SU_USER}]
ini :
- {key: su_user, section : defaults}
2017-08-15 20:38:59 +00:00
deprecated :
why : In favor of become which is a generic framework
version : "2.8"
alternatives : become
2017-06-14 15:08:34 +00:00
DEFAULT_SYSLOG_FACILITY :
default : LOG_USER
2017-08-15 20:38:59 +00:00
description: 'TODO : write it'
2017-06-14 15:08:34 +00:00
env : [ {name : ANSIBLE_SYSLOG_FACILITY}]
ini :
- {key: syslog_facility, section : defaults}
yaml : {key : defaults.syslog_facility}
DEFAULT_TASK_INCLUDES_STATIC :
default : False
2017-08-15 20:38:59 +00:00
description: 'TODO : write it'
2017-06-14 15:08:34 +00:00
env : [ {name : ANSIBLE_TASK_INCLUDES_STATIC}]
ini :
- {key: task_includes_static, section : defaults}
2017-08-15 20:38:59 +00:00
type : boolean
2017-06-14 15:08:34 +00:00
yaml : {key : defaults.task_includes_static}
2017-08-15 20:38:59 +00:00
deprecated :
why : include itself is deprecated and this setting will not matter in the future
version : "2.8"
alternatives : None, as its already built into the decision between include_tasks and import_tasks
2017-06-14 15:08:34 +00:00
DEFAULT_TEST_PLUGIN_PATH :
default : ~/.ansible/plugins/test:/usr/share/ansible/plugins/test
2017-08-15 20:38:59 +00:00
description: 'TODO : write it'
2017-06-14 15:08:34 +00:00
env : [ {name : ANSIBLE_TEST_PLUGINS}]
ini :
- {key: test_plugins, section : defaults}
2017-08-15 20:38:59 +00:00
type : pathlist
2017-06-14 15:08:34 +00:00
yaml : {key : defaults.test_plugins}
DEFAULT_TIMEOUT :
default : 10
2017-08-15 20:38:59 +00:00
description: 'TODO : write it'
2017-06-14 15:08:34 +00:00
env : [ {name : ANSIBLE_TIMEOUT}]
ini :
- {key: timeout, section : defaults}
2017-08-15 20:38:59 +00:00
type : integer
2017-06-14 15:08:34 +00:00
yaml : {key : defaults.timeout}
DEFAULT_TRANSPORT :
default : smart
2017-08-15 20:38:59 +00:00
description : "Default connection plugin to use, the 'smart' option will toggle between 'ssh' and 'paramiko' depending on controller OS and ssh versions"
2017-06-14 15:08:34 +00:00
env : [ {name : ANSIBLE_TRANSPORT}]
ini :
- {key: transport, section : defaults}
yaml : {key : defaults.transport}
DEFAULT_UNDEFINED_VAR_BEHAVIOR :
default : True
2017-08-15 20:38:59 +00:00
description: 'TODO : write it'
2017-06-14 15:08:34 +00:00
env : [ {name : ANSIBLE_ERROR_ON_UNDEFINED_VARS}]
ini :
- {key: error_on_undefined_vars, section : defaults}
2017-08-15 20:38:59 +00:00
type : boolean
2017-06-14 15:08:34 +00:00
yaml : {key : defaults.error_on_undefined_vars}
DEFAULT_VARS_PLUGIN_PATH :
default : ~/.ansible/plugins/vars:/usr/share/ansible/plugins/vars
2017-08-15 20:38:59 +00:00
description: 'TODO : write it'
2017-06-14 15:08:34 +00:00
env : [ {name : ANSIBLE_VARS_PLUGINS}]
ini :
- {key: vars_plugins, section : defaults}
2017-08-15 20:38:59 +00:00
type : pathlist
2017-06-14 15:08:34 +00:00
yaml : {key : defaults.vars_plugins}
DEFAULT_VAR_COMPRESSION_LEVEL :
default : 0
2017-08-15 20:38:59 +00:00
description: 'TODO : write it'
2017-06-14 15:08:34 +00:00
env : [ {name : ANSIBLE_VAR_COMPRESSION_LEVEL}]
ini :
- {key: var_compression_level, section : defaults}
2017-08-15 20:38:59 +00:00
type : integer
2017-06-14 15:08:34 +00:00
yaml : {key : defaults.var_compression_level}
Support multiple vault passwords (#22756)
Fixes #13243
** Add --vault-id to name/identify multiple vault passwords
Use --vault-id to indicate id and path/type
--vault-id=prompt # prompt for default vault id password
--vault-id=myorg@prompt # prompt for a vault_id named 'myorg'
--vault-id=a_password_file # load ./a_password_file for default id
--vault-id=myorg@a_password_file # load file for 'myorg' vault id
vault_id's are created implicitly for existing --vault-password-file
and --ask-vault-pass options.
Vault ids are just for UX purposes and bookkeeping. Only the vault
payload and the password bytestring is needed to decrypt a
vault blob.
Replace passing password around everywhere with
a VaultSecrets object.
If we specify a vault_id, mention that in password prompts
Specifying multiple -vault-password-files will
now try each until one works
** Rev vault format in a backwards compatible way
The 1.2 vault format adds the vault_id to the header line
of the vault text. This is backwards compatible with older
versions of ansible. Old versions will just ignore it and
treat it as the default (and only) vault id.
Note: only 2.4+ supports multiple vault passwords, so while
earlier ansible versions can read the vault-1.2 format, it
does not make them magically support multiple vault passwords.
use 1.1 format for 'default' vault_id
Vaulted items that need to include a vault_id will be
written in 1.2 format.
If we set a new DEFAULT_VAULT_IDENTITY, then the default will
use version 1.2
vault will only use a vault_id if one is specified. So if none
is specified and C.DEFAULT_VAULT_IDENTITY is 'default'
we use the old format.
** Changes/refactors needed to implement multiple vault passwords
raise exceptions on decrypt fail, check vault id early
split out parsing the vault plaintext envelope (with the
sha/original plaintext) to _split_plaintext_envelope()
some cli fixups for specifying multiple paths in
the unfrack_paths optparse callback
fix py3 dict.keys() 'dict_keys object is not indexable' error
pluralize cli.options.vault_password_file -> vault_password_files
pluralize cli.options.new_vault_password_file -> new_vault_password_files
pluralize cli.options.vault_id -> cli.options.vault_ids
** Add a config option (vault_id_match) to force vault id matching.
With 'vault_id_match=True' and an ansible
vault that provides a vault_id, then decryption will require
that a matching vault_id is required. (via
--vault-id=my_vault_id@password_file, for ex).
In other words, if the config option is true, then only
the vault secrets with matching vault ids are candidates for
decrypting a vault. If option is false (the default), then
all of the provided vault secrets will be selected.
If a user doesn't want all vault secrets to be tried to
decrypt any vault content, they can enable this option.
Note: The vault id used for the match is not encrypted or
cryptographically signed. It is just a label/id/nickname used
for referencing a specific vault secret.
2017-07-28 19:20:58 +00:00
DEFAULT_VAULT_ID_MATCH :
default : False
desc : 'If true, decrypting vaults with a vault id will only try the password from the matching vault-id'
env : [ {name : ANSIBLE_VAULT_ID_MATCH}]
ini :
- {key: vault_id_match, section : defaults}
vars : [ ]
yaml : {key : defaults.vault_id_match}
DEFAULT_VAULT_IDENTITY :
default : default
desc: 'TODO : write it'
env : [ {name : ANSIBLE_VAULT_IDENTITY}]
ini :
- {key: vault_identity, section : defaults}
vars : [ ]
yaml : {key : defaults.vault_identity}
2017-08-15 15:56:17 +00:00
DEFAULT_VAULT_IDENTITY_LIST :
default : [ ]
desc : 'A list of vault-ids to use by default. Equivalent to multiple --vault-id args. Vault-ids are tried in order.'
env : [ {name : ANSIBLE_VAULT_IDENTITY_LIST}]
ini :
- {key: vault_identity_list, section : defaults}
2017-08-28 14:13:14 +00:00
type : list
2017-08-15 15:56:17 +00:00
vars : [ ]
yaml : {key : defaults.vault_identity_list}
2017-06-14 15:08:34 +00:00
DEFAULT_VAULT_PASSWORD_FILE :
2017-08-15 20:38:59 +00:00
default : ~
description: 'TODO : write it'
2017-06-14 15:08:34 +00:00
env : [ {name : ANSIBLE_VAULT_PASSWORD_FILE}]
ini :
- {key: vault_password_file, section : defaults}
2017-08-15 20:38:59 +00:00
type : path
2017-06-14 15:08:34 +00:00
yaml : {key : defaults.vault_password_file}
DEFAULT_VERBOSITY :
default : 0
2017-08-15 20:38:59 +00:00
description: 'TODO : write it'
2017-06-14 15:08:34 +00:00
env : [ {name : ANSIBLE_VERBOSITY}]
ini :
- {key: verbosity, section : defaults}
2017-08-15 20:38:59 +00:00
type : integer
2017-06-14 15:08:34 +00:00
yaml : {key : defaults.verbosity}
DEPRECATION_WARNINGS :
default : True
2017-08-15 20:38:59 +00:00
description : "Toggle to control the showing of deprecation warnings"
2017-06-14 15:08:34 +00:00
env : [ {name : ANSIBLE_DEPRECATION_WARNINGS}]
ini :
- {key: deprecation_warnings, section : defaults}
2017-08-15 20:38:59 +00:00
type : boolean
2017-06-14 15:08:34 +00:00
yaml : {key : defaults.deprecation_warnings}
DIFF_ALWAYS :
default : False
2017-08-15 20:38:59 +00:00
description: 'TODO : write it'
2017-06-14 15:08:34 +00:00
env : [ {name : ANSIBLE_DIFF_ALWAYS}]
ini :
- {key: always, section : diff}
2017-08-15 20:38:59 +00:00
type : bool
2017-06-14 15:08:34 +00:00
yaml : {key : diff.always}
DIFF_CONTEXT :
default : 3
2017-08-15 20:38:59 +00:00
description: 'TODO : write it'
2017-06-14 15:08:34 +00:00
env : [ {name : ANSIBLE_DIFF_CONTEXT}]
ini :
- {key: context, section : diff}
2017-08-15 20:38:59 +00:00
type : integer
2017-06-14 15:08:34 +00:00
yaml : {key : diff.context}
DISPLAY_ARGS_TO_STDOUT :
default : False
2017-08-15 20:38:59 +00:00
description: 'TODO : write it'
2017-06-14 15:08:34 +00:00
env : [ {name : ANSIBLE_DISPLAY_ARGS_TO_STDOUT}]
ini :
- {key: display_args_to_stdout, section : defaults}
2017-08-15 20:38:59 +00:00
type : boolean
2017-06-14 15:08:34 +00:00
yaml : {key : defaults.display_args_to_stdout}
DISPLAY_SKIPPED_HOSTS :
default : True
2017-08-15 20:38:59 +00:00
description : "Toggle to control displaying skipped host entries in a task in the default callback"
2017-06-14 15:08:34 +00:00
env : [ {name : DISPLAY_SKIPPED_HOSTS}]
ini :
- {key: display_skipped_hosts, section : defaults}
2017-08-15 20:38:59 +00:00
type : boolean
2017-06-14 15:08:34 +00:00
yaml : {key : defaults.display_skipped_hosts}
ERROR_ON_MISSING_HANDLER :
default : True
2017-08-15 20:38:59 +00:00
description : "Toggle to allow missing handlers to become a warning instead of an error when notifying."
2017-06-14 15:08:34 +00:00
env : [ {name : ANSIBLE_ERROR_ON_MISSING_HANDLER}]
ini :
- {key: error_on_missing_handler, section : defaults}
2017-08-15 20:38:59 +00:00
type : boolean
2017-06-14 15:08:34 +00:00
yaml : {key : defaults.error_on_missing_handler}
GALAXY_IGNORE_CERTS :
default : False
2017-08-15 20:38:59 +00:00
description: 'TODO : write it'
2017-06-14 15:08:34 +00:00
env : [ {name : ANSIBLE_GALAXY_IGNORE}]
ini :
- {key: ignore_certs, section : galaxy}
2017-08-15 20:38:59 +00:00
type : boolean
2017-06-14 15:08:34 +00:00
yaml : {key : galaxy.ignore_certs}
GALAXY_ROLE_SKELETON :
2017-07-18 01:23:38 +00:00
default :
2017-08-15 20:38:59 +00:00
description: 'TODO : write it'
2017-06-14 15:08:34 +00:00
env : [ {name : ANSIBLE_GALAXY_ROLE_SKELETON}]
ini :
- {key: role_skeleton, section : galaxy}
2017-08-15 20:38:59 +00:00
type : path
2017-06-14 15:08:34 +00:00
yaml : {key : galaxy.role_skeleton}
GALAXY_ROLE_SKELETON_IGNORE :
default : [ ^.git$, ^.*/.git_keep$]
2017-08-15 20:38:59 +00:00
description: 'TODO : write it'
2017-06-14 15:08:34 +00:00
env : [ {name : ANSIBLE_GALAXY_ROLE_SKELETON_IGNORE}]
ini :
- {key: role_skeleton_ignore, section : galaxy}
2017-08-15 20:38:59 +00:00
type : list
2017-06-14 15:08:34 +00:00
yaml : {key : galaxy.role_skeleton_ignore}
GALAXY_SCMS :
default : git, hg
2017-08-15 20:38:59 +00:00
description: 'TODO : write it'
2017-06-14 15:08:34 +00:00
env : [ {name : ANSIBLE_GALAXY_SCMS}]
ini :
- {key: scms, section : galaxy}
2017-08-15 20:38:59 +00:00
type : list
2017-06-14 15:08:34 +00:00
yaml : {key : galaxy.scms}
GALAXY_SERVER :
default : https://galaxy.ansible.com
2017-08-15 20:38:59 +00:00
description : "URL to prepend when roles don't specify the full URI, assume they are referencing this server as the source."
2017-06-14 15:08:34 +00:00
env : [ {name : ANSIBLE_GALAXY_SERVER}]
ini :
- {key: server, section : galaxy}
yaml : {key : galaxy.server}
HOST_KEY_CHECKING :
default : True
2017-08-15 20:38:59 +00:00
description : 'Set this to "False" if you want to avoid host key checking by the underlying tools Ansible uses to connect to the host'
2017-06-14 15:08:34 +00:00
env : [ {name : ANSIBLE_HOST_KEY_CHECKING}]
ini :
- {key: host_key_checking, section : defaults}
2017-08-15 20:38:59 +00:00
type : boolean
2017-06-14 15:08:34 +00:00
INVENTORY_ENABLED :
2017-08-28 21:17:19 +00:00
default : [ 'host_list' , 'script' , 'yaml' , 'ini' ]
2017-08-15 20:38:59 +00:00
description : List of enabled inventory plugins, it also determines the order in which they are used.
2017-06-14 15:08:34 +00:00
env : [ {name : ANSIBLE_INVENTORY_ENABLED}]
ini :
2017-08-28 21:17:19 +00:00
- {key: enable_plugins, section : inventory}
2017-08-15 20:38:59 +00:00
type : list
2017-06-14 15:08:34 +00:00
INVENTORY_IGNORE_EXTS :
2017-08-15 20:38:59 +00:00
default : eval(BLACKLIST_EXTS + ( '~', '.orig', '.ini', '.cfg', '.retry'))
description : List of extensions to ignore when using a directory as an inventory source
2017-06-14 15:08:34 +00:00
env : [ {name : ANSIBLE_INVENTORY_IGNORE}]
ini :
- {key: inventory_ignore_extensions, section : defaults}
2017-08-28 21:17:19 +00:00
- {key: ignore_extensions, section : inventory}
2017-08-15 20:38:59 +00:00
type : list
2017-06-14 15:08:34 +00:00
INVENTORY_IGNORE_PATTERNS :
default : [ ]
2017-08-15 20:38:59 +00:00
description : List of patterns to ignore when using a directory as an inventory source
2017-06-14 15:08:34 +00:00
env : [ {name : ANSIBLE_INVENTORY_IGNORE_REGEX}]
ini :
- {key: inventory_ignore_patterns, section : defaults}
2017-08-28 21:17:19 +00:00
- {key: ignore_patterns, section : inventory}
2017-08-15 20:38:59 +00:00
type : list
2017-08-28 21:17:19 +00:00
INVENTORY_UNPARSED_IS_FAILED :
default : False
description : If 'true' unparsed inventory sources become fatal errors, they are warnings otherwise.
env : [ {name : ANSIBLE_INVENTORY_UNPARSED_FAILED}]
ini :
- {key: unparsed_is_failed, section : inventory}
type : boolean
2017-06-14 15:08:34 +00:00
MAX_FILE_SIZE_FOR_DIFF :
default : 104448
2017-08-15 20:38:59 +00:00
description : Maximum size of files to be considered for diff display
2017-06-14 15:08:34 +00:00
env : [ {name : ANSIBLE_MAX_DIFF_SIZE}]
ini :
- {key: max_diff_size, section : defaults}
2017-08-15 20:38:59 +00:00
type : integer
2017-06-14 15:08:34 +00:00
yaml : {key : defaults.max_diff_size}
MERGE_MULTIPLE_CLI_TAGS :
default : True
2017-08-15 20:38:59 +00:00
description: 'TODO : write it'
2017-06-14 15:08:34 +00:00
env : [ {name : ANSIBLE_MERGE_MULTIPLE_CLI_TAGS}]
ini :
2017-08-15 20:38:59 +00:00
- {key: merge_multiple_cli_tags, section : defaults}
type : boolean
2017-06-14 15:08:34 +00:00
yaml : {key : defaults.merge_multiple_cli_tags}
NETWORK_GROUP_MODULES :
2017-07-19 17:44:52 +00:00
default : [ eos, nxos, ios, iosxr, junos, ce, vyos, sros, dellos9, dellos10, dellos6, asa, aruba, aireos]
2017-08-15 20:38:59 +00:00
description: 'TODO : write it'
2017-06-14 15:08:34 +00:00
env : [ {name : NETWORK_GROUP_MODULES}]
ini :
- {key: network_group_modules, section : defaults}
2017-08-15 20:38:59 +00:00
type : list
2017-06-14 15:08:34 +00:00
yaml : {key : defaults.network_group_modules}
2017-07-12 23:27:05 +00:00
ONLY_NAMESPACE_FACTS :
default : False
2017-08-15 20:38:59 +00:00
description :
2017-07-12 23:27:05 +00:00
- Facts normally get injected as top level variables, this setting prevents that.
- Facts are still available in the `ansible_facts` variable w/o the `ansible_` prefix.
env : [ {name : ANSIBLE_RESTRICT_FACTS}]
ini :
- {key: restrict_facts_namespace, section : defaults}
2017-08-15 20:38:59 +00:00
type : boolean
2017-07-12 23:27:05 +00:00
yaml : {key : defaults.restrict_facts_namespace}
version_added : "2.4"
2017-06-14 15:08:34 +00:00
PARAMIKO_HOST_KEY_AUTO_ADD :
default : False
2017-08-15 20:38:59 +00:00
description: 'TODO : write it'
2017-06-14 15:08:34 +00:00
env : [ {name : ANSIBLE_PARAMIKO_HOST_KEY_AUTO_ADD}]
ini :
- {key: host_key_auto_add, section : paramiko_connection}
2017-08-15 20:38:59 +00:00
type : boolean
2017-06-14 15:08:34 +00:00
yaml : {key : paramiko_connection.host_key_auto_add}
PARAMIKO_LOOK_FOR_KEYS :
default : True
2017-08-15 20:38:59 +00:00
description: 'TODO : write it'
2017-06-14 15:08:34 +00:00
env : [ {name : ANSIBLE_PARAMIKO_LOOK_FOR_KEYS}]
ini :
- {key: look_for_keys, section : paramiko_connection}
2017-08-15 20:38:59 +00:00
type : boolean
2017-06-14 15:08:34 +00:00
yaml : {key : paramiko_connection.look_for_keys}
PARAMIKO_PROXY_COMMAND :
2017-07-18 01:23:38 +00:00
default :
2017-08-15 20:38:59 +00:00
description: 'TODO : write it'
2017-06-14 15:08:34 +00:00
env : [ {name : ANSIBLE_PARAMIKO_PROXY_COMMAND}]
ini :
- {key: proxy_command, section : paramiko_connection}
yaml : {key : paramiko_connection.proxy_command}
PARAMIKO_PTY :
default : True
2017-08-15 20:38:59 +00:00
description: 'TODO : write it'
2017-06-14 15:08:34 +00:00
env : [ {name : ANSIBLE_PARAMIKO_PTY}]
ini :
- {key: pty, section : paramiko_connection}
2017-08-15 20:38:59 +00:00
type : boolean
2017-06-14 15:08:34 +00:00
yaml : {key : paramiko_connection.pty}
PARAMIKO_RECORD_HOST_KEYS :
default : True
2017-08-15 20:38:59 +00:00
description: 'TODO : write it'
2017-06-14 15:08:34 +00:00
env : [ {name : ANSIBLE_PARAMIKO_RECORD_HOST_KEYS}]
ini :
- {key: record_host_keys, section : paramiko_connection}
2017-08-15 20:38:59 +00:00
type : boolean
2017-06-14 15:08:34 +00:00
yaml : {key : paramiko_connection.record_host_keys}
2017-06-15 10:14:43 +00:00
PERSISTENT_CONTROL_PATH_DIR :
default : ~/.ansible/pc
2017-08-15 20:38:59 +00:00
description: 'TODO : write it'
2017-06-15 10:14:43 +00:00
env : [ {name : ANSIBLE_PERSISTENT_CONTROL_PATH_DIR}]
ini :
- {key: control_path_dir, section : persistent_connection}
yaml : {key : persistent_connection.control_path_dir}
2017-06-14 15:08:34 +00:00
PERSISTENT_CONNECT_TIMEOUT :
default : 30
2017-08-16 14:55:39 +00:00
description : This controls how long the persistent connection will remain idle before it is destroyed.
2017-06-14 15:08:34 +00:00
env : [ {name : ANSIBLE_PERSISTENT_CONNECT_TIMEOUT}]
ini :
- {key: connect_timeout, section : persistent_connection}
2017-08-15 20:38:59 +00:00
type : integer
2017-06-14 15:08:34 +00:00
yaml : {key : persistent_connection.connect_timeout}
2017-08-01 17:45:45 +00:00
PERSISTENT_CONNECT_RETRY_TIMEOUT :
default : 15
2017-08-16 14:55:39 +00:00
description : This contorls the retry timeout for presistent connection to connect to the local domain socket.
2017-08-01 17:45:45 +00:00
env : [ {name : ANSIBLE_PERSISTENT_CONNECT_RETRY_TIMEOUT}]
ini :
- {key: connect_retry_timeout, section : persistent_connection}
2017-08-16 14:55:39 +00:00
type : integer
2017-08-01 17:45:45 +00:00
yaml : {key : persistent_connection.connect_retry_timeout}
PERSISTENT_COMMAND_TIMEOUT :
default : 10
2017-08-16 14:55:39 +00:00
description : This controls the amount of time to wait for response from remote device before timing out presistent connection.
2017-08-01 17:45:45 +00:00
env : [ {name : ANSIBLE_PERSISTENT_COMMAND_TIMEOUT}]
ini :
- {key: command_timeout, section : persistent_connection}
2017-08-16 14:55:39 +00:00
type : integer
2017-08-01 17:45:45 +00:00
yaml : {key : persistent_connection.command_timeout}
2017-06-14 15:08:34 +00:00
RETRY_FILES_ENABLED :
default : True
2017-08-15 20:38:59 +00:00
description : This controls whether a failed Ansible playbook should create a .retry file.
2017-06-14 15:08:34 +00:00
env : [ {name : ANSIBLE_RETRY_FILES_ENABLED}]
ini :
- {key: retry_files_enabled, section : defaults}
2017-08-15 20:38:59 +00:00
type : boolean
2017-07-07 00:21:53 +00:00
yaml : {key : errors.retry.enabled}
2017-06-14 15:08:34 +00:00
RETRY_FILES_SAVE_PATH :
default : ~
2017-08-15 20:38:59 +00:00
description : This sets the path in which Ansible will save .retry files when a playbook fails and retry files are enabled.
2017-06-14 15:08:34 +00:00
env : [ {name : ANSIBLE_RETRY_FILES_SAVE_PATH}]
ini :
- {key: retry_files_save_path, section : defaults}
2017-08-15 20:38:59 +00:00
type : path
2017-07-07 00:21:53 +00:00
yaml : {key : errors.retry.path}
2017-06-14 15:08:34 +00:00
SHOW_CUSTOM_STATS :
default : False
2017-08-15 20:38:59 +00:00
description : 'This adds the custom stats set via the set_stats plugin to the default output'
2017-06-14 15:08:34 +00:00
env : [ {name : ANSIBLE_SHOW_CUSTOM_STATS}]
ini :
- {key: show_custom_stats, section : defaults}
2017-08-15 20:38:59 +00:00
type : boolean
2017-06-14 15:08:34 +00:00
yaml : {key : defaults.show_custom_stats}
STRING_TYPE_FILTERS :
default : [ string, to_json, to_nice_json, to_yaml, ppretty, json]
2017-08-15 20:38:59 +00:00
description :
- "This list of filters avoids 'type conversion' when templating variables"
- Useful when you want to avoid conversion into lists or dictionaries for JSON strings, for example.
2017-06-14 15:08:34 +00:00
env : [ {name : ANSIBLE_STRING_TYPE_FILTERS}]
ini :
- {key: dont_type_filters, section : jinja2}
2017-08-15 20:38:59 +00:00
type : list
2017-06-14 15:08:34 +00:00
yaml : {key : jinja2.dont_type_filters}
SYSTEM_WARNINGS :
default : True
2017-08-15 20:38:59 +00:00
description: 'TODO : write it'
2017-06-14 15:08:34 +00:00
env : [ {name : ANSIBLE_SYSTEM_WARNINGS}]
ini :
- {key: system_warnings, section : defaults}
2017-08-15 20:38:59 +00:00
type : boolean
2017-06-14 15:08:34 +00:00
yaml : {key : defaults.system_warnings}
USE_PERSISTENT_CONNECTIONS :
default : False
2017-08-15 20:38:59 +00:00
description: 'TODO : write it'
2017-06-14 15:08:34 +00:00
env : [ {name : ANSIBLE_USE_PERSISTENT_CONNECTIONS}]
ini :
- {key: use_persistent_connections, section : defaults}
2017-08-15 20:38:59 +00:00
type : boolean
2017-06-14 15:08:34 +00:00
yaml : {key : defaults.use_persistent_connections}
VARIABLE_PRECEDENCE :
default : [ all_inventory, groups_inventory, all_plugins_inventory, all_plugins_play, groups_plugins_inventory, groups_plugins_play]
2017-08-15 20:38:59 +00:00
description: 'TODO : write it'
2017-06-14 15:08:34 +00:00
env : [ {name : ANSIBLE_PRECEDENCE}]
ini :
- {key: precedence, section : defaults}
2017-08-15 20:38:59 +00:00
type : list
2017-06-14 15:08:34 +00:00
yaml : {key : defaults.precedence}
2017-07-13 23:19:34 +00:00
YAML_FILENAME_EXTENSIONS :
default : [ ".yml" , ".yaml" , ".json" ]
2017-08-15 20:38:59 +00:00
description :
- "Check all of these extensions when looking for 'variable' files which should be YAML or JSON or vaulted versions of these."
- 'This affects vars_files, include_vars, inventory and vars plugins among others.'
2017-07-13 23:19:34 +00:00
env :
- name : ANSIBLE_YAML_FILENAME_EXT
ini :
2017-08-15 20:38:59 +00:00
- section : yaml_valid_extensions
key : defaults
type : list
2017-07-13 23:19:34 +00:00
yaml : {key : defaults.yaml_valid_extensions}
2017-08-15 20:38:59 +00:00
...