ansible/utilities/logic/set_fact.py

#!/usr/bin/python
# -*- coding: utf-8 -*-

# Copyright 2013 Dag Wieers <dag@wieers.com>
#
# This file is part of Ansible
#
# Ansible is free software: you can redistribute it and/or modify
# it under the terms of the GNU General Public License as published by
# the Free Software Foundation, either version 3 of the License, or
# (at your option) any later version.
#
# Ansible is distributed in the hope that it will be useful,
# but WITHOUT ANY WARRANTY; without even the implied warranty of
# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
# GNU General Public License for more details.
#
# You should have received a copy of the GNU General Public License
# along with Ansible.  If not, see <http://www.gnu.org/licenses/>.

DOCUMENTATION = '''
---
author: "Dag Wieers (@dagwieers)"
module: set_fact
short_description: Set host facts from a task
description:
     - 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, but will not be saved across executions even if you use a fact cache.
options:
  key_value:
    description:
      - The C(set_fact) module takes key=value pairs as variables to set
        in the playbook scope. Or alternatively, accepts complex arguments
        using the C(args:) statement.
    required: true
    default: null
version_added: "1.2"
notes:
    - "The `var=value` notation can only create strings or booleans.
      If you want to create lists/arrays or dictionary/hashes use `var: [val1, val2]`"
'''

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 }}"

# As of 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: true
    other_fact: false

'''
New module 'set_fact' to define host facts This module allows you to set host facts (or export play variables to the playbook scope if you fancy that). The module also accepts complex arguments. ```yaml - action: set_fact fact="something" global_fact="${local_var}"' - action: set_fact args: fact: something global_fact: ${local_var} ``` 12 years ago			`#!/usr/bin/python`
			`# -- coding: utf-8 --`

			`# Copyright 2013 Dag Wieers <dag@wieers.com>`
			`#`
			`# This file is part of Ansible`
			`#`
			`# Ansible is free software: you can redistribute it and/or modify`
			`# it under the terms of the GNU General Public License as published by`
			`# the Free Software Foundation, either version 3 of the License, or`
			`# (at your option) any later version.`
			`#`
			`# Ansible is distributed in the hope that it will be useful,`
			`# but WITHOUT ANY WARRANTY; without even the implied warranty of`
			`# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the`
			`# GNU General Public License for more details.`
			`#`
			`# You should have received a copy of the GNU General Public License`
			`# along with Ansible. If not, see <http://www.gnu.org/licenses/>.`

			`DOCUMENTATION = '''`
			`---`
Proper author info for all remaining modules 10 years ago			`author: "Dag Wieers (@dagwieers)"`
New module 'set_fact' to define host facts This module allows you to set host facts (or export play variables to the playbook scope if you fancy that). The module also accepts complex arguments. ```yaml - action: set_fact fact="something" global_fact="${local_var}"' - action: set_fact args: fact: something global_fact: ${local_var} ``` 12 years ago			`module: set_fact`
			`short_description: Set host facts from a task`
			`description:`
clarified set_fact function 9 years ago			`- This module allows setting new variables. Variables are set on a host-by-host basis just like facts discovered by the setup module.`
documenting behaviour as clear as possible 8 years ago			`- These variables will be available to subsequent plays during an ansible-playbook run, but will not be saved across executions even if you use a fact cache.`
New module 'set_fact' to define host facts This module allows you to set host facts (or export play variables to the playbook scope if you fancy that). The module also accepts complex arguments. ```yaml - action: set_fact fact="something" global_fact="${local_var}"' - action: set_fact args: fact: something global_fact: ${local_var} ``` 12 years ago			`options:`
			`key_value:`
			`description:`
			`- The C(set_fact) module takes key=value pairs as variables to set`
			`in the playbook scope. Or alternatively, accepts complex arguments`
			`using the C(args:) statement.`
			`required: true`
			`default: null`
			`version_added: "1.2"`
updated set_fact docs with note about typing 8 years ago			`notes:`
			- "The `var=value` notation can only create strings or booleans.
			If you want to create lists/arrays or dictionary/hashes use `var: [val1, val2]`"
New module 'set_fact' to define host facts This module allows you to set host facts (or export play variables to the playbook scope if you fancy that). The module also accepts complex arguments. ```yaml - action: set_fact fact="something" global_fact="${local_var}"' - action: set_fact args: fact: something global_fact: ${local_var} ``` 12 years ago			`'''`
Docs standardization 12 years ago
			`EXAMPLES = '''`
updated set_fact docs with note about typing 8 years ago			`# Example setting host facts using key=value pairs, note that this always creates strings or booleans`
Update set_fact.py Context: I recently discovered that when setting a fact, key=value pairs and complex arguments differ in how the fact is stored. For example, when attempting to use complex arguments using key=values, the result can be stored as a unicode string as opposed to an object/list/etc. I'm hoping the above example update will better demonstrate to and instruct people to use complex arguments instead of key=value pairs in certain situations. 10 years ago			`- set_fact: one_fact="something" other_fact="{{ local_var }}"`
Docs standardization 12 years ago
			`# Example setting host facts using complex arguments`
DOCS: standardize on EXAMPLES (a.k.a. Docs-JumboPatch JetLag Edition) Migrated all examples: in DOCUMENTATION=''' string to standalone EXAMPLES=''' string Added deprecation warning to moduledev.rst and remove deprecated example from it Fixed up a few typos and uppercased some acronyms. add consistency to how EXAMPLES are formatted 12 years ago			`- set_fact:`
			`one_fact: something`
			`other_fact: "{{ local_var * 2 }}"`
Update set_fact.py Context: I recently discovered that when setting a fact, key=value pairs and complex arguments differ in how the fact is stored. For example, when attempting to use complex arguments using key=values, the result can be stored as a unicode string as opposed to an object/list/etc. I'm hoping the above example update will better demonstrate to and instruct people to use complex arguments instead of key=value pairs in certain situations. 10 years ago			`another_fact: "{{ some_registered_var.results \| map(attribute='ansible_facts.some_fact') \| list }}"`
Convert boolean strings from set_fact to proper boolean values Also adds integration tests for booleanification of strings Fixes #8629 10 years ago
			`# As of 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: true`
			`other_fact: false`

Docs standardization 12 years ago			`'''`