ipv6
Manage IPv6 NPTv6 translation, virtual IPs, router advertisements, and ULA conversion, including creating, deleting, and applying configurations on OPNsense.
Instructions
IPv6: NPTv6 prefix translation, virtual IPs, router advertisements, and planning or applying a ULA conversion. Call action='help' for each action's fields and rules.
Input Schema
| Name | Required | Description | Default |
|---|---|---|---|
| mode | No | [create_vip, set_advert] One of: ipalias, carp, proxyarp, other (default ipalias) | |
| uuid | No | Record to act on, identified by a list action. | |
| vhid | No | [create_vip] CARP virtual host id; required only for mode=carp | |
| apply | No | Apply now rather than leaving the change staged. The default differs by action; action='help' reports each one. | |
| action | Yes | Operation to run. 'help' lists fields. | |
| subnet | No | [create_vip] Address, without the prefix length | |
| confirm | No | Token returned by the previous call, to confirm. | |
| domains | No | [apply_ula] Subset of ['vip', 'npt', 'ra', 'unbound'], in that order | |
| dry_run | No | [apply_ula] Report what would run without doing it (default true) | |
| enabled | No | Target state, set explicitly rather than flipped. | |
| trackif | No | [create_npt] Interface whose delegated prefix supplies the external side | |
| interface | No | [create_npt, create_vip] Interface the translation applies on, usually wan | |
| gua_prefix | No | [plan_ula] Current delegated prefix, for example 2001:db8:1::/64 | |
| source_net | No | [create_npt] Internal prefix, for example fd00:...:2::/64 | |
| ula_prefix | No | [plan_ula] Target ULA prefix of the same length | |
| description | No | Free-text note stored on the record. | |
| subnet_bits | No | [create_vip] Prefix length, e.g. 64 | |
| public_names | No | [plan_ula] Fully qualified names the outside world resolves; these keep their delegated address | |
| valid_lifetime | No | [set_advert] valid_lifetime | |
| destination_net | No | [create_npt] External prefix; omit when using trackif | |
| deprecate_prefix | No | [set_advert] Advertise the prefix as deprecated | |
| preferred_lifetime | No | [set_advert] Advertised preferred lifetime; 0 deprecates the prefix |