configuration reference

Pre-Alpha. This page describes behavior that may change.

The exact shape of every configuration field in Ze lives in the YANG schemas themselves, not in a separately-maintained reference. The schemas are the code, and ze schema show prints them verbatim. This page is the index of the sources you read when you need the exact answer.

Where the answers live

The YANG schemas. Under main/internal/component/config/ and the per-plugin schemas under main/internal/component/bgp/schema/, main/internal/component/bgp/plugins/*/schema/, and main/internal/component/iface/schema/. Read them directly for the exact type, default, and validation rule for a leaf.

ze schema show. Runtime introspection reads from the same schemas the daemon uses. ze schema list gives you every registered module; ze schema show <module> prints the full YANG content of one.

ze schema list
ze schema show ze-bgp-conf
ze schema methods ze-bgp-conf        # All RPCs with parameters

See Introspection for the full set of schema discovery commands.

The in-tree guide. main/docs/guide/configuration.md is the hand-written version of the same material. It covers the common cases well. It is not exhaustive, but it is the fastest path to an answer for the common questions.

See also

• Configuration overview for the model and the commit workflow.
• YANG model for how the schemas drive every surface.
• BGP peers for the per-peer reference.
• Introspection for the schema discovery commands.
• In-tree configuration guide for the hand-written long form.