mirror of
https://github.com/ansible-collections/community.general.git
synced 2024-09-14 20:13:21 +02:00
373b1dcf59
* Docs refactor as outlined in https://github.com/ansible/proposals/issues/79. Moves content into 'guides'; refactors TOC; fixes CSS; design tweaks to layout and CSS; fixes generated plugin, CLI and module docs to fix links accodingly; more. * Adding extra blank line for shippable
55 lines
1.9 KiB
ReStructuredText
55 lines
1.9 KiB
ReStructuredText
*******************
|
|
Configuring Ansible
|
|
*******************
|
|
|
|
.. contents:: Topics
|
|
|
|
|
|
This topic describes how to control Ansible settings.
|
|
|
|
|
|
.. _the_configuration_file:
|
|
|
|
Configuration file
|
|
==================
|
|
|
|
Certain settings in Ansible are adjustable via a configuration file (ansible.cfg).
|
|
The stock configuration should be sufficient for most users, but there may be reasons you would want to change them.
|
|
|
|
.. _getting_the_latest_configuration:
|
|
|
|
Getting the latest configuration
|
|
================================
|
|
|
|
If installing Ansible from a package manager, the latest ansible.cfg file should be present in /etc/ansible, possibly
|
|
as a ".rpmnew" file (or other) as appropriate in the case of updates.
|
|
|
|
If you installed Ansible from pip or from source, you may want to create this file in order to override
|
|
default settings in Ansible.
|
|
|
|
An `example file is available on Github <https://raw.github.com/ansible/ansible/devel/examples/ansible.cfg>`_.
|
|
|
|
For more details and a full listing of available configurations go to :ref:`configuration_settings`. Starting with Ansible version 2.4, you can use the :doc:`ansible-config` command line utility to list your available options and inspect the current values.
|
|
|
|
For in-depth details, see :doc:`_config`.
|
|
|
|
|
|
Environmental configuration
|
|
===========================
|
|
|
|
Ansible also allows configuration of settings using environment variables.
|
|
If these environment variables are set, they will override any setting loaded from the configuration file.
|
|
|
|
You can get a full listing of available environment variables from :doc:`_config`.
|
|
|
|
.. _command_line_configuration:
|
|
|
|
Command line options
|
|
====================
|
|
|
|
Not all configuration options are present in the command line, just the ones deemed most useful or common.
|
|
Settings in the command line will override those passed through the configuration file and the environment.
|
|
|
|
The full list of options available is in :ref:`ansible-playbook` and :ref:`ansible`.
|
|
|
|
|