rougail-output-ansible/tests/results-doc/test_namespace/04_5disabled_calculation_optional_default.sh

100 lines
11 KiB
Bash
Raw Blame History

This file contains invisible Unicode characters

This file contains invisible Unicode characters that are indistinguishable to humans but may be processed differently by a computer. If you think that this is intentional, you can safely ignore this warning. Use the Escape button to reveal them.

rougail.rougail - Rougail
This repository contains the  rougail.rougail  Ansible Collection.
This family is a namespace
Variables
The group variable "rougail" - Rougail
▌ 🛈 Informations
▌ 
▌  standard 
┏━━━━━━━━━━━━━━━┳━━━━━━━━━━━━━━━┳━━━━━━━━━━━━━━━┳━━━━━━━━━━━━━━┳━━━━━━━━━━━━━━━┓
 ┃ ┃ ┃ ┃ Access  ┃
 Variable  ┃ Description  ┃ Default value ┃ Type  ┃ control  ┃
┡━━━━━━━━━━━━━━━╇━━━━━━━━━━━━━━━╇━━━━━━━━━━━━━━━╇━━━━━━━━━━━━━━╇━━━━━━━━━━━━━━━┩
condition │ A condition. │ false boolean    │  standard  │
│ │ │ │ mandatory  │ │
├───────────────┼───────────────┼───────────────┼──────────────┼───────────────┤
var1 │ A first │ │  string  │  standard  │
│ │ variable. │ │ │ │
├───────────────┼───────────────┼───────────────┼──────────────┼───────────────┤
var2 │ A first │ │  string  │  standard    │
│ │ variable. │ │ │ hidden  │
├───────────────┼───────────────┼───────────────┼──────────────┼───────────────┤
var3 │ A second │ │  string  │  standard    │
│ │ variable. │ │ │ hidden  │
│ │ │ │ │ Hidden: when │
│ │ │ │ │ the variable │
│ │ │ │ │ "a condition"
│ │ │ │ │ (None) is │
│ │ │ │ │ defined and │
│ │ │ │ │ has the value │
│ │ │ │ │ "true". │
├───────────────┼───────────────┼───────────────┼──────────────┼───────────────┤
var4 │ A forth │ │  string  │  standard    │
│ │ variable. │ │ │ hidden  │
│ │ │ │ │ Hidden: when │
│ │ │ │ │ the variable │
│ │ │ │ │ "a condition"
│ │ │ │ │ (None) is │
│ │ │ │ │ defined and │
│ │ │ │ │ has the value │
│ │ │ │ │ "true". │
└───────────────┴───────────────┴───────────────┴──────────────┴───────────────┘
▌ 🛈 Informations
▌ 
▌ Hidden variables can only be modified within a structure file.
Usage
Example playbook with Rougail
Add to your structural file something like:
%YAML 1.2 
--- 
version: 1.1 
my_rougail: 
 type: rougail 
... 
Customizing hidden variable in structural files:
%YAML 1.2 
--- 
version: 1.1 
my_rougail: 
 type: rougail 
 var2: example 
... 
▌ 🛈 Informations
▌ 
▌ Do not forget to add Rougail structural file as Rougail types.
Add to your play:
--- 
- name: Rougail 
 hosts: servers 
 vars: 
 rougail: '{{ my_rougail }}' 
 ansible.builtin.import_playbook: rougail.rougail.install 
Example playbook without Rougail
▌ 🛈 Informations
▌ 
▌ The variables will not be properly validated without Rougail.
--- 
- name: Rougail 
 hosts: servers 
 vars: {} 
 ansible.builtin.import_playbook: rougail.rougail.install