Difference between ansible vars_files vs include_vars

Both of them have some commonalities but they solve different purposes. vars_files are read when the play starts. include_vars are read when the play reaches the task.

Format
vars_files: directive
and
include_vars module

vars_files:
vars_file directive can only be used when defining a play to specify variable files. The variables from those files are included in the playbook. Since it is used in the start of the play, it most likely implies that some other play(before this play) created those vars files or they were created statically before running the configuration; means they were kind of configuration variables for the play.

include_vars:
vars_files serves one purpose of including the vars from a set of files but it cannot handle the cases if

• The vars files were created dynamically and you want to include them in play
• include vars in a limited scope.
• You have multiple vars files and you want to include them based on certain criteria e.g. if the local database exists then include configuration of local database otherwise include configuration of a remotely hosted database.
• include_vars have higher priority than vars_files so, it can be used to override default configuration(vars).
• include_vars are evaluated lazily(evaluated at the time when they are used).
• You want to include vars dynamically using a loop.
• You want to read a file and put all those variables in a named dictionary instead of reading all variables in the global variable namespace.
• You want to include all files in a directory or some subset of files in a directory(based on prefix or exclusion list) without knowing the exact names of the vars file(s).

Ansible variable precedence

Reference
Ansible variable precedence

Reference
Ansible Variable Reference
Ansible variable precedence

«

Prev

1

/

1

Next

»

Ansible Fundamental tutorial by Manish in 2020

Ansible Advance Tutorial for Beginners with Demo 2020 — By DevOpsSchool

Ansible with network module (Part 01) — By DevOpsSchool

Ansible with network module (Part 02) — By DevOpsSchool

Ansible with network module (Part 03) — By DevOpsSchool

Ansible with network module (Part 04) — By DevOpsSchool

Ansible with network module (Part 05) — By DevOpsSchool

Ansible with network module (Part 06) — By DevOpsSchool

Ansible with network module (Part 07) — By DevOpsSchool

Ansible with network module (Part 08) — By DevOpsSchool

Ansible with network module (Part 09) — By DevOpsSchool

Ansible with network module (Part 10) — By DevOpsSchool

Ansible with network module (Part 11) — By DevOpsSchool

Ansible with network module (Part 12) — By DevOpsSchool

Ansible with network module (Part 13) — By DevOpsSchool

«

Prev

1

/

1

Next

»

• Author
• Recent Posts

Follow me

Rajesh Kumar

Mentor for DevOps - DevSecOps - SRE - Cloud - Container & Micorservices at Software AG

Join my following certification courses...
- DevOps Certified Professionals (DCP)
- Site Reliability Engineering Certified Professionals (SRECP)
- Master in DevOps Engineering (MDE)
- DevSecOps Certified Professionals (DSOCP)
URL - https://www.devopsschool.com/certification/

My Linkedin - https://www.linkedin.com/in/rajeshkumarin

Follow me

Latest posts by Rajesh Kumar (see all)

• Best AI tools for Software Engineers - November 4, 2024
• Installing Jupyter: Get up and running on your computer - November 2, 2024
• An Introduction of SymOps by SymOps.com - October 30, 2024