Ansible Configuration Settings¶

The configuration file¶

Changes can be made and used in a configuration file which will be searched for in the following order:

• ANSIBLE_CONFIG (environment variable if set)
• ansible.cfg (in the current directory)
• ~/.ansible.cfg (in the home directory)
• /etc/ansible/ansible.cfg

Ansible will process the above list and use the first file found, all others are ignored.

# some basic default values...
inventory = /etc/ansible/hosts  ; This points to the file that lists your hosts

Common Options¶

This is a copy of the options available from our release, your local install might have extra options due to additional plugins, you can use the command line utility mentioned above (ansible-config) to browse through those.

Environment Variables¶

ANSIBLE_CONFIG¶

Override the default ansible config file

ANSIBLE_MERGE_MULTIPLE_CLI_TAGS¶

This allows changing how multiple –tags and –skip-tags arguments are handled on the command line. In Ansible up to and including 2.3, specifying –tags more than once will only take the last value of –tags.Setting this config value to True will mean that all of the –tags options will be merged together. The same holds true for –skip-tags.

See also MERGE_MULTIPLE_CLI_TAGS

DISPLAY_SKIPPED_HOSTS¶

Toggle to control displaying skipped task/host entries in a task in the default callback

See also DISPLAY_SKIPPED_HOSTS

ANSIBLE_SUDO_FLAGS¶

Flags to pass to “sudo”

See also DEFAULT_SUDO_FLAGS

ANSIBLE_PERSISTENT_CONNECT_RETRY_TIMEOUT¶

This contorls the retry timeout for presistent connection to connect to the local domain socket.

See also PERSISTENT_CONNECT_RETRY_TIMEOUT

ANSIBLE_DIFF_CONTEXT¶

How many lines of context to show when displaying the differences between files.

See also DIFF_CONTEXT

ANSIBLE_COW_PATH¶

Specify a custom cowsay path or swap in your cowsay implementation of choice

See also ANSIBLE_COW_PATH

ANSIBLE_TEST_PLUGINS¶

Colon separated paths in which Ansible will search for Jinja2 Test Plugins.

See also DEFAULT_TEST_PLUGIN_PATH

ANSIBLE_INVENTORY_ENABLED¶

List of enabled inventory plugins, it also determines the order in which they are used.

See also INVENTORY_ENABLED

ANSIBLE_GALAXY_ROLE_SKELETON_IGNORE¶

patterns of files to ignore inside a galaxy role skeleton directory

See also GALAXY_ROLE_SKELETON_IGNORE

ANSIBLE_PIPELINING¶

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.

See also ANSIBLE_PIPELINING

ANSIBLE_SSH_PIPELINING¶

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.

See also ANSIBLE_PIPELINING

ANSIBLE_BECOME_METHOD¶

Privilege escalation method to use when become is enabled.

See also DEFAULT_BECOME_METHOD

ANSIBLE_HOST_KEY_CHECKING¶

Set this to “False” if you want to avoid host key checking by the underlying tools Ansible uses to connect to the host

See also HOST_KEY_CHECKING

ANSIBLE_ASK_SU_PASS¶

This controls whether an Ansible playbook should prompt for a su password.

See also DEFAULT_ASK_SU_PASS

ANSIBLE_SU_USER¶

User you become when using “su”, leaving it blank will use the default configured on the target (normally root)

See also DEFAULT_SU_USER

ANSIBLE_CALLABLE_WHITELIST¶

Whitelist of callable methods to be made available to template evaluation

See also DEFAULT_CALLABLE_WHITELIST

ANSIBLE_COLOR_VERBOSE¶

Defines the color to use when emitting verbose messages. i.e those that show with ‘-v’s.

See also COLOR_VERBOSE

ANSIBLE_GATHERING¶

