rougail-output-doc/tests/docs/base/04_5validators_in_network.adoc
2024-08-05 14:38:59 +02:00

64 lines
2.3 KiB
Text

== dictionaries/rougail/00-base.yml
[,yaml]
----
version: '1.1'
network_address_eth0:
description: Network address
type: network
netmask_address_eth0:
description: Network address
type: netmask
ip_address:
description: an IP
type: ip
validators:
- type: jinja
jinja: |
{% if not _.ip_address | valid_in_network(_.network_address_eth0, _.netmask_address_eth0) %}
{{ _.ip_address }} is not in network {{ _.network_address_eth0 }}/{{ _.netmask_address_eth0 }}
{% endif %}
description: check if IP in the previous network
----
== Variables for "rougail"
[cols="101a,101a",options="header"]
|====
| Variable | Description
|
**rougail.network_address_eth0** +
`https://rougail.readthedocs.io/en/latest/variable.html#variables-types[network]` `basic` `mandatory` |
Network address.
|
**rougail.netmask_address_eth0** +
`https://rougail.readthedocs.io/en/latest/variable.html#variables-types[netmask]` `basic` `mandatory` |
Network address.
|
**rougail.ip_address** +
`https://rougail.readthedocs.io/en/latest/variable.html#variables-types[IP]` `basic` `mandatory` |
An IP. +
**Validators**:
* reserved IP are allowed
* check if IP in the previous network.
|====
== Example with mandatory variables not filled in
[,yaml]
----
rougail:
network_address_eth0: 1.1.1.0
netmask_address_eth0: 255.255.255.0
ip_address: 1.1.1.1
----
== Example with all variables modifiable
[,yaml]
----
rougail:
network_address_eth0: 1.1.1.0
netmask_address_eth0: 255.255.255.0
ip_address: 1.1.1.1
----