add_static_route
Configure a static route in a virtual router with destination, next-hop, interface, and metric. Changes are staged in candidate config and require a commit to activate.
Instructions
[MODIFIES CONFIG] Creates a static route in a virtual router. Staged in candidate config — requires 'commit' to activate.
Input Schema
| Name | Required | Description | Default |
|---|---|---|---|
| name | Yes | Static route name | |
| metric | No | Route metric (default: 10) | |
| firewall | No | Target firewall name (from firewalls.json). Required when multiple firewalls are configured; optional otherwise. | |
| interface | No | Egress interface (e.g. 'ethernet1/1') | |
| destination | Yes | Destination CIDR (e.g. '10.0.0.0/8', '0.0.0.0/0') | |
| nexthop_type | Yes | Next-hop type | |
| nexthop_value | No | Next-hop IP address or virtual router name (required for ip-address and next-vr types) | |
| virtual_router | No | Virtual router name (default: 'default') |