This setting controls the default policy of fact gathering (facts discovered about remote systems).When ‘implicit’ (the default), the cache plugin will be ignored and facts will be gathered per play unless ‘gather_facts: False’ is set.When ‘explicit’ the inverse is true, facts will not be gathered unless directly requested in the play.The ‘smart’ value means each new host that has no facts discovered will be scanned, but if the same host is addressed in multiple plays it will not be contacted again in the playbook run.This option can be useful for those wishing to save fact gathering time. Both ‘smart’ and ‘explicit’ will use the cache plugin.

See also DEFAULT_GATHERING

ANSIBLE_TIMEOUT¶

This is the default timeout for connection plugins to use.

See also DEFAULT_TIMEOUT

ANSIBLE_SCP_IF_SSH¶

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’.

See also DEFAULT_SCP_IF_SSH

ANSIBLE_NOCOWS¶

If you have cowsay installed but want to avoid the ‘cows’ (why????), use this.

See also ANSIBLE_NOCOWS

ANSIBLE_INVENTORY_IGNORE_REGEX¶

List of patterns to ignore when using a directory as an inventory source

See also INVENTORY_IGNORE_PATTERNS

ANSIBLE_NO_LOG¶

Toggle Ansible’s display and logging of task details, mainly used to avoid security disclosures.

See also DEFAULT_NO_LOG

ANSIBLE_MAX_DIFF_SIZE¶

Maximum size of files to be considered for diff display

See also MAX_FILE_SIZE_FOR_DIFF

ANSIBLE_HANDLER_INCLUDES_STATIC¶

Since 2.0 M(include) can be ‘dynamic’, this setting (if True) forces that if the include appears in a handlers section to be ‘static’.

See also DEFAULT_HANDLER_INCLUDES_STATIC

ANSIBLE_KEEP_REMOTE_FILES¶

Enables/disables the cleaning up of the temporary files Ansible used to execute the tasks on the remote.

See also DEFAULT_KEEP_REMOTE_FILES

ANSIBLE_POLL_INTERVAL¶

For asynchronous tasks in Ansible (covered in Asynchronous Actions and Polling), this is how often to check back on the status of those tasks when an explicit poll interval is not supplied. The default is a reasonably moderate 15 seconds which is a tradeoff between checking in frequently and providing a quick turnaround when something may have completed.

See also DEFAULT_POLL_INTERVAL

ANSIBLE_CLICONF_PLUGINS¶

Colon separated paths in which Ansible will search for Cliconf Plugins.

See also DEFAULT_CLICONF_PLUGIN_PATH

ANSIBLE_BECOME_ALLOW_SAME_USER¶

This setting controls if become is skipped when remote user and become user are the same. I.E root sudo to root.

See also BECOME_ALLOW_SAME_USER

ANSIBLE_SSH_ARGS¶

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.

See also ANSIBLE_SSH_ARGS

ANSIBLE_ACTION_PLUGINS¶

Colon separated paths in which Ansible will search for Action Plugins.

See also DEFAULT_ACTION_PLUGIN_PATH

ANSIBLE_REMOTE_USER¶

Sets the login user for the target machinesWhen blank it uses the connection plugin’s default, normally the user currently executing Ansible.

See also DEFAULT_REMOTE_USER

ANSIBLE_INVENTORY_PLUGINS¶

Colon separated paths in which Ansible will search for Inventory Plugins.

See also DEFAULT_INVENTORY_PLUGIN_PATH

ANSIBLE_VAULT_PASSWORD_FILE¶

The vault password file to use. Equivalent to –vault-password-file or –vault-id

See also DEFAULT_VAULT_PASSWORD_FILE

ANSIBLE_CACHE_PLUGINS¶

Colon separated paths in which Ansible will search for Cache Plugins.

See also DEFAULT_CACHE_PLUGIN_PATH

ANSIBLE_CALLBACK_PLUGINS¶

Colon separated paths in which Ansible will search for Callback Plugins.

See also DEFAULT_CALLBACK_PLUGIN_PATH

ANSIBLE_TERMINAL_PLUGINS¶

Colon separated paths in which Ansible will search for Terminal Plugins.

See also DEFAULT_TERMINAL_PLUGIN_PATH

