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

84 lines
9.2 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
▌ 
▌  basic 
┏━━━━━━━━━━━━━━━┳━━━━━━━━━━━━━━━┳━━━━━━━━━━━━━━━┳━━━━━━━━━━━━━━┳━━━━━━━━━━━━━━━┓
 ┃ ┃ ┃ ┃ Access  ┃
 Variable  ┃ Description  ┃ Default value ┃ Type  ┃ control  ┃
┡━━━━━━━━━━━━━━━╇━━━━━━━━━━━━━━━╇━━━━━━━━━━━━━━━╇━━━━━━━━━━━━━━╇━━━━━━━━━━━━━━━┩
condition │ A condition. │ true boolean    │  standard    │
│ │ │ │ mandatory  │ hidden  │
├───────────────┼───────────────┼───────────────┼──────────────┼───────────────┤
variable │ A variable. │ │  string    │  basic    │
│ │ │ │ mandatory  │ disabled  │
│ │ │ │ │ Disabled: │
│ │ │ │ │ when the │
│ │ │ │ │ variable "a │
│ │ │ │ │ condition"
│ │ │ │ │ (None) 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 
 condition: true 
... 
▌ 🛈 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