correction syntaxe
[lhc/ansible.git] / ansible.cfg
1 [defaults]
2 # (boolean) By default Ansible will issue a warning when received from a task action (module or action plugin)
3 # These warnings can be silenced by adjusting this setting to False.
4 ;action_warnings=True
5
6 # (list) Accept list of cowsay templates that are 'safe' to use, set to empty list if you want to enable all installed templates.
7 ;cowsay_enabled_stencils=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
8
9 # (string) Specify a custom cowsay path or swap in your cowsay implementation of choice
10 ;cowpath=
11
12 # (string) This allows you to chose a specific cowsay stencil for the banners or use 'random' to cycle through them.
13 ;cow_selection=default
14
15 # (boolean) This option forces color mode even when running without a TTY or the "nocolor" setting is True.
16 ;force_color=False
17
18 # (path) The default root path for Ansible config files on the controller.
19 ;home=~/.ansible
20
21 # (boolean) This setting allows suppressing colorizing output, which is used to give a better indication of failure and status information.
22 ;nocolor=False
23
24 # (boolean) If you have cowsay installed but want to avoid the 'cows' (why????), use this.
25 ;nocows=False
26
27 # (boolean) Sets the default value for the any_errors_fatal keyword, if True, Task failures will be considered fatal errors.
28 ;any_errors_fatal=False
29
30 # (path) The password file to use for the become plugin. --become-password-file.
31 # If executable, it will be run and the resulting stdout will be used as the password.
32 ;become_password_file=
33
34 # (pathspec) Colon separated paths in which Ansible will search for Become Plugins.
35 ;become_plugins={{ ANSIBLE_HOME ~ "/plugins/become:/usr/share/ansible/plugins/become" }}
36
37 # (string) Chooses which cache plugin to use, the default 'memory' is ephemeral.
38 ;fact_caching=memory
39
40 # (string) Defines connection or path information for the cache plugin
41 ;fact_caching_connection=
42
43 # (string) Prefix to use for cache plugin files/tables
44 ;fact_caching_prefix=ansible_facts
45
46 # (integer) Expiration timeout for the cache plugin data
47 ;fact_caching_timeout=86400
48
49 # (list) List of enabled callbacks, not all callbacks need enabling, but many of those shipped with Ansible do as we don't want them activated by default.
50 ;callbacks_enabled=
51
52 # (string) When a collection is loaded that does not support the running Ansible version (with the collection metadata key `requires_ansible`).
53 ;collections_on_ansible_version_mismatch=warning
54
55 # (pathspec) Colon separated paths in which Ansible will search for collections content. Collections must be in nested *subdirectories*, not directly in these directories. For example, if ``COLLECTIONS_PATHS`` includes ``'{{ ANSIBLE_HOME ~ "/collections" }}'``, and you want to add ``my.collection`` to that directory, it must be saved as ``'{{ ANSIBLE_HOME} ~ "/collections/ansible_collections/my/collection" }}'``.
56
57 ;collections_path={{ ANSIBLE_HOME ~ "/collections:/usr/share/ansible/collections" }}
58
59 # (boolean) A boolean to enable or disable scanning the sys.path for installed collections
60 ;collections_scan_sys_path=True
61
62 # (path) The password file to use for the connection plugin. --connection-password-file.
63 ;connection_password_file=
64
65 # (pathspec) Colon separated paths in which Ansible will search for Action Plugins.
66 ;action_plugins={{ ANSIBLE_HOME ~ "/plugins/action:/usr/share/ansible/plugins/action" }}
67
68 # (boolean) When enabled, this option allows lookup plugins (whether used in variables as ``{{lookup('foo')}}`` or as a loop as with_foo) to return data that is not marked 'unsafe'.
69 # By default, such data is marked as unsafe to prevent the templating engine from evaluating any jinja2 templating language, as this could represent a security risk. This option is provided to allow for backward compatibility, however users should first consider adding allow_unsafe=True to any lookups which may be expected to contain data which may be run through the templating engine late
70 ;allow_unsafe_lookups=False
71
72 # (boolean) This controls whether an Ansible playbook should prompt for a login password. If using SSH keys for authentication, you probably do not need to change this setting.
73 ;ask_pass=False
74
75 # (boolean) This controls whether an Ansible playbook should prompt for a vault password.
76 ;ask_vault_pass=False
77
78 # (pathspec) Colon separated paths in which Ansible will search for Cache Plugins.
79 ;cache_plugins={{ ANSIBLE_HOME ~ "/plugins/cache:/usr/share/ansible/plugins/cache" }}
80
81 # (pathspec) Colon separated paths in which Ansible will search for Callback Plugins.
82 ;callback_plugins={{ ANSIBLE_HOME ~ "/plugins/callback:/usr/share/ansible/plugins/callback" }}
83
84 # (pathspec) Colon separated paths in which Ansible will search for Cliconf Plugins.
85 ;cliconf_plugins={{ ANSIBLE_HOME ~ "/plugins/cliconf:/usr/share/ansible/plugins/cliconf" }}
86
87 # (pathspec) Colon separated paths in which Ansible will search for Connection Plugins.
88 ;connection_plugins={{ ANSIBLE_HOME ~ "/plugins/connection:/usr/share/ansible/plugins/connection" }}
89
90 # (boolean) 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.
91 ;debug=False
92
93 # (string) 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.
94 ;executable=/bin/sh
95
96 # (string) This option allows you to globally configure a custom path for 'local_facts' for the implied :ref:`ansible_collections.ansible.builtin.setup_module` task when using fact gathering.
97 # If not set, it will fallback to the default from the ``ansible.builtin.setup`` module: ``/etc/ansible/facts.d``.
98 # This does **not** affect user defined tasks that use the ``ansible.builtin.setup`` module.
99 # The real action being created by the implicit task is currently ``ansible.legacy.gather_facts`` module, which then calls the configured fact modules, by default this will be ``ansible.builtin.setup`` for POSIX systems but other platforms might have different defaults.
100 ;fact_path=
101
102 # (pathspec) Colon separated paths in which Ansible will search for Jinja2 Filter Plugins.
103 ;filter_plugins={{ ANSIBLE_HOME ~ "/plugins/filter:/usr/share/ansible/plugins/filter" }}
104
105 # (boolean) This option controls if notified handlers run on a host even if a failure occurs on that host.
106 # When false, the handlers will not run if a failure has occurred on a host.
107 # This can also be set per play or on the command line. See Handlers and Failure for more details.
108 ;force_handlers=False
109
110 # (integer) Maximum number of forks Ansible will use to execute tasks on target hosts.
111 ;forks=5
112
113 # (string) This setting controls the default policy of fact gathering (facts discovered about remote systems).
114 # This option can be useful for those wishing to save fact gathering time. Both 'smart' and 'explicit' will use the cache plugin.
115 gathering=explicit
116
117 # (list) Set the `gather_subset` option for the :ref:`ansible_collections.ansible.builtin.setup_module` task in the implicit fact gathering. See the module documentation for specifics.
118 # It does **not** apply to user defined ``ansible.builtin.setup`` tasks.
119 ;gather_subset=
120
121 # (integer) Set the timeout in seconds for the implicit fact gathering, see the module documentation for specifics.
122 # It does **not** apply to user defined :ref:`ansible_collections.ansible.builtin.setup_module` tasks.
123 ;gather_timeout=
124
125 # (string) This setting controls how duplicate definitions of dictionary variables (aka hash, map, associative array) are handled in Ansible.
126 # This does not affect variables whose values are scalars (integers, strings) or arrays.
127 # **WARNING**, changing this setting is not recommended as this is fragile and makes your content (plays, roles, collections) non portable, leading to continual confusion and misuse. Don't change this setting unless you think you have an absolute need for it.
128 # We recommend avoiding reusing variable names and relying on the ``combine`` filter and ``vars`` and ``varnames`` lookups to create merged versions of the individual variables. In our experience this is rarely really needed and a sign that too much complexity has been introduced into the data structures and plays.
129 # For some uses you can also look into custom vars_plugins to merge on input, even substituting the default ``host_group_vars`` that is in charge of parsing the ``host_vars/`` and ``group_vars/`` directories. Most users of this setting are only interested in inventory scope, but the setting itself affects all sources and makes debugging even harder.
130 # All playbooks and roles in the official examples repos assume the default for this setting.
131 # Changing the setting to ``merge`` applies across variable sources, but many sources will internally still overwrite the variables. For example ``include_vars`` will dedupe variables internally before updating Ansible, with 'last defined' overwriting previous definitions in same file.
132 # The Ansible project recommends you **avoid ``merge`` for new projects.**
133 # It is the intention of the Ansible developers to eventually deprecate and remove this setting, but it is being kept as some users do heavily rely on it. New projects should **avoid 'merge'**.
134 ;hash_behaviour=replace
135
136 # (pathlist) Comma separated list of Ansible inventory sources
137 inventory=inventory.yml
138
139 # (pathspec) Colon separated paths in which Ansible will search for HttpApi Plugins.
140 ;httpapi_plugins={{ ANSIBLE_HOME ~ "/plugins/httpapi:/usr/share/ansible/plugins/httpapi" }}
141
142 # (float) This sets the interval (in seconds) of Ansible internal processes polling each other. Lower values improve performance with large playbooks at the expense of extra CPU load. Higher values are more suitable for Ansible usage in automation scenarios, when UI responsiveness is not required but CPU usage might be a concern.
143 # The default corresponds to the value hardcoded in Ansible <= 2.1
144 ;internal_poll_interval=0.001
145
146 # (pathspec) Colon separated paths in which Ansible will search for Inventory Plugins.
147 ;inventory_plugins={{ ANSIBLE_HOME ~ "/plugins/inventory:/usr/share/ansible/plugins/inventory" }}
148
149 # (string) This is a developer-specific feature that allows enabling additional Jinja2 extensions.
150 # See the Jinja2 documentation for details. If you do not know what these do, you probably don't need to change this setting :)
151 ;jinja2_extensions=[]
152
153 # (boolean) This option preserves variable types during template operations.
154 ;jinja2_native=False
155
156 # (boolean) Enables/disables the cleaning up of the temporary files Ansible used to execute the tasks on the remote.
157 # If this option is enabled it will disable ``ANSIBLE_PIPELINING``.
158 ;keep_remote_files=False
159
160 # (boolean) 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``.
161 ;bin_ansible_callbacks=False
162
163 # (tmppath) Temporary directory for Ansible to use on the controller.
164 ;local_tmp={{ ANSIBLE_HOME ~ "/tmp" }}
165
166 # (list) List of logger names to filter out of the log file
167 ;log_filter=
168
169 # (path) File to which Ansible will log on the controller. When empty logging is disabled.
170 ;log_path=
171
172 # (pathspec) Colon separated paths in which Ansible will search for Lookup Plugins.
173 ;lookup_plugins={{ ANSIBLE_HOME ~ "/plugins/lookup:/usr/share/ansible/plugins/lookup" }}
174
175 # (string) Sets the macro for the 'ansible_managed' variable available for :ref:`ansible_collections.ansible.builtin.template_module` and :ref:`ansible_collections.ansible.windows.win_template_module`. This is only relevant for those two modules.
176 ;ansible_managed=Ansible managed
177
178 # (string) This sets the default arguments to pass to the ``ansible`` adhoc binary if no ``-a`` is specified.
179 ;module_args=
180
181 # (string) Compression scheme to use when transferring Python modules to the target.
182 ;module_compression=ZIP_DEFLATED
183
184 # (string) Module to use with the ``ansible`` AdHoc command, if none is specified via ``-m``.
185 ;module_name=command
186
187 # (pathspec) Colon separated paths in which Ansible will search for Modules.
188 ;library={{ ANSIBLE_HOME ~ "/plugins/modules:/usr/share/ansible/plugins/modules" }}
189
190 # (pathspec) Colon separated paths in which Ansible will search for Module utils files, which are shared by modules.
191 ;module_utils={{ ANSIBLE_HOME ~ "/plugins/module_utils:/usr/share/ansible/plugins/module_utils" }}
192
193 # (pathspec) Colon separated paths in which Ansible will search for Netconf Plugins.
194 ;netconf_plugins={{ ANSIBLE_HOME ~ "/plugins/netconf:/usr/share/ansible/plugins/netconf" }}
195
196 # (boolean) Toggle Ansible's display and logging of task details, mainly used to avoid security disclosures.
197 ;no_log=False
198
199 # (boolean) Toggle Ansible logging to syslog on the target when it executes tasks. On Windows hosts this will disable a newer style PowerShell modules from writing to the event log.
200 ;no_target_syslog=False
201
202 # (raw) What templating should return as a 'null' value. When not set it will let Jinja2 decide.
203 ;null_representation=
204
205 # (integer) 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.
206 ;poll_interval=15
207
208 # (path) 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.
209 ;private_key_file=
210
211 # (boolean) Makes role variables inaccessible from other roles.
212 # This was introduced as a way to reset role variables to default values if a role is used more than once in a playbook.
213 ;private_role_vars=False
214
215 # (integer) Port to use in remote connections, when blank it will use the connection plugin default.
216 ;remote_port=
217
218 # (string) Sets the login user for the target machines
219 # When blank it uses the connection plugin's default, normally the user currently executing Ansible.
220 ;remote_user=
221
222 # (pathspec) Colon separated paths in which Ansible will search for Roles.
223 ;roles_path={{ ANSIBLE_HOME ~ "/roles:/usr/share/ansible/roles:/etc/ansible/roles" }}
224
225 # (string) Set the main callback used to display Ansible output. You can only have one at a time.
226 # You can have many other callbacks, but just one can be in charge of stdout.
227 # See :ref:`callback_plugins` for a list of available options.
228 ;stdout_callback=default
229
230 # (string) Set the default strategy used for plays.
231 ;strategy=linear
232
233 # (pathspec) Colon separated paths in which Ansible will search for Strategy Plugins.
234 ;strategy_plugins={{ ANSIBLE_HOME ~ "/plugins/strategy:/usr/share/ansible/plugins/strategy" }}
235
236 # (boolean) Toggle the use of "su" for tasks.
237 ;su=False
238
239 # (string) Syslog facility to use when Ansible logs to the remote target
240 ;syslog_facility=LOG_USER
241
242 # (pathspec) Colon separated paths in which Ansible will search for Terminal Plugins.
243 ;terminal_plugins={{ ANSIBLE_HOME ~ "/plugins/terminal:/usr/share/ansible/plugins/terminal" }}
244
245 # (pathspec) Colon separated paths in which Ansible will search for Jinja2 Test Plugins.
246 ;test_plugins={{ ANSIBLE_HOME ~ "/plugins/test:/usr/share/ansible/plugins/test" }}
247
248 # (integer) This is the default timeout for connection plugins to use.
249 ;timeout=10
250
251 # (string) Default connection plugin to use, the 'smart' option will toggle between 'ssh' and 'paramiko' depending on controller OS and ssh versions
252 ;transport=smart
253
254 # (boolean) When True, this causes ansible templating to fail steps that reference variable names that are likely typoed.
255 # Otherwise, any '{{ template_expression }}' that contains undefined variables will be rendered in a template or ansible action line exactly as written.
256 ;error_on_undefined_vars=True
257
258 # (pathspec) Colon separated paths in which Ansible will search for Vars Plugins.
259 ;vars_plugins={{ ANSIBLE_HOME ~ "/plugins/vars:/usr/share/ansible/plugins/vars" }}
260
261 # (string) 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.
262 ;vault_encrypt_identity=
263
264 # (string) The label to use for the default vault id label in cases where a vault id label is not provided
265 ;vault_identity=default
266
267 # (list) A list of vault-ids to use by default. Equivalent to multiple --vault-id args. Vault-ids are tried in order.
268 ;vault_identity_list=
269
270 # (string) If true, decrypting vaults with a vault id will only try the password from the matching vault-id
271 ;vault_id_match=False
272
273 # (path) The vault password file to use. Equivalent to --vault-password-file or --vault-id
274 # If executable, it will be run and the resulting stdout will be used as the password.
275 ;vault_password_file=
276
277 # (integer) Sets the default verbosity, equivalent to the number of ``-v`` passed in the command line.
278 ;verbosity=0
279
280 # (boolean) Toggle to control the showing of deprecation warnings
281 ;deprecation_warnings=True
282
283 # (boolean) Toggle to control showing warnings related to running devel
284 ;devel_warning=True
285
286 # (boolean) 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.
287 # 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.
288 # 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 sensitive values See How do I keep secret data in my playbook? for more information.
289 ;display_args_to_stdout=False
290
291 # (boolean) Toggle to control displaying skipped task/host entries in a task in the default callback
292 ;display_skipped_hosts=True
293
294 # (string) Root docsite URL used to generate docs URLs in warning/error text; must be an absolute URL with valid scheme and trailing slash.
295 ;docsite_root_url=https://docs.ansible.com/ansible-core/
296
297 # (pathspec) Colon separated paths in which Ansible will search for Documentation Fragments Plugins.
298 ;doc_fragment_plugins={{ ANSIBLE_HOME ~ "/plugins/doc_fragments:/usr/share/ansible/plugins/doc_fragments" }}
299
300 # (string) By default Ansible will issue a warning when a duplicate dict key is encountered in YAML.
301 # These warnings can be silenced by adjusting this setting to False.
302 ;duplicate_dict_key=warn
303
304 # (boolean) Whether or not to enable the task debugger, this previously was done as a strategy plugin.
305 # Now all strategy plugins can inherit this behavior. The debugger defaults to activating when
306 # a task is failed on unreachable. Use the debugger keyword for more flexibility.
307 ;enable_task_debugger=False
308
309 # (boolean) Toggle to allow missing handlers to become a warning instead of an error when notifying.
310 ;error_on_missing_handler=True
311
312 # (list) Which modules to run during a play's fact gathering stage, using the default of 'smart' will try to figure it out based on connection type.
313 # If adding your own modules but you still want to use the default Ansible facts, you will want to include 'setup' or corresponding network module to the list (if you add 'smart', Ansible will also figure it out).
314 # This does not affect explicit calls to the 'setup' module, but does always affect the 'gather_facts' action (implicit or explicit).
315 ;facts_modules=smart
316
317 # (boolean) Set this to "False" if you want to avoid host key checking by the underlying tools Ansible uses to connect to the host
318 ;host_key_checking=True
319
320 # (boolean) Facts are available inside the `ansible_facts` variable, this setting also pushes them as their own vars in the main namespace.
321 # Unlike inside the `ansible_facts` dictionary, these will have an `ansible_` prefix.
322 ;inject_facts_as_vars=True
323
324 # (string) Path to the Python interpreter to be used for module execution on remote targets, or an automatic discovery mode. Supported discovery modes are ``auto`` (the default), ``auto_silent``, ``auto_legacy``, and ``auto_legacy_silent``. All discovery modes employ a lookup table to use the included system Python (on distributions known to include one), falling back to a fixed ordered list of well-known Python interpreter locations if a platform-specific default is not available. The fallback behavior will issue a warning that the interpreter should be set explicitly (since interpreters installed later may change which one is used). This warning behavior can be disabled by setting ``auto_silent`` or ``auto_legacy_silent``. The value of ``auto_legacy`` provides all the same behavior, but for backwards-compatibility with older Ansible releases that always defaulted to ``/usr/bin/python``, will use that interpreter if present.
325 ;interpreter_python=auto
326
327 # (boolean) If 'false', invalid attributes for a task will result in warnings instead of errors
328 ;invalid_task_attribute_failed=True
329
330 # (boolean) Toggle to control showing warnings related to running a Jinja version older than required for jinja2_native
331 ;jinja2_native_warning=True
332
333 # (boolean) By default Ansible will issue a warning when there are no hosts in the inventory.
334 # These warnings can be silenced by adjusting this setting to False.
335 ;localhost_warning=True
336
337 # (int) Maximum size of files to be considered for diff display
338 ;max_diff_size=104448
339
340 # (list) List of extensions to ignore when looking for modules to load
341 # This is for rejecting script and binary module fallback extensions
342 ;module_ignore_exts={{(REJECT_EXTS + ('.yaml', '.yml', '.ini'))}}
343
344 # (bool) Enables whether module responses are evaluated for containing non UTF-8 data
345 # Disabling this may result in unexpected behavior
346 # Only ansible-core should evaluate this configuration
347 ;module_strict_utf8_response=True
348
349 # (list) TODO: write it
350 ;network_group_modules=eos, nxos, ios, iosxr, junos, enos, ce, vyos, sros, dellos9, dellos10, dellos6, asa, aruba, aireos, bigip, ironware, onyx, netconf, exos, voss, slxos
351
352 # (boolean) Previously Ansible would only clear some of the plugin loading caches when loading new roles, this led to some behaviours in which a plugin loaded in previous plays would be unexpectedly 'sticky'. This setting allows to return to that behaviour.
353 ;old_plugin_cache_clear=False
354
355 # (path) A number of non-playbook CLIs have a ``--playbook-dir`` argument; this sets the default value for it.
356 ;playbook_dir=
357
358 # (string) This sets which playbook dirs will be used as a root to process vars plugins, which includes finding host_vars/group_vars
359 ;playbook_vars_root=top
360
361 # (path) A path to configuration for filtering which plugins installed on the system are allowed to be used.
362 # See :ref:`plugin_filtering_config` for details of the filter file's format.
363 # The default is /etc/ansible/plugin_filters.yml
364 ;plugin_filters_cfg=
365
366 # (string) Attempts to set RLIMIT_NOFILE soft limit to the specified value when executing Python modules (can speed up subprocess usage on Python 2.x. See https://bugs.python.org/issue11284). The value will be limited by the existing hard limit. Default value of 0 does not attempt to adjust existing system-defined limits.
367 ;python_module_rlimit_nofile=0
368
369 # (bool) This controls whether a failed Ansible playbook should create a .retry file.
370 ;retry_files_enabled=False
371
372 # (path) This sets the path in which Ansible will save .retry files when a playbook fails and retry files are enabled.
373 # This file will be overwritten after each run with the list of failed hosts from all plays.
374 ;retry_files_save_path=
375
376 # (str) This setting can be used to optimize vars_plugin usage depending on user's inventory size and play selection.
377 ;run_vars_plugins=demand
378
379 # (bool) This adds the custom stats set via the set_stats plugin to the default output
380 ;show_custom_stats=False
381
382 # (string) Action to take when a module parameter value is converted to a string (this does not affect variables). For string parameters, values such as '1.00', "['a', 'b',]", and 'yes', 'y', etc. will be converted by the YAML parser unless fully quoted.
383 # Valid options are 'error', 'warn', and 'ignore'.
384 # Since 2.8, this option defaults to 'warn' but will change to 'error' in 2.12.
385 ;string_conversion_action=warn
386
387 # (boolean) Allows disabling of warnings related to potential issues on the system running ansible itself (not on the managed hosts)
388 # These may include warnings about 3rd party packages or other conditions that should be resolved if possible.
389 ;system_warnings=True
390
391 # (boolean) This option defines whether the task debugger will be invoked on a failed task when ignore_errors=True is specified.
392 # True specifies that the debugger will honor ignore_errors, False will not honor ignore_errors.
393 ;task_debugger_ignore_errors=True
394
395 # (integer) Set the maximum time (in seconds) that a task can run for.
396 # If set to 0 (the default) there is no timeout.
397 ;task_timeout=0
398
399 # (string) Make ansible transform invalid characters in group names supplied by inventory sources.
400 ;force_valid_group_names=never
401
402 # (boolean) Toggles the use of persistence for connections.
403 ;use_persistent_connections=False
404
405 # (bool) A toggle to disable validating a collection's 'metadata' entry for a module_defaults action group. Metadata containing unexpected fields or value types will produce a warning when this is True.
406 ;validate_action_group_metadata=True
407
408 # (list) Accept list for variable plugins that require it.
409 ;vars_plugins_enabled=host_group_vars
410
411 # (list) Allows to change the group variable precedence merge order.
412 ;precedence=all_inventory, groups_inventory, all_plugins_inventory, all_plugins_play, groups_plugins_inventory, groups_plugins_play
413
414 # (string) The salt to use for the vault encryption. If it is not provided, a random salt will be used.
415 ;vault_encrypt_salt=
416
417 # (bool) Force 'verbose' option to use stderr instead of stdout
418 ;verbose_to_stderr=False
419
420 # (integer) For asynchronous tasks in Ansible (covered in Asynchronous Actions and Polling), this is how long, in seconds, to wait for the task spawned by Ansible to connect back to the named pipe used on Windows systems. The default is 5 seconds. This can be too low on slower systems, or systems under heavy load.
421 # This is not the total time an async command can run for, but is a separate timeout to wait for an async command to start. The task will only start to be timed against its async_timeout once it has connected to the pipe, so the overall maximum duration the task can take will be extended by the amount specified here.
422 ;win_async_startup_timeout=5
423
424 # (list) Check all of these extensions when looking for 'variable' files which should be YAML or JSON or vaulted versions of these.
425 # This affects vars_files, include_vars, inventory and vars plugins among others.
426 ;yaml_valid_extensions=.yml, .yaml, .json
427
428
429 [privilege_escalation]
430 # (boolean) Display an agnostic become prompt instead of displaying a prompt containing the command line supplied become method
431 ;agnostic_become_prompt=True
432
433 # (boolean) This setting controls if become is skipped when remote user and become user are the same. I.E root sudo to root.
434 # If executable, it will be run and the resulting stdout will be used as the password.
435 ;become_allow_same_user=False
436
437 # (boolean) Toggles the use of privilege escalation, allowing you to 'become' another user after login.
438 ;become=True
439
440 # (boolean) Toggle to prompt for privilege escalation password.
441 become_ask_pass=True
442
443 # (string) executable to use for privilege escalation, otherwise Ansible will depend on PATH
444 ;become_exe=
445
446 # (string) Flags to pass to the privilege escalation executable.
447 ;become_flags=
448
449 # (string) Privilege escalation method to use when `become` is enabled.
450 ;become_method=sudo
451
452 # (string) The user your login/remote user 'becomes' when using privilege escalation, most systems will use 'root' when no user is specified.
453 ;become_user=root
454
455
456 [persistent_connection]
457 # (path) Specify where to look for the ansible-connection script. This location will be checked before searching $PATH.
458 # If null, ansible will start with the same directory as the ansible script.
459 ;ansible_connection_path=
460
461 # (int) This controls the amount of time to wait for response from remote device before timing out persistent connection.
462 ;command_timeout=30
463
464 # (integer) This controls the retry timeout for persistent connection to connect to the local domain socket.
465 ;connect_retry_timeout=15
466
467 # (integer) This controls how long the persistent connection will remain idle before it is destroyed.
468 ;connect_timeout=30
469
470 # (path) Path to socket to be used by the connection persistence system.
471 ;control_path_dir={{ ANSIBLE_HOME ~ "/pc" }}
472
473
474 [connection]
475 # (boolean) This is a global option, each connection plugin can override either by having more specific options or not supporting pipelining at all.
476 # 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.
477 # It can result in a very significant performance improvement when enabled.
478 # 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.
479 # This setting will be disabled if ``ANSIBLE_KEEP_REMOTE_FILES`` is enabled.
480 ;pipelining=False
481
482
483 [colors]
484 # (string) Defines the color to use on 'Changed' task status
485 ;changed=yellow
486
487 # (string) Defines the default color to use for ansible-console
488 ;console_prompt=white
489
490 # (string) Defines the color to use when emitting debug messages
491 ;debug=dark gray
492
493 # (string) Defines the color to use when emitting deprecation messages
494 ;deprecate=purple
495
496 # (string) Defines the color to use when showing added lines in diffs
497 ;diff_add=green
498
499 # (string) Defines the color to use when showing diffs
500 ;diff_lines=cyan
501
502 # (string) Defines the color to use when showing removed lines in diffs
503 ;diff_remove=red
504
505 # (string) Defines the color to use when emitting error messages
506 ;error=red
507
508 # (string) Defines the color to use for highlighting
509 ;highlight=white
510
511 # (string) Defines the color to use when showing 'OK' task status
512 ;ok=green
513
514 # (string) Defines the color to use when showing 'Skipped' task status
515 ;skip=cyan
516
517 # (string) Defines the color to use on 'Unreachable' status
518 ;unreachable=bright red
519
520 # (string) Defines the color to use when emitting verbose messages. i.e those that show with '-v's.
521 ;verbose=blue
522
523 # (string) Defines the color to use when emitting warning messages
524 ;warn=bright purple
525
526
527 [selinux]
528 # (boolean) 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.
529 ;libvirt_lxc_noseclabel=False
530
531 # (list) 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.
532 # Data corruption may occur and writes are not always verified when a filesystem is in the list.
533 ;special_context_filesystems=fuse, nfs, vboxsf, ramfs, 9p, vfat
534
535
536 [diff]
537 # (bool) Configuration toggle to tell modules to show differences when in 'changed' status, equivalent to ``--diff``.
538 ;always=False
539
540 # (integer) How many lines of context to show when displaying the differences between files.
541 ;context=3
542
543
544 [galaxy]
545 # (path) The directory that stores cached responses from a Galaxy server.
546 # This is only used by the ``ansible-galaxy collection install`` and ``download`` commands.
547 # Cache files inside this dir will be ignored if they are world writable.
548 ;cache_dir={{ ANSIBLE_HOME ~ "/galaxy_cache" }}
549
550 # (path) Collection skeleton directory to use as a template for the ``init`` action in ``ansible-galaxy collection``, same as ``--collection-skeleton``.
551 ;collection_skeleton=
552
553 # (list) patterns of files to ignore inside a Galaxy collection skeleton directory
554 ;collection_skeleton_ignore=^.git$, ^.*/.git_keep$
555
556 # (bool) Disable GPG signature verification during collection installation.
557 ;disable_gpg_verify=False
558
559 # (bool) Some steps in ``ansible-galaxy`` display a progress wheel which can cause issues on certain displays or when outputting the stdout to a file.
560 # This config option controls whether the display wheel is shown or not.
561 # The default is to show the display wheel if stdout has a tty.
562 ;display_progress=
563
564 # (path) Configure the keyring used for GPG signature verification during collection installation and verification.
565 ;gpg_keyring=
566
567 # (boolean) 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.
568 ;ignore_certs=
569
570 # (list) A list of GPG status codes to ignore during GPG signature verification. See L(https://github.com/gpg/gnupg/blob/master/doc/DETAILS#general-status-codes) for status code descriptions.
571 # If fewer signatures successfully verify the collection than `GALAXY_REQUIRED_VALID_SIGNATURE_COUNT`, signature verification will fail even if all error codes are ignored.
572 ;ignore_signature_status_codes=
573
574 # (str) The number of signatures that must be successful during GPG signature verification while installing or verifying collections.
575 # This should be a positive integer or all to indicate all signatures must successfully validate the collection.
576 # Prepend + to the value to fail if no valid signatures are found for the collection.
577 ;required_valid_signature_count=1
578
579 # (path) Role skeleton directory to use as a template for the ``init`` action in ``ansible-galaxy``/``ansible-galaxy role``, same as ``--role-skeleton``.
580 ;role_skeleton=
581
582 # (list) patterns of files to ignore inside a Galaxy role or collection skeleton directory
583 ;role_skeleton_ignore=^.git$, ^.*/.git_keep$
584
585 # (string) URL to prepend when roles don't specify the full URI, assume they are referencing this server as the source.
586 ;server=https://galaxy.ansible.com
587
588 # (list) A list of Galaxy servers to use when installing a collection.
589 # The value corresponds to the config ini header ``[galaxy_server.{{item}}]`` which defines the server details.
590 # See :ref:`galaxy_server_config` for more details on how to define a Galaxy server.
591 # The order of servers in this list is used to as the order in which a collection is resolved.
592 # Setting this config option will ignore the :ref:`galaxy_server` config option.
593 ;server_list=
594
595 # (path) Local path to galaxy access token file
596 ;token_path={{ ANSIBLE_HOME ~ "/galaxy_token" }}
597
598
599 [inventory]
600 # (string) This setting changes the behaviour of mismatched host patterns, it allows you to force a fatal error, a warning or just ignore it
601 ;host_pattern_mismatch=warning
602
603 # (boolean) If 'true', it is a fatal error when any given inventory source cannot be successfully parsed by any available inventory plugin; otherwise, this situation only attracts a warning.
604
605 ;any_unparsed_is_failed=False
606
607 # (bool) Toggle to turn on inventory caching.
608 # This setting has been moved to the individual inventory plugins as a plugin option :ref:`inventory_plugins`.
609 # The existing configuration settings are still accepted with the inventory plugin adding additional options from inventory configuration.
610 # This message will be removed in 2.16.
611 ;cache=False
612
613 # (string) The plugin for caching inventory.
614 # This setting has been moved to the individual inventory plugins as a plugin option :ref:`inventory_plugins`.
615 # The existing configuration settings are still accepted with the inventory plugin adding additional options from inventory and fact cache configuration.
616 # This message will be removed in 2.16.
617 ;cache_plugin=
618
619 # (string) The inventory cache connection.
620 # This setting has been moved to the individual inventory plugins as a plugin option :ref:`inventory_plugins`.
621 # The existing configuration settings are still accepted with the inventory plugin adding additional options from inventory and fact cache configuration.
622 # This message will be removed in 2.16.
623 ;cache_connection=
624
625 # (string) The table prefix for the cache plugin.
626 # This setting has been moved to the individual inventory plugins as a plugin option :ref:`inventory_plugins`.
627 # The existing configuration settings are still accepted with the inventory plugin adding additional options from inventory and fact cache configuration.
628 # This message will be removed in 2.16.
629 ;cache_prefix=ansible_inventory_
630
631 # (string) Expiration timeout for the inventory cache plugin data.
632 # This setting has been moved to the individual inventory plugins as a plugin option :ref:`inventory_plugins`.
633 # The existing configuration settings are still accepted with the inventory plugin adding additional options from inventory and fact cache configuration.
634 # This message will be removed in 2.16.
635 ;cache_timeout=3600
636
637 # (list) List of enabled inventory plugins, it also determines the order in which they are used.
638 ;enable_plugins=host_list, script, auto, yaml, ini, toml
639
640 # (bool) Controls if ansible-inventory will accurately reflect Ansible's view into inventory or its optimized for exporting.
641 ;export=False
642
643 # (list) List of extensions to ignore when using a directory as an inventory source
644 ;ignore_extensions={{(REJECT_EXTS + ('.orig', '.ini', '.cfg', '.retry'))}}
645
646 # (list) List of patterns to ignore when using a directory as an inventory source
647 ;ignore_patterns=
648
649 # (bool) If 'true' it is a fatal error if every single potential inventory source fails to parse, otherwise this situation will only attract a warning.
650
651 ;unparsed_is_failed=False
652
653 # (boolean) By default Ansible will issue a warning when no inventory was loaded and notes that it will use an implicit localhost-only inventory.
654 # These warnings can be silenced by adjusting this setting to False.
655 ;inventory_unparsed_warning=True
656
657
658 [netconf_connection]
659 # (string) This variable is used to enable bastion/jump host with netconf connection. If set to True the bastion/jump host ssh settings should be present in ~/.ssh/config file, alternatively it can be set to custom ssh configuration file path to read the bastion/jump host settings.
660 ;ssh_config=
661
662
663 [paramiko_connection]
664 # (boolean) TODO: write it
665 ;host_key_auto_add=False
666
667 # (boolean) TODO: write it
668 ;look_for_keys=True
669
670
671 [jinja2]
672 # (list) This list of filters avoids 'type conversion' when templating variables
673 # Useful when you want to avoid conversion into lists or dictionaries for JSON strings, for example.
674 ;dont_type_filters=string, to_json, to_nice_json, to_yaml, to_nice_yaml, ppretty, json
675
676
677 [tags]
678 # (list) default list of tags to run in your plays, Skip Tags has precedence.
679 ;run=
680
681 # (list) default list of tags to skip in your plays, has precedence over Run Tags
682 ;skip=
683