ANSIBLE_CONNECTION_PLUGINS¶

Colon separated paths in which Ansible will search for Connection Plugins.

See also DEFAULT_CONNECTION_PLUGIN_PATH

ANSIBLE_JINJA2_EXTENSIONS¶

This is a developer-specific feature that allows enabling additional Jinja2 extensions.See the Jinja2 documentation for details. If you do not know what these do, you probably don’t need to change this setting :)

See also DEFAULT_JINJA2_EXTENSIONS

ANSIBLE_COMMAND_WARNINGS¶

By default Ansible will issue a warning when the shell or command module is used and the command appears to be similar to an existing Ansible module.These warnings can be silenced by adjusting this setting to False. You can also control this at the task level with the module option warn.

See also COMMAND_WARNINGS

ANSIBLE_COLOR_OK¶

Defines the color to use when showing ‘OK’ task status

See also COLOR_OK

ANSIBLE_INJECT_FACT_VARS¶

Facts are available inside the ansible_facts variable, this setting also pushes them as their own vars in the main namespace.Unlike inside the ansible_facts dictionary, these will have an ansible_ prefix.

See also INJECT_FACTS_AS_VARS

ANSIBLE_COLOR_CHANGED¶

Defines the color to use on ‘Changed’ task status

See also COLOR_CHANGED

ANSIBLE_DISPLAY_ARGS_TO_STDOUT¶

Normally ansible-playbook will print a header for each task that is run. These headers will contain the name: field from the task if you specified one. If you didn’t then ansible-playbook uses the task’s action to help you tell which task is presently running. Sometimes you run many of the same action and so you want more information about the task to differentiate it from others of the same action. If you set this variable to True in the config then ansible-playbook will also include the task’s arguments in the header.This setting defaults to False because there is a chance that you have sensitive values in your parameters and you do not want those to be printed.If you set this to True you should be sure that you have secured your environment’s stdout (no one can shoulder surf your screen and you aren’t saving stdout to an insecure file) or made sure that all of your playbooks explicitly added the no_log: True parameter to tasks which have sensistive values See How do I keep secret data in my playbook? for more information.

See also DISPLAY_ARGS_TO_STDOUT

ANSIBLE_LOCAL_TEMP¶

Temporary directory for Ansible to use on the controller.

See also DEFAULT_LOCAL_TMP

ANSIBLE_COLOR_ERROR¶

Defines the color to use when emitting error messages

See also COLOR_ERROR

ANSIBLE_VAULT_ID_MATCH¶

If true, decrypting vaults with a vault id will only try the password from the matching vault-id

See also DEFAULT_VAULT_ID_MATCH

ANSIBLE_ERROR_ON_MISSING_HANDLER¶

Toggle to allow missing handlers to become a warning instead of an error when notifying.

See also ERROR_ON_MISSING_HANDLER

ANSIBLE_CACHE_PLUGIN¶

Chooses which cache plugin to use, the default ‘memory’ is ephimeral.

See also CACHE_PLUGIN

ANSIBLE_BECOME¶

Toggles the use of privilege escalation, allowing you to ‘become’ another user after login.

See also DEFAULT_BECOME

ANSIBLE_VERBOSITY¶

Sets the default verbosity, equivalent to the number of -v passed in the command line.

See also DEFAULT_VERBOSITY

ANSIBLE_SQUASH_ACTIONS¶

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.

See also DEFAULT_SQUASH_ACTIONS

ANSIBLE_VARS_PLUGINS¶

Colon separated paths in which Ansible will search for Vars Plugins.

See also DEFAULT_VARS_PLUGIN_PATH

ANSIBLE_FILTER_PLUGINS¶

Colon separated paths in which Ansible will search for Jinja2 Filter Plugins.

See also DEFAULT_FILTER_PLUGIN_PATH

ANSIBLE_GALAXY_ROLE_SKELETON¶

Role skeleton directory to use as a template for the init action in ansible-galaxy, same as --role-skeleton.

