← Back to index

opnsense_interfaces_vip (Resource)

Virtual IPs allow an OPNsense firewall to assign multiple IP addresses to the same network interface.

Example Usage

resource "opnsense_interfaces_vip" "proxyarp_example_vip" {
  mode = "proxyarp"
  interface   = "wan"
  network = "192.168.0.189/32"
  description = "proxyarp example vip"
}

resource "opnsense_interfaces_vip" "ipalias_example_vip" {
    mode        = "ipalias"
    interface   = "wan"
    network     = "192.168.0.166/32"
    description = "ipalias example vip"
}

Schema

Required

  • network (String) Provide an address and subnet to use. (e.g 192.168.0.1/24)

Optional

  • description (String) Optional description here for your reference (not parsed).
  • gateway (String) For some interface types a gateway is required to configure an IP Alias (ppp/pppoe/tun), leave this field empty for all other interface types.
  • interface (String) Choose which interface this VIP applies to.
  • mode (String) Mode of the VIP. One of ipalias or proxyarp. proxyarp cannot be bound to by anything running on the firewall, such as IPsec, OpenVPN, etc. In most cases an ipalias should be used.

Read-Only

  • id (String) UUID of the VIP.

Import

In Terraform v1.5.0 and later, use an import block to import opnsense_interfaces_vip using the id. For example:

import {
  to = opnsense_interfaces_vip.example
  id = "<opnsense-resource-id>"
}

Using terraform import, import opnsense_interfaces_vip using the id. For example:

% terraform import opnsense_interfaces_vip.example <opnsense-resource-id>