host_group_vars

Collection Note

This module is part of the ansible.builtin collection. To install the collection, use:

ansible-galaxy collection install ansible.builtin

Added in version 2.4.

You need further requirements to be able to use this module, see the Requirements section for details.

Synopsis

• Loads YAML vars into corresponding groups/hosts in group_vars/ and host_vars/ directories.
• Files are restricted by extension to one of .yaml, .json, .yml or no extension.
• Hidden (starting with '.') and backup (ending with '~') files and directories are ignored.
• Only applies to inventory sources that are existing paths.
• Starting in 2.10, this plugin requires enabling and is enabled by default.

Requirements

The following Python packages are needed on the host that executes this module:

• Enabled in configuration

Parameters

Parameter	Defaults / Choices	Comments
_valid_extensions list / elements=string	Default: ['.yml', '.yaml', '.json']	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. Env: ANSIBLE_YAML_FILENAME_EXT
stage str	Choices: all, task, inventory	Control when this vars plugin may be executed. Setting this option to V(all) will run the vars plugin after importing inventory and whenever it is demanded by a task. Setting this option to V(task) will only run the vars plugin whenever it is demanded by a task. Setting this option to V(inventory) will only run the vars plugin after parsing inventory. If this option is omitted, the global C(RUN_VARS_PLUGINS) configuration is used to determine when to execute the vars plugin. Env: ANSIBLE_VARS_PLUGIN_STAGE Version Added: 2.10