See also GALAXY_ROLE_SKELETON

ANSIBLE_PERSISTENT_CONNECT_TIMEOUT¶

This controls how long the persistent connection will remain idle before it is destroyed.

See also PERSISTENT_CONNECT_TIMEOUT

ANSIBLE_BECOME_ASK_PASS¶

Toggle to prompt for privilege escalation password.

See also DEFAULT_BECOME_ASK_PASS

ANSIBLE_PERSISTENT_COMMAND_TIMEOUT¶

This controls the amount of time to wait for response from remote device before timing out presistent connection.

See also PERSISTENT_COMMAND_TIMEOUT

ANSIBLE_HOSTS¶

Comma separated list of Ansible inventory sources

See also DEFAULT_HOST_LIST

ANSIBLE_INVENTORY¶

Comma separated list of Ansible inventory sources

See also DEFAULT_HOST_LIST

ANSIBLE_GATHER_TIMEOUT¶

Set the timeout in seconds for the implicit fact gathering.It does not apply to user defined M(setup) tasks.

See also DEFAULT_GATHER_TIMEOUT

ANSIBLE_LIBRARY¶

Colon separated paths in which Ansible will search for Modules.

See also DEFAULT_MODULE_PATH

ANSIBLE_MODULE_ARGS¶

This sets the default arguments to pass to the ansible adhoc binary if no -a is specified.

See also DEFAULT_MODULE_ARGS

ANSIBLE_LOCALHOST_WARNING¶

By default Ansible will issue a warning when there are no hosts in the inventory.These warnings can be silenced by adjusting this setting to False.

See also LOCALHOST_WARNING

ANSIBLE_VAULT_IDENTITY_LIST¶

A list of vault-ids to use by default. Equivalent to multiple –vault-id args. Vault-ids are tried in order.

See also DEFAULT_VAULT_IDENTITY_LIST

ANSIBLE_COLOR_DIFF_ADD¶

Defines the color to use when showing added lines in diffs

See also COLOR_DIFF_ADD

ANSIBLE_COW_WHITELIST¶

White list of cowsay templates that are ‘safe’ to use, set to empty list if you want to enable all installed templates.

See also ANSIBLE_COW_WHITELIST

ANSIBLE_SFTP_BATCH_MODE¶

See also DEFAULT_SFTP_BATCH_MODE

ANSIBLE_INVENTORY_EXPORT¶

Controls if ansible-inventory will accurately reflect Ansible’s view into inventory or its optimized for exporting.

See also INVENTORY_EXPORT

ANSIBLE_TRANSPORT¶

Default connection plugin to use, the ‘smart’ option will toggle between ‘ssh’ and ‘paramiko’ depending on controller OS and ssh versions

See also DEFAULT_TRANSPORT

ANSIBLE_GALAXY_SERVER¶

URL to prepend when roles don’t specify the full URI, assume they are referencing this server as the source.

See also GALAXY_SERVER

ANSIBLE_FORCE_HANDLERS¶

This option controls if notified handlers run on a host even if a failure occurs on that host.When false, the handlers will not run if a failure has occurred on a host.This can also be set per play or on the command line. See Handlers and Failure for more details.

See also DEFAULT_FORCE_HANDLERS

ANSIBLE_SUDO_EXE¶

specify an “sudo” executable, otherwise it relies on PATH.

See also DEFAULT_SUDO_EXE

ANSIBLE_DEBUG¶

Toggles debug output in Ansible. This is very verbose and can hinder multiprocessing. Debug output can also include secret information despite no_log settings being enabled, which means debug mode should not be used in production.

See also DEFAULT_DEBUG

ANSIBLE_STDOUT_CALLBACK¶

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.

See also DEFAULT_STDOUT_CALLBACK

ANSIBLE_COLOR_DIFF_LINES¶

Defines the color to use when showing diffs

See also COLOR_DIFF_LINES

ANSIBLE_FACT_PATH¶

