rougail-output-ansible/tests/results-doc/test_namespace/00_6port.sh

123 lines
13 KiB
Bash
Raw Normal View History

2026-05-04 12:17:56 +02:00
rougail.rougail - Rougail
2026-01-14 14:25:35 +01:00
2026-05-04 12:17:56 +02:00
This repository contains the  rougail.rougail  Ansible Collection.
2026-01-14 14:25:35 +01:00
2026-05-04 12:17:56 +02:00
This family is a namespace
2026-01-14 14:25:35 +01:00
2026-05-04 12:17:56 +02:00
Variables
The group variable "rougail" - Rougail
▌ 🛈 Informations
▌ 
▌  basic 
2026-01-14 14:25:35 +01:00
2026-02-21 21:31:34 +01:00
┏━━━━━━━━━━━━┳━━━━━━━━━━━━┳━━━━━━━━━━━━┳━━━━━━━━━━━━┳━━━━━━━━━━━━━┳━━━━━━━━━━━━┓
 ┃ ┃ Default  ┃ ┃ Access  ┃ ┃
 Variable  ┃ Descripti… ┃ value  ┃ Type  ┃ control  ┃ Validator  ┃
┡━━━━━━━━━━━━╇━━━━━━━━━━━━╇━━━━━━━━━━━━╇━━━━━━━━━━━━╇━━━━━━━━━━━━━╇━━━━━━━━━━━━┩
variable1 │ A port │ │  port    │  basic  │ • │
│ │ variable. │ │ mandatory  │ │ well-known │
│ │ │ │ │ │ ports (1
│ │ │ │ │ │ to 1023)
│ │ │ │ │ │ are │
│ │ │ │ │ │ allowed │
│ │ │ │ │ │ • │
│ │ │ │ │ │ registred │
│ │ │ │ │ │ ports │
│ │ │ │ │ │ (1024 to │
│ │ │ │ │ │ 49151) are │
│ │ │ │ │ │ allowed │
│ │ │ │ │ │ • private │
│ │ │ │ │ │ ports │
│ │ │ │ │ │ (greater │
│ │ │ │ │ │ than │
│ │ │ │ │ │ 49152) are │
│ │ │ │ │ │ allowed. │
├────────────┼────────────┼────────────┼────────────┼─────────────┼────────────┤
variable2 │ A port │ 8080 port    │  standard  │ • │
│ │ variable │ │ mandatory  │ │ well-known │
│ │ with │ │ │ │ ports (1
│ │ default │ │ │ │ to 1023)
│ │ value. │ │ │ │ are │
│ │ │ │ │ │ allowed │
│ │ │ │ │ │ • │
│ │ │ │ │ │ registred │
│ │ │ │ │ │ ports │
│ │ │ │ │ │ (1024 to │
│ │ │ │ │ │ 49151) are │
│ │ │ │ │ │ allowed │
│ │ │ │ │ │ • private │
│ │ │ │ │ │ ports │
│ │ │ │ │ │ (greater │
│ │ │ │ │ │ than │
│ │ │ │ │ │ 49152) are │
│ │ │ │ │ │ allowed. │
├────────────┼────────────┼────────────┼────────────┼─────────────┼────────────┤
variable3 │ A port │ 8080 port    │  standard  │ • │
│ │ variable │ │ mandatory  │ │ well-known │
│ │ with │ │ │ │ ports (1
│ │ integer │ │ │ │ to 1023)
│ │ default │ │ │ │ are │
│ │ value. │ │ │ │ allowed │
│ │ │ │ │ │ • │
│ │ │ │ │ │ registred │
│ │ │ │ │ │ ports │
│ │ │ │ │ │ (1024 to │
│ │ │ │ │ │ 49151) are │
│ │ │ │ │ │ allowed │
│ │ │ │ │ │ • private │
│ │ │ │ │ │ ports │
│ │ │ │ │ │ (greater │
│ │ │ │ │ │ than │
│ │ │ │ │ │ 49152) are │
│ │ │ │ │ │ allowed. │
└────────────┴────────────┴────────────┴────────────┴─────────────┴────────────┘
2026-01-14 14:25:35 +01:00
2026-05-04 12:17:56 +02:00
Usage
2026-01-21 08:55:24 +01:00
2026-05-04 12:17:56 +02:00
Example playbook with Rougail
2026-01-21 08:55:24 +01:00
Add to your structural file something like:
2026-05-04 12:17:56 +02:00
%YAML 1.2 
2026-02-21 21:31:34 +01:00
--- 
2026-05-04 12:17:56 +02:00
version: 1.1 
my_rougail: 
 type: rougail 
... 
▌ 🛈 Informations
▌ 
▌ Do not forget to add Rougail structural file as Rougail types.
2026-01-21 08:55:24 +01:00
2026-05-04 12:17:56 +02:00
For example you can add an YAML user data with something like:
2026-01-21 08:55:24 +01:00
2026-05-04 12:17:56 +02:00
--- 
my_rougail: 
 variable1: '80' # A port variable 
Add to your play:
2026-01-21 08:55:24 +01:00
2026-02-21 21:31:34 +01:00
--- 
- name: Rougail 
2026-05-04 12:17:56 +02:00
 hosts: servers 
 vars: 
 rougail: '{{ my_rougail }}' 
 ansible.builtin.import_playbook: rougail.rougail.install 
2026-01-21 08:55:24 +01:00
2026-05-04 12:17:56 +02:00
Example playbook without Rougail
▌ 🛈 Informations
▌ 
▌ The variables will not be properly validated without Rougail.
2026-01-14 14:25:35 +01:00
2026-02-21 21:31:34 +01:00
--- 
- name: Rougail 
2026-05-04 12:17:56 +02:00
 hosts: servers 
2026-02-21 21:31:34 +01:00
 vars: 
2026-05-04 12:17:56 +02:00
 rougail: 
 variable1: '80' # A port variable 
 ansible.builtin.import_playbook: rougail.rougail.install