ansible.builtin.include_vars (v2.7.16) — module

Install Ansible via pip

Install with pip install ansible==2.7.16

Description

Loads variables from a YAML/JSON files dynamically from within a file or from a directory recursively during task runtime. If loading a directory, the files are sorted alphabetically before being loaded.

This module is also supported for Windows targets.

Usage examples

Scanned by Steampunk Spotter

• Success
  Steampunk Spotter scan finished with no errors, warnings or hints.

- name: Include vars of stuff.yaml into the 'stuff' variable (2.2).
  include_vars:
    file: stuff.yaml
    name: stuff

Scanned by Steampunk Spotter

• Success
  Steampunk Spotter scan finished with no errors, warnings or hints.

- name: Conditionally decide to load in variables into 'plans' when x is 0, otherwise do not. (2.2)
  include_vars:
    file: contingency_plan.yaml
    name: plans
  when: x == 0

Scanned by Steampunk Spotter

• Success
  Steampunk Spotter scan finished with no errors, warnings or hints.

- name: Load a variable file based on the OS type, or a default if not found. Using free-form to specify the file.
  include_vars: "{{ item }}"
  with_first_found:
    - "{{ ansible_distribution }}.yaml"
    - "{{ ansible_os_family }}.yaml"
    - default.yaml

Scanned by Steampunk Spotter

• Success
  Steampunk Spotter scan finished with no errors, warnings or hints.

- name: Bare include (free-form)
  include_vars: myvars.yaml

Scanned by Steampunk Spotter

• Success
  Steampunk Spotter scan finished with no errors, warnings or hints.

- name: Include all .json and .jsn files in vars/all and all nested directories (2.3)
  include_vars:
    dir: vars/all
    extensions:
        - json
        - jsn

Scanned by Steampunk Spotter

• Success
  Steampunk Spotter scan finished with no errors, warnings or hints.

- name: Include all default extension files in vars/all and all nested directories and save the output in test. (2.2)
  include_vars:
    dir: vars/all
    name: test

Scanned by Steampunk Spotter

• Success
  Steampunk Spotter scan finished with no errors, warnings or hints.

- name: Include default extension files in vars/services (2.2)
  include_vars:
    dir: vars/services
    depth: 1

Scanned by Steampunk Spotter

• Success
  Steampunk Spotter scan finished with no errors, warnings or hints.

- name: Include only files matching bastion.yaml (2.2)
  include_vars:
    dir: vars
    files_matching: bastion.yaml

Scanned by Steampunk Spotter

• Success
  Steampunk Spotter scan finished with no errors, warnings or hints.

- name: Include all .yaml files except bastion.yaml (2.3)
  include_vars:
    dir: vars
    ignore_files: [bastion.yaml]
    extensions: [yaml]

Inputs

    
dir:
    description:
    - The directory name from which the variables should be loaded.
    - If the path is relative, it will look for the file in vars/ subdirectory of a role
      or relative to playbook.
    version_added: '2.2'
    version_added_collection: ansible.builtin

file:
    description:
    - The file name from which variables should be loaded.
    - If the path is relative, it will look for the file in vars/ subdirectory of a role
      or relative to playbook.
    version_added: '2.2'
    version_added_collection: ansible.builtin

name:
    description:
    - The name of a variable into which assign the included vars. If omitted (null) they
      will be made top level vars.
    version_added: '2.2'
    version_added_collection: ansible.builtin

depth:
    default: 0
    description:
    - When using C(dir), this module will, by default, recursively go through each sub
      directory and load up the variables. By explicitly setting the depth, this module
      will only go as deep as the depth.
    version_added: '2.2'
    version_added_collection: ansible.builtin

free-form:
    description:
    - This module allows you to specify the 'file' option directly without any other options.
      There is no 'free-form' option, this is just an indicator, see example below.

extensions:
    default:
    - yaml
    - yml
    - json
    description:
    - List of file extensions to read when using C(dir).
    version_added: '2.3'
    version_added_collection: ansible.builtin

ignore_files:
    description:
    - List of file names to ignore.
    version_added: '2.2'
    version_added_collection: ansible.builtin

files_matching:
    description:
    - Limit the files that are loaded within any directory to this regular expression.
    version_added: '2.2'
    version_added_collection: ansible.builtin

ignore_unknown_extensions:
    default: false
    description:
    - Ignore unknown file extensions within the directory. This allows users to specify
      a directory containing vars files that are intermingled with non vars files extension
      types (For example, a directory with a README in it and vars files)
    version_added: '2.7'
    version_added_collection: ansible.builtin

Outputs

ansible_facts:
  description: Variables that were included and their values
  returned: success
  sample:
    variable: value
  type: dict
ansible_included_var_files:
  description: A list of files that were successfully included
  returned: success
  sample:
  - /path/to/file.yaml
  - /path/to/file.json
  type: list
  version_added: 2.4
  version_added_collection: ansible.builtin