This option allows you to globally configure a custom path for ‘local_facts’ for the implied M(setup) task when using fact gathering.If not set, it will fallback to the default from the M(setup) module: /etc/ansible/facts.d.This does not affect user defined tasks that use the M(setup) module.

See also DEFAULT_FACT_PATH

ANSIBLE_TASK_INCLUDES_STATIC¶

The include tasks can be static or dynamic, this toggles the default expected behaviour if autodetection fails and it is not explicitly set in task.

See also DEFAULT_TASK_INCLUDES_STATIC

ANSIBLE_BECOME_FLAGS¶

Flags to pass to the privilege escalation executable.

See also DEFAULT_BECOME_FLAGS

ANSIBLE_SU_FLAGS¶

Flags to pass to su

See also DEFAULT_SU_FLAGS

ANSIBLE_HTTPAPI_PLUGINS¶

Colon separated paths in which Ansible will search for HttpApi Plugins.

See also DEFAULT_HTTPAPI_PLUGIN_PATH

ANSIBLE_COLOR_WARN¶

Defines the color to use when emitting warning messages

See also COLOR_WARN

ANSIBLE_COLOR_UNREACHABLE¶

Defines the color to use on ‘Unreachable’ status

See also COLOR_UNREACHABLE

ANSIBLE_ASK_SUDO_PASS¶

This controls whether an Ansible playbook should prompt for a sudo password.

See also DEFAULT_ASK_SUDO_PASS

ANSIBLE_SUDO¶

Toggle the use of “sudo” for tasks.

See also DEFAULT_SUDO

ANSIBLE_MODULE_LANG¶

Language locale setting to use for modules when they execute on the target.If empty it tries to set itself to the LANG environment variable on the controller.This is only used if DEFAULT_MODULE_SET_LOCALE is set to true

See also DEFAULT_MODULE_LANG

LIBVIRT_LXC_NOSECLABEL¶

This setting causes libvirt to connect to lxc containers by passing –noseclabel to virsh. This is necessary when running on systems which do not have SELinux.

See also DEFAULT_LIBVIRT_LXC_NOSECLABEL

ANSIBLE_NULL_REPRESENTATION¶

What templating should return as a ‘null’ value. When not set it will let Jinja2 decide.

See also DEFAULT_NULL_REPRESENTATION

ANSIBLE_COLOR_DIFF_REMOVE¶

Defines the color to use when showing removed lines in diffs

See also COLOR_DIFF_REMOVE

ANSIBLE_PRIVATE_ROLE_VARS¶

Makes role variables inaccessible from other roles.This was introduced as a way to reset role variables to default values if a role is used more than once in a playbook.

See also DEFAULT_PRIVATE_ROLE_VARS

ANSIBLE_ENABLE_TASK_DEBUGGER¶

Whether or not to enable the task debugger, this previously was done as a strategy plugin.Now all strategy plugins can inherit this behavior. The debugger defaults to activating whena task is failed on unreachable. Use the debugger keyword for more flexibility.

See also ENABLE_TASK_DEBUGGER

ANSIBLE_COLOR_DEBUG¶

Defines the color to use when emitting debug messages

See also COLOR_DEBUG

ANSIBLE_LOAD_CALLBACK_PLUGINS¶

Controls whether callback plugins are loaded when running /usr/bin/ansible. This may be used to log activity from the command line, send notifications, and so on. Callback plugins are always loaded for ansible-playbook.

See also DEFAULT_LOAD_CALLBACK_PLUGINS

ANSIBLE_SYSLOG_FACILITY¶

Syslog facility to use when Ansible logs to the remote target

See also DEFAULT_SYSLOG_FACILITY

ANSIBLE_PARAMIKO_HOST_KEY_AUTO_ADD¶

See also PARAMIKO_HOST_KEY_AUTO_ADD

ANSIBLE_USE_PERSISTENT_CONNECTIONS¶

Toggles the use of persistence for connections.

See also USE_PERSISTENT_CONNECTIONS

ANSIBLE_VAULT_IDENTITY¶

