include_vars - Load variables from files, dynamically within a task.

Author:Benno Joy

Synopsis

New in version 1.4.

Loads variables from a YAML file dynamically during task runtime. It can work with conditionals, or use host specific variables to determine the path name to load from.

Options

parameter required default choices comments
free-form yes
    The file name from which variables should be loaded, if called from a role it will look for the file in vars/ subdirectory of the role, otherwise the path would be relative to playbook. An absolute path can also be provided.

    Examples


    # Conditionally decide to load in variables when x is 0, otherwise do not.
    - include_vars: contingency_plan.yml
      when: x == 0
    
    # Load a variable file based on the OS type, or a default if not found.
    - include_vars: "{{ item }}"
      with_first_found:
       - "{{ ansible_distribution }}.yml"
       - "{{ ansible_os_family }}.yml"
       - "default.yml"
    

    Table Of Contents

    Previous topic

    fireball - Enable fireball mode on remote node

    Next topic

    pause - Pause playbook execution