capable.core221.include_fact

Load variables from a file and set them as facts

Note

Added in version 1.0.0

Reads variables from a YAML or JSON file on the controller.

Sets those variables as facts using M(ansible.builtin.set_fact).

The file must contain a non-empty dictionary at the top level.

File values are evaluated once when this task runs, using the current task variables.

Parameters

cacheable

Type: bool · Default: False

Whether to cache the facts using the fact cache. Mirrors the cacheable option from M(ansible.builtin.set_fact).

---

file (required)

Type: path · Required: yes

Path to the variables file to load. Similar to M(ansible.builtin.include_vars), the path is resolved relative to the playbook and roles.

---

Notes

Tip

Requires ansible-core 2.21.0 or later. The builtin action’s public variable-layer registration preserves set_fact precedence, caching and meta: clear_facts behavior. Older cores are rejected before file loading or assignment.

Tip

Files use the same trusted-template loading as M(ansible.builtin.include_vars). Untrusted data referenced by their expressions remains data, not executable templates.

Tip

Vault-encrypted file results and processing errors are censored. Use the task’s no_log keyword for sensitive plaintext files. no_log does not encrypt facts stored in a fact cache.

Tip

The variable name cacheable is reserved for the action option and cannot be set by the file.

Examples

- name: Load facts from a vars file
  capable.core221.include_fact:
    file: vars/app.yml
    cacheable: true

Return Values

ansible_facts

Type: dict · Returned: success

Facts set from the file.

---

ansible_included_var_files

Type: list · Returned: success

List of vars files that were loaded.

---

Authors

• Kirill Satarin (@kksat)