rougail-output-json/README.md
2025-12-24 09:30:54 +01:00

2.9 KiB

Table of Contents

🇬🇧 (EN) - 🇫🇷 (FR)

Export configuration to JSON format

Note

Exporting the configuration in JSON format makes it easier to process the configuration in an external tool, for example.
Path: json
disabled
Disabled: if json is not set in "Select for output"

Variable Description Default value Type
json.mandatory
Command line:
• --json.mandatory
• --json.no-mandatory
Environment variable: JSON.MANDATORY
Test mandatories variables before display in JSON.
The configuration must be valid before exporting the data to JSON format. It's better to validate the values at the beginning of the process.
true if "Configuration in output step is in read_write mode" is false boolean mandatory
json.get
Command line:
--json.get
Environment variable: JSON.GET
Get value for a variable or a family.
By default, the entire configuration is exported as JSON. It is possible to retrieve variable values from a defined family or directly the value of a variable.
Examples:
• family
• family.variable
string