The label to use for the default vault id label in cases where a vault id label is not provided

See also DEFAULT_VAULT_IDENTITY

ANSIBLE_YAML_FILENAME_EXT¶

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.

See also YAML_FILENAME_EXTENSIONS

ANSIBLE_COLOR_SKIP¶

Defines the color to use when showing ‘Skipped’ task status

See also COLOR_SKIP

ANSIBLE_STRING_TYPE_FILTERS¶

This list of filters avoids ‘type conversion’ when templating variablesUseful when you want to avoid conversion into lists or dictionaries for JSON strings, for example.

See also STRING_TYPE_FILTERS

ANSIBLE_REMOTE_PORT¶

Port to use in remote connections, when blank it will use the connection plugin default.

See also DEFAULT_REMOTE_PORT

ANSIBLE_PLAYBOOK_VARS_ROOT¶

This sets which playbook dirs will be used as a root to process vars plugins, which includes finding host_vars/group_varsThe top option follows the traditional behaviour of using the top playbook in the chain to find the root directory.The bottom option follows the 2.4.0 behaviour of using the current playbook to find the root directory.The all option examines from the first parent to the current playbook.

See also PLAYBOOK_VARS_ROOT

ANSIBLE_ASK_VAULT_PASS¶

This controls whether an Ansible playbook should prompt for a vault password.

See also DEFAULT_ASK_VAULT_PASS

ANSIBLE_PRECEDENCE¶

Allows to change the group variable precedence merge order.

See also VARIABLE_PRECEDENCE

ANSIBLE_HASH_BEHAVIOUR¶

This setting controls how variables merge in Ansible. By default Ansible will override variables in specific precedence orders, as described in Variables. When a variable of higher precedence wins, it will replace the other value.Some users prefer that variables that are hashes (aka ‘dictionaries’ in Python terms) are merged. This setting is called ‘merge’. This is not the default behavior and it does not affect variables whose values are scalars (integers, strings) or arrays. We generally recommend not using this setting unless you think you have an absolute need for it, and playbooks in the official examples repos do not use this settingIn version 2.0 a combine filter was added to allow doing this for a particular variable (described in Filters).

See also DEFAULT_HASH_BEHAVIOUR

ANSIBLE_BECOME_USER¶

The user your login/remote user ‘becomes’ when using privilege escalation, most systems will use ‘root’ when no user is specified.

See also DEFAULT_BECOME_USER

ANSIBLE_ERROR_ON_UNDEFINED_VARS¶

When True, this causes ansible templating to fail steps that reference variable names that are likely typoed.Otherwise, any ‘{{ template_expression }}’ that contains undefined variables will be rendered in a template or ansible action line exactly as written.

See also DEFAULT_UNDEFINED_VAR_BEHAVIOR

ANSIBLE_CACHE_PLUGIN_TIMEOUT¶

Expiration timeout for the cache plugin data

See also CACHE_PLUGIN_TIMEOUT

ANSIBLE_SSH_CONTROL_PATH¶

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.

See also ANSIBLE_SSH_CONTROL_PATH

ANSIBLE_CACHE_PLUGIN_PREFIX¶

Prefix to use for cache plugin files/tables

See also CACHE_PLUGIN_PREFIX

NETWORK_GROUP_MODULES¶

See also NETWORK_GROUP_MODULES

ANSIBLE_LOG_PATH¶

File to which Ansible will log on the controller. When empty logging is disabled.

See also DEFAULT_LOG_PATH

ANSIBLE_RUN_TAGS¶

default list of tags to run in your plays, Skip Tags has precedence.

See also TAGS_RUN

ANSIBLE_SKIP_TAGS¶

default list of tags to skip in your plays, has precedence over Run Tags

See also TAGS_SKIP

ANSIBLE_STRATEGY¶

Set the default strategy used for plays.

See also DEFAULT_STRATEGY

ANSIBLE_DIFF_ALWAYS¶

Configuration toggle to tell modules to show differences when in ‘changed’ status, equivalent to --diff.

See also DIFF_ALWAYS

ANSIBLE_NO_TARGET_SYSLOG¶

Toggle Ansible logging to syslog on the target when it executes tasks.

See also DEFAULT_NO_TARGET_SYSLOG

ANSIBLE_MODULE_SET_LOCALE¶

Controls if we set locale for modules when executing on the target.

See also DEFAULT_MODULE_SET_LOCALE

ANSIBLE_LOOKUP_PLUGINS¶

Colon separated paths in which Ansible will search for Lookup Plugins.

See also DEFAULT_LOOKUP_PLUGIN_PATH

ANSIBLE_ASK_PASS¶

This controls whether an Ansible playbook should prompt for a login password. If using SSH keys for authentication, you probably do not needed to change this setting.

See also DEFAULT_ASK_PASS

ANSIBLE_INVENTORY_UNPARSED_FAILED¶

If ‘true’ unparsed inventory sources become fatal errors, they are warnings otherwise.

See also INVENTORY_UNPARSED_IS_FAILED

ANSIBLE_CALLBACK_WHITELIST¶

List of whitelisted callbacks, not all callbacks need whitelisting, but many of those shipped with Ansible do as we don’t want them activated by default.

See also DEFAULT_CALLBACK_WHITELIST

ANSIBLE_PRIVATE_KEY_FILE¶

Option for connections using a certificate or key file to authenticate, rather than an agent or passwords, you can set the default value here to avoid re-specifying –private-key with every invocation.

See also DEFAULT_PRIVATE_KEY_FILE

ANSIBLE_PERSISTENT_CONTROL_PATH_DIR¶

Path to socket to be used by the connection persistence system.

See also PERSISTENT_CONTROL_PATH_DIR

ANSIBLE_MODULE_UTILS¶

Colon separated paths in which Ansible will search for Module utils files, which are shared by modules.

See also DEFAULT_MODULE_UTILS_PATH

ANSIBLE_ROLES_PATH¶

Colon separated paths in which Ansible will search for Roles.

See also DEFAULT_ROLES_PATH

ANSIBLE_CACHE_PLUGIN_CONNECTION¶

Defines connection or path information for the cache plugin

See also CACHE_PLUGIN_CONNECTION

ANSIBLE_BECOME_EXE¶

executable to use for privilege escalation, otherwise Ansible will depend on PATH

See also DEFAULT_BECOME_EXE

ANSIBLE_SSH_RETRIES¶

Number of attempts to establish a connection before we give up and report the host as ‘UNREACHABLE’

See also ANSIBLE_SSH_RETRIES

ANSIBLE_COLOR_DEPRECATE¶

Defines the color to use when emitting deprecation messages

See also COLOR_DEPRECATE

ANSIBLE_NETCONF_PLUGINS¶

Colon separated paths in which Ansible will search for Netconf Plugins.

See also DEFAULT_NETCONF_PLUGIN_PATH

ANSIBLE_EXECUTABLE¶

This indicates the command to use to spawn a shell under for Ansible’s execution needs on a target. Users may need to change this in rare instances when shell usage is constrained, but in most cases it may be left as is.

See also DEFAULT_EXECUTABLE

ANSIBLE_DEPRECATION_WARNINGS¶

Toggle to control the showing of deprecation warnings

See also DEPRECATION_WARNINGS

ANSIBLE_NOCOLOR¶

This setting allows suppressing colorizing output, which is used to give a better indication of failure and status information.

See also ANSIBLE_NOCOLOR

ANSIBLE_PARAMIKO_LOOK_FOR_KEYS¶

See also PARAMIKO_LOOK_FOR_KEYS

ANSIBLE_RETRY_FILES_ENABLED¶

This controls whether a failed Ansible playbook should create a .retry file.

See also RETRY_FILES_ENABLED

ANSIBLE_SUDO_USER¶

User you become when using “sudo”, leaving it blank will use the default configured on the target (normally root)

See also DEFAULT_SUDO_USER

ANSIBLE_STRATEGY_PLUGINS¶

Colon separated paths in which Ansible will search for Strategy Plugins.

See also DEFAULT_STRATEGY_PLUGIN_PATH

ANSIBLE_SSH_CONTROL_PATH_DIR¶

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.

See also ANSIBLE_SSH_CONTROL_PATH_DIR

ANSIBLE_INVENTORY_IGNORE¶

List of extensions to ignore when using a directory as an inventory source

See also INVENTORY_IGNORE_EXTS

ANSIBLE_GALAXY_IGNORE¶

If set to yes, ansible-galaxy will not validate TLS certificates. This can be useful for testing against a server with a self-signed certificate.

See also GALAXY_IGNORE_CERTS

ANSIBLE_RETRY_FILES_SAVE_PATH¶

This sets the path in which Ansible will save .retry files when a playbook fails and retry files are enabled.

See also RETRY_FILES_SAVE_PATH

ANSIBLE_SHOW_CUSTOM_STATS¶

This adds the custom stats set via the set_stats plugin to the default output

See also SHOW_CUSTOM_STATS

ANSIBLE_VAULT_ENCRYPT_IDENTITY¶

The vault_id to use for encrypting by default. If multiple vault_ids are provided, this specifies which to use for encryption. The –encrypt-vault-id cli option overrides the configured value.

See also DEFAULT_VAULT_ENCRYPT_IDENTITY

ANSIBLE_COW_SELECTION¶

This allows you to chose a specific cowsay stencil for the banners or use ‘random’ to cycle through them.

See also ANSIBLE_COW_SELECTION

ANSIBLE_GALAXY_TOKEN¶

GitHub personal access token

See also GALAXY_TOKEN

ANSIBLE_FORKS¶

Maximum number of forks Ansible will use to execute tasks on target hosts.

See also DEFAULT_FORKS

ANSIBLE_SU¶

Toggle the use of “su” for tasks.

See also DEFAULT_SU

ANSIBLE_GATHER_SUBSET¶

Set the gather_subset option for the M(setup) task in the implicit fact gathering. See the module documentation for specifics.It does not apply to user defined M(setup) tasks.

See also DEFAULT_GATHER_SUBSET

ANSIBLE_COLOR_HIGHLIGHT¶

Defines the color to use for highlighting

See also COLOR_HIGHLIGHT

ANSIBLE_FORCE_COLOR¶

This options forces color mode even when running without a TTY or the “nocolor” setting is True.

See also ANSIBLE_FORCE_COLOR

ANSIBLE_AGNOSTIC_BECOME_PROMPT¶

Display an agnostic become prompt instead of displaying a prompt containing the command line supplied become method

See also AGNOSTIC_BECOME_PROMPT

ANSIBLE_SU_EXE¶

specify an “su” executable, otherwise it relies on PATH.

See also DEFAULT_SU_EXE

ANSIBLE_ANY_ERRORS_FATAL¶

Sets the default value for the any_errors_fatal keyword, if True, Task failures will be considered fatal errors.

See also ANY_ERRORS_FATAL

ANSIBLE_SYSTEM_WARNINGS¶

Allows disabling of warnings related to potential issues on the system running ansible itself (not on the managed hosts)These may include warnings about 3rd party packages or other conditions that should be resolved if possible.

See also SYSTEM_WARNINGS

ANSIBLE_SSH_TRANSFER_METHOD¶

unused?

See also DEFAULT_SSH_TRANSFER_METHOD

ANSIBLE_SSH_EXECUTABLE¶

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.

See also ANSIBLE_SSH_EXECUTABLE

ANSIBLE_ACTION_WARNINGS¶

By default Ansible will issue a warning when recieved from a task action (module or action plugin)These warnings can be silenced by adjusting this setting to False.

See also ACTION_WARNINGS

ANSIBLE_LOG_FILTER¶

List of logger names to filter out of the log file

See also DEFAULT_LOG_FILTER