Skip to main content

Config Templates

Config Templates are reusable edge configuration blueprints that define the full desired state for an edge device. Instead of configuring each edge individually, you create a template once and apply it across multiple devices to enforce a consistent baseline.

Navigate to Admin > Config Templates to manage templates.

Template List

The template list displays all available templates for your organisation.

ColumnDescription
Template NameDisplay name and optional description. Click the name to open the template detail page.
Edge ModelThe hardware model this template targets (e.g., VSR1000).
DefaultIndicates whether this template is automatically applied to newly provisioned edges.
TypeSystem templates are built-in and read-only. Custom templates are user-created and fully editable.
ActionsDuplicate, edit, or delete the template.

Creating a Template

Click Create Template to open a blank template editor. System templates cannot be edited, but any template — including system ones — can be duplicated to create an editable copy.

Duplicating a Template

Click the copy icon on any row to create a duplicate. The new template is named <original name> (Copy) and immediately appears in the list. Renaming and editing can be done from the detail page.

Deleting a Template

Click the delete icon and confirm the prompt. System templates cannot be deleted. Deletion is permanent and cannot be undone.

warning

Deleting a template does not reconfigure edges that previously had the template applied. Edges retain their last-pushed configuration.

Template Detail

The template detail page is divided into named configuration sections. Each section maps to a specific subsystem on the edge device.

Physical Interfaces

Configures the raw hardware ports on the edge (G0–G6 for VSR1000).

FieldDescription
Port NameHardware port identifier (e.g., G0, G1).
EnabledToggle to include or exclude this port in the configuration push.
Port TypeEthernet interface type code.
MTUMaximum transmission unit in bytes (default 1500).
DescriptionFree-text label for the port.

Logical Interfaces

Defines virtual interfaces (VLANs, sub-interfaces) layered on top of physical ports.

FieldDescription
Logical NameInterface identifier used within VPP (e.g., G0.100).
RoleWAN, LAN, or custom role label.
TypeInterface type (dot1q for VLAN sub-interfaces).
Port IDParent physical port.
VLAN ID802.1Q VLAN tag (required for VLAN sub-interfaces).
DHCP ClientWhen enabled, the interface requests an IP address via DHCP rather than using a static assignment.
IPv4 / GatewayStatic IP address and default gateway (used when DHCP is disabled).
MTU / MSSLayer 3 MTU and TCP MSS clamping value.
VRFVRF table assignment for multi-tenant routing isolation.

Static Routes

Defines static IPv4 routes to be installed in the VPP FIB.

FieldDescription
DestinationTarget network in CIDR notation.
Next HopForwarding next-hop IP address.
Next Hop PortEgress interface for the route.
Metric / DistanceRoute preference values.
EnabledToggle to include or suppress this route.

NAT Rules (SNAT / DNAT)

Configures source and destination NAT mappings applied by the VPP NAT44-EI engine.

  • SNAT — outbound masquerade rules mapping internal IPs to an external address or interface.
  • DNAT — inbound port-forwarding rules mapping external IP/port combinations to internal hosts.

WireGuard (wg0 / wg1)

SectionPurpose
wg0IoT/backbone mesh backbone interface. Configures listen port, tunnel address, and MTU.
wg1App VPN server interface. Supports wireguard or ikev2 tunnel protocol.

SSH Tunnel

Enables or disables the SSH reverse tunnel that allows the orchestrator to reach the edge via the SSH bastion without requiring inbound firewall rules.

IPFIX / Flowprobe

Controls the IPFIX flow export configuration pushed to the edge agent.

FieldDescription
EnabledActivates flow export on all monitored interfaces.
Collector Address / PortIPFIX collector endpoint (typically the Loki/VictoriaMetrics pipeline).
Template IntervalHow often (seconds) IPFIX template records are re-sent.
Active / Passive TimerFlow export timers controlling record granularity.
Record L2 / L3 / L4Toggle which protocol layers are included in exported flow records.

DHCP Pools

Defines DHCP server pools served by the edge for downstream LAN clients.

FieldDescription
NamePool identifier.
InterfaceLAN interface on which the pool is active.
Start / End IPAddress range allocated to clients.
Gateway / DNSOptions delivered to DHCP clients.
Lease TimeLease duration in seconds.

Applying a Template to an Edge

Templates are applied to edges from the edge detail page, not from this page directly.

  1. Navigate to the target edge (Edges > select edge > Config tab).
  2. Select a template from the Apply Template dropdown.
  3. Review the diff summary and click Confirm.
  4. The orchestrator serialises the template into a batch configuration message and publishes it to the edge MQTT topic.
  5. The edge agent reconciles the received batch against its current state and applies only the changed sections.
info

Template application is additive — sections not covered by the template (e.g., active WireGuard peers) are preserved on the edge.

tip

Mark a template as Default to have it pre-selected when provisioning new edges. This speeds up the onboarding workflow for sites with a standard configuration.

Permissions

ActionRequired Role
View templatesViewer
Create / duplicateAdmin
Edit custom templatesAdmin
Delete custom templatesAdmin
Edit or delete system templatesNot permitted