register-var
Example:
# Display the currents user home directory. - register-var: var: ansible_env.HOME
Description
Registers the content of an (internal) Ansible variable.
Variables
Name | Type | Default | Description |
---|---|---|---|
|
string | -- | n/a Required |
|
string | -- | The Ansible variable name to register. Required |
Examples
Example 1
Display the currents user home directory.
Code
- register-var: var: ansible_env.HOME
Code
doc: short_help: Registers the content of an (internal) Ansible variable. examples: - title: Display the currents user home directory. vars: var: ansible_env.HOME args: register_target: doc: short_name: The name to store the value of the variable under. type: string required: true var_name: type: string required: true doc: short_help: The Ansible variable name to register. meta: tags: - debug frecklets: - frecklet: type: ansible-module name: debug desc: short: "register value of var '{{:: var_name ::}}' under '{{:: register_target\ \ ::}}'" properties: idempotent: false become: false internet: false register: target: '{{:: register_target ::}}' value: '{{ __result__.{{:: var_name ::}} }}' vars: var: "{{:: var_name | split_string('.', 0) ::}}"
frecklecute register-var --help Usage: frecklecute register-var [OPTIONS] Registers the content of an (internal) Ansible variable. Options: --register-target REGISTER_TARGET n/a [required] --var-name VAR_NAME The Ansible variable name to register. [required] --help Show this message and exit.
# -*- coding: utf-8 -*- # # module path: pycklets.register_var.RegisterVar # from dataclasses import dataclass from pyckles import AutoPycklet from typing import * # noqa @dataclass class RegisterVar(AutoPycklet): """Registers the content of an (internal) Ansible variable. Args: register_target: n/a var_name: The Ansible variable name to register. """ FRECKLET_ID = "register-var" register_target: str = None var_name: str = None def __post_init__(self): super(RegisterVar, self).__init__(var_names=["register_target", "var_name"]) frecklet_class = RegisterVar
# -*- coding: utf-8 -*- # # module path: pycklets.register_var.RegisterVar # from pyckles import AutoPycklet class RegisterVar(AutoPycklet): """Registers the content of an (internal) Ansible variable. Args: register_target: n/a var_name: The Ansible variable name to register. """ FRECKLET_ID = "register-var" def __init__(self, register_target=None, var_name=None): super(RegisterVar, self).__init__(var_names=["register_target", "var_name"]) self._register_target = register_target self._var_name = var_name @property def register_target(self): return self._register_target @register_target.setter def register_target(self, register_target): self._register_target = register_target @property def var_name(self): return self._var_name @var_name.setter def var_name(self, var_name): self._var_name = var_name frecklet_class = RegisterVar