set_fact – Set host facts from a task¶
Synopsis¶
- This module allows setting new variables.
- Variables are set on a host-by-host basis just like facts discovered by the setup module.
- These variables will be available to subsequent plays during an ansible-playbook run.
- Set
cacheable
toyes
to save variables across executions using a fact cache. Variables created with set_fact have different precedence depending on whether they are or are not cached. - Per the standard Ansible variable precedence rules, many other types of variables have a higher priority, so this value may be overridden.
- This module is also supported for Windows targets.
Parameters¶
Notes¶
Note
- The
var=value
notation can only create strings or booleans. If you want to create lists/arrays or dictionary/hashes usevar: [val1, val2]
. - Since ‘cacheable’ is now a module param, ‘cacheable’ is no longer a valid fact name as of Ansible 2.4.
- This module is also supported for Windows targets.
See Also¶
See also
- include_vars – Load variables from files, dynamically within a task
- The official documentation on the include_vars module.
- 変数の優先度: 変数をどこに置くべきか
- More information related to variable precedence and which type of variable wins over others.
Examples¶
# Example setting host facts using key=value pairs, note that this always creates strings or booleans
- set_fact: one_fact="something" other_fact="{{ local_var }}"
# Example setting host facts using complex arguments
- set_fact:
one_fact: something
other_fact: "{{ local_var * 2 }}"
another_fact: "{{ some_registered_var.results | map(attribute='ansible_facts.some_fact') | list }}"
# Example setting facts so that they will be persisted in the fact cache
- set_fact:
one_fact: something
other_fact: "{{ local_var * 2 }}"
cacheable: yes
# As of Ansible 1.8, Ansible will convert boolean strings ('true', 'false', 'yes', 'no')
# to proper boolean values when using the key=value syntax, however it is still
# recommended that booleans be set using the complex argument style:
- set_fact:
one_fact: yes
other_fact: no
Status¶
- This module is guaranteed to have backward compatible interface changes going forward. [stableinterface]
- This module is maintained by the Ansible Core Team. [core]
Red Hat Support¶
More information about Red Hat’s support of this module is available from this Red Hat Knowledge Base article.
Authors¶
- Dag Wieers (@dagwieers)
Hint
If you notice any issues in this documentation, you can edit this document to improve it.