Docs Home Pulumi IaC Pulumi ESC Pulumi Insights Pulumi Cloud Packages Tutorials
  1. Packages
  2. Routeros Provider
  3. API Docs
  4. InterfaceVxlan
routeros 1.81.2 published on Tuesday, Apr 15, 2025 by terraform-routeros
terraform-routeros/terraform-provider-routeros

routeros.InterfaceVxlan

Explore with Pulumi AI

routeros logo
routeros 1.81.2 published on Tuesday, Apr 15, 2025 by terraform-routeros
terraform-routeros/terraform-provider-routeros

    Example Usage

    import * as pulumi from "@pulumi/pulumi";
import * as routeros from "@pulumi/routeros";

const test = new routeros.InterfaceVxlan("test", {vni: 10});

    import pulumi
import pulumi_routeros as routeros

test = routeros.InterfaceVxlan("test", vni=10)

    package main

import (
	"github.com/pulumi/pulumi-terraform-provider/sdks/go/routeros/routeros"
	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
)

func main() {
	pulumi.Run(func(ctx *pulumi.Context) error {
		_, err := routeros.NewInterfaceVxlan(ctx, "test", &routeros.InterfaceVxlanArgs{
			Vni: pulumi.Float64(10),
		})
		if err != nil {
			return err
		}
		return nil
	})
}

    using System.Collections.Generic;
using System.Linq;
using Pulumi;
using Routeros = Pulumi.Routeros;

return await Deployment.RunAsync(() => 
{
    var test = new Routeros.InterfaceVxlan("test", new()
    {
        Vni = 10,
    });

});

    package generated_program;

import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.routeros.InterfaceVxlan;
import com.pulumi.routeros.InterfaceVxlanArgs;
import java.util.List;
import java.util.ArrayList;
import java.util.Map;
import java.io.File;
import java.nio.file.Files;
import java.nio.file.Paths;

public class App {
    public static void main(String[] args) {
        Pulumi.run(App::stack);
    }

    public static void stack(Context ctx) {
        var test = new InterfaceVxlan("test", InterfaceVxlanArgs.builder()
            .vni(10)
            .build());

    }
}

    resources:
  test:
    type: routeros:InterfaceVxlan
    properties:
      vni: 10

    Create InterfaceVxlan Resource

    Resources are created with functions called constructors. To learn more about declaring and configuring resources, see Resources.

    Constructor syntax

    new InterfaceVxlan(name: string, args?: InterfaceVxlanArgs, opts?: CustomResourceOptions);
    @overload
def InterfaceVxlan(resource_name: str,
                   args: Optional[InterfaceVxlanArgs] = None,
                   opts: Optional[ResourceOptions] = None)

@overload
def InterfaceVxlan(resource_name: str,
                   opts: Optional[ResourceOptions] = None,
                   ___id_: Optional[float] = None,
                   ___path_: Optional[str] = None,
                   allow_fast_path: Optional[bool] = None,
                   arp: Optional[str] = None,
                   arp_timeout: Optional[str] = None,
                   comment: Optional[str] = None,
                   disabled: Optional[bool] = None,
                   dont_fragment: Optional[str] = None,
                   group: Optional[str] = None,
                   interface: Optional[str] = None,
                   interface_vxlan_id: Optional[str] = None,
                   local_address: Optional[str] = None,
                   mac_address: Optional[str] = None,
                   max_fdb_size: Optional[float] = None,
                   mtu: Optional[str] = None,
                   name: Optional[str] = None,
                   port: Optional[float] = None,
                   vni: Optional[float] = None,
                   vrf: Optional[str] = None,
                   vteps_ip_version: Optional[str] = None)
    func NewInterfaceVxlan(ctx *Context, name string, args *InterfaceVxlanArgs, opts ...ResourceOption) (*InterfaceVxlan, error)
    public InterfaceVxlan(string name, InterfaceVxlanArgs? args = null, CustomResourceOptions? opts = null)
    public InterfaceVxlan(String name, InterfaceVxlanArgs args)
public InterfaceVxlan(String name, InterfaceVxlanArgs args, CustomResourceOptions options)

    type: routeros:InterfaceVxlan
properties: # The arguments to resource properties.
options: # Bag of options to control resource's behavior.

    Parameters

    name string
    The unique name of the resource.
    args InterfaceVxlanArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    resource_name str
    The unique name of the resource.
    args InterfaceVxlanArgs
    The arguments to resource properties.
    opts ResourceOptions
    Bag of options to control resource's behavior.
    ctx Context
    Context object for the current deployment.
    name string
    The unique name of the resource.
    args InterfaceVxlanArgs
    The arguments to resource properties.
    opts ResourceOption
    Bag of options to control resource's behavior.
    name string
    The unique name of the resource.
    args InterfaceVxlanArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    name String
    The unique name of the resource.
    args InterfaceVxlanArgs
    The arguments to resource properties.
    options CustomResourceOptions
    Bag of options to control resource's behavior.

    InterfaceVxlan Resource Properties

    To learn more about resource properties and how to use them, see Inputs and Outputs in the Architecture and Concepts docs.

    Inputs

    In Python, inputs that are objects can be passed either as argument classes or as dictionary literals.

    The InterfaceVxlan resource accepts the following input properties:

    AllowFastPath bool
    Whether to allow Fast Path processing. Fragmented and flooded packets over VXLAN are redirected via a slow path. Fast Path is disabled for VXLAN interface that uses IPv6 VTEP version or VRF. The setting is available since RouterOS version 7.8.
    Arp string
    Address Resolution Protocol mode: * disabled - the interface will not use ARP * enabled - the interface will use ARP * local-proxy-arp - the router performs proxy ARP on the interface and sends replies to the same interface * proxy-arp - the router performs proxy ARP on the interface and sends replies to other interfaces * reply-only - the interface will only reply to requests originated from matching IP address/MAC address combinations which are entered as static entries in the ARP table. No dynamic entries will be automatically stored in the ARP table. Therefore for communications to be successful, a valid static entry must already exist.
    ArpTimeout string
    ARP timeout is time how long ARP record is kept in ARP table after no packets are received from IP. Value auto equals to the value of arp-timeout in IP/Settings, default is 30s. Can use postfix ms, s, m, h, d for milliseconds, seconds, minutes, hours or days. If no postfix is set then seconds (s) is used.
    Comment string
    Disabled bool
    DontFragment string
    The Don't Fragment (DF) flag controls whether a packet can be broken into smaller packets, called fragments, before being sent over a network. When configuring VXLAN, this setting determines the presence of the DF flag on the outer IPv4 header and can control packet fragmentation if the encapsulated packet exceeds the outgoing interface MTU. This setting has three options: * disabled - the DF flag is not set on the outer IPv4 header, which means that packets can be fragmented if they are too large to be sent over the outgoing interface. This also allows packet fragmentation when VXLAN uses IPv6 underlay. * enabled - the DF flag is always set on the outer IPv4 header, which means that packets will not be fragmented and will be dropped if they exceed the outgoing interface's MTU. This also avoids packet fragmentation when VXLAN uses IPv6 underlay. * inherit - The DF flag on the outer IPv4 header is based on the inner IPv4 DF flag. If the inner IPv4 header has the DF flag set, the outer IPv4 header will also have it set. If the packet exceeds the outgoing interface's MTU and DF is set, it will be dropped. If the inner packet is non-IP, the outer IPv4 header will not have the DF flag set and packets can be fragmented. If the inner packet is IPv6, the outer IPv4 header will always set the DF flag and packets cannot be fragmented. Note that when VXLAN uses IPv6 underlay, this setting does not have any effect and is treated the same as disabled. The setting is available since RouterOS version 7.8.
    Group string
    When specified, a multicast group address can be used to forward broadcast, unknown-unicast, and multicast traffic between VTEPs. This property requires specifying the interface setting. The interface will use IGMP or MLD to join the specified multicast group, make sure to add the necessary PIM and IGMP/MDL configuration. When this property is set, the vteps-ip-version automatically gets updated to the used multicast IP version.
    Interface string
    Interface name used for multicast forwarding. This property requires specifying the group setting.
    InterfaceVxlanId string
    LocalAddress string
    Specifies the local source address for the VXLAN interface. If not set, one IP address of the egress interface will be selected as a source address for VXLAN packets. When the property is set, the vteps-ip-version automatically gets updated to the used local IP version. The setting is available since RouterOS version 7.7.
    MacAddress string
    Static MAC address of the interface. A randomly generated MAC address will be assigned when not specified.
    MaxFdbSize double
    Limits the maximum number of MAC addresses that VXLAN can store in the forwarding database (FDB).
    Mtu string
    Layer3 Maximum transmission unit ('auto', 0 .. 65535)
    Name string
    Name of the interface.
    Port double
    Used UDP port number.
    Vni double
    VXLAN Network Identifier (VNI).
    Vrf string
    The VRF table this resource operates on.
    VtepsIpVersion string
    Used IP protocol version for statically configured VTEPs. The RouterOS VXLAN interface does not support dual-stack, any configured remote VTEPs with the opposite IP version will be ignored. When multicast group or local-address properties are set, the vteps-ip-version automatically gets updated to the used IP version. The setting is available since RouterOS version 7.6.
    ___id_ double
    Resource ID type (.id / name). This is an internal service field, setting a value is not required.
    ___path_ string
    Resource path for CRUD operations. This is an internal service field, setting a value is not required.
    AllowFastPath bool
    Whether to allow Fast Path processing. Fragmented and flooded packets over VXLAN are redirected via a slow path. Fast Path is disabled for VXLAN interface that uses IPv6 VTEP version or VRF. The setting is available since RouterOS version 7.8.
    Arp string
    Address Resolution Protocol mode: * disabled - the interface will not use ARP * enabled - the interface will use ARP * local-proxy-arp - the router performs proxy ARP on the interface and sends replies to the same interface * proxy-arp - the router performs proxy ARP on the interface and sends replies to other interfaces * reply-only - the interface will only reply to requests originated from matching IP address/MAC address combinations which are entered as static entries in the ARP table. No dynamic entries will be automatically stored in the ARP table. Therefore for communications to be successful, a valid static entry must already exist.
    ArpTimeout string
    ARP timeout is time how long ARP record is kept in ARP table after no packets are received from IP. Value auto equals to the value of arp-timeout in IP/Settings, default is 30s. Can use postfix ms, s, m, h, d for milliseconds, seconds, minutes, hours or days. If no postfix is set then seconds (s) is used.
    Comment string
    Disabled bool
    DontFragment string
    The Don't Fragment (DF) flag controls whether a packet can be broken into smaller packets, called fragments, before being sent over a network. When configuring VXLAN, this setting determines the presence of the DF flag on the outer IPv4 header and can control packet fragmentation if the encapsulated packet exceeds the outgoing interface MTU. This setting has three options: * disabled - the DF flag is not set on the outer IPv4 header, which means that packets can be fragmented if they are too large to be sent over the outgoing interface. This also allows packet fragmentation when VXLAN uses IPv6 underlay. * enabled - the DF flag is always set on the outer IPv4 header, which means that packets will not be fragmented and will be dropped if they exceed the outgoing interface's MTU. This also avoids packet fragmentation when VXLAN uses IPv6 underlay. * inherit - The DF flag on the outer IPv4 header is based on the inner IPv4 DF flag. If the inner IPv4 header has the DF flag set, the outer IPv4 header will also have it set. If the packet exceeds the outgoing interface's MTU and DF is set, it will be dropped. If the inner packet is non-IP, the outer IPv4 header will not have the DF flag set and packets can be fragmented. If the inner packet is IPv6, the outer IPv4 header will always set the DF flag and packets cannot be fragmented. Note that when VXLAN uses IPv6 underlay, this setting does not have any effect and is treated the same as disabled. The setting is available since RouterOS version 7.8.
    Group string
    When specified, a multicast group address can be used to forward broadcast, unknown-unicast, and multicast traffic between VTEPs. This property requires specifying the interface setting. The interface will use IGMP or MLD to join the specified multicast group, make sure to add the necessary PIM and IGMP/MDL configuration. When this property is set, the vteps-ip-version automatically gets updated to the used multicast IP version.
    Interface string
    Interface name used for multicast forwarding. This property requires specifying the group setting.
    InterfaceVxlanId string
    LocalAddress string
    Specifies the local source address for the VXLAN interface. If not set, one IP address of the egress interface will be selected as a source address for VXLAN packets. When the property is set, the vteps-ip-version automatically gets updated to the used local IP version. The setting is available since RouterOS version 7.7.
    MacAddress string
    Static MAC address of the interface. A randomly generated MAC address will be assigned when not specified.
    MaxFdbSize float64
    Limits the maximum number of MAC addresses that VXLAN can store in the forwarding database (FDB).
    Mtu string
    Layer3 Maximum transmission unit ('auto', 0 .. 65535)
    Name string
    Name of the interface.
    Port float64
    Used UDP port number.
    Vni float64
    VXLAN Network Identifier (VNI).
    Vrf string
    The VRF table this resource operates on.
    VtepsIpVersion string
    Used IP protocol version for statically configured VTEPs. The RouterOS VXLAN interface does not support dual-stack, any configured remote VTEPs with the opposite IP version will be ignored. When multicast group or local-address properties are set, the vteps-ip-version automatically gets updated to the used IP version. The setting is available since RouterOS version 7.6.
    ___id_ float64
    Resource ID type (.id / name). This is an internal service field, setting a value is not required.
    ___path_ string
    Resource path for CRUD operations. This is an internal service field, setting a value is not required.
    ___id_ Double
    Resource ID type (.id / name). This is an internal service field, setting a value is not required.
    ___path_ String
    Resource path for CRUD operations. This is an internal service field, setting a value is not required.
    allowFastPath Boolean
    Whether to allow Fast Path processing. Fragmented and flooded packets over VXLAN are redirected via a slow path. Fast Path is disabled for VXLAN interface that uses IPv6 VTEP version or VRF. The setting is available since RouterOS version 7.8.
    arp String
    Address Resolution Protocol mode: * disabled - the interface will not use ARP * enabled - the interface will use ARP * local-proxy-arp - the router performs proxy ARP on the interface and sends replies to the same interface * proxy-arp - the router performs proxy ARP on the interface and sends replies to other interfaces * reply-only - the interface will only reply to requests originated from matching IP address/MAC address combinations which are entered as static entries in the ARP table. No dynamic entries will be automatically stored in the ARP table. Therefore for communications to be successful, a valid static entry must already exist.
    arpTimeout String
    ARP timeout is time how long ARP record is kept in ARP table after no packets are received from IP. Value auto equals to the value of arp-timeout in IP/Settings, default is 30s. Can use postfix ms, s, m, h, d for milliseconds, seconds, minutes, hours or days. If no postfix is set then seconds (s) is used.
    comment String
    disabled Boolean
    dontFragment String
    The Don't Fragment (DF) flag controls whether a packet can be broken into smaller packets, called fragments, before being sent over a network. When configuring VXLAN, this setting determines the presence of the DF flag on the outer IPv4 header and can control packet fragmentation if the encapsulated packet exceeds the outgoing interface MTU. This setting has three options: * disabled - the DF flag is not set on the outer IPv4 header, which means that packets can be fragmented if they are too large to be sent over the outgoing interface. This also allows packet fragmentation when VXLAN uses IPv6 underlay. * enabled - the DF flag is always set on the outer IPv4 header, which means that packets will not be fragmented and will be dropped if they exceed the outgoing interface's MTU. This also avoids packet fragmentation when VXLAN uses IPv6 underlay. * inherit - The DF flag on the outer IPv4 header is based on the inner IPv4 DF flag. If the inner IPv4 header has the DF flag set, the outer IPv4 header will also have it set. If the packet exceeds the outgoing interface's MTU and DF is set, it will be dropped. If the inner packet is non-IP, the outer IPv4 header will not have the DF flag set and packets can be fragmented. If the inner packet is IPv6, the outer IPv4 header will always set the DF flag and packets cannot be fragmented. Note that when VXLAN uses IPv6 underlay, this setting does not have any effect and is treated the same as disabled. The setting is available since RouterOS version 7.8.
    group String
    When specified, a multicast group address can be used to forward broadcast, unknown-unicast, and multicast traffic between VTEPs. This property requires specifying the interface setting. The interface will use IGMP or MLD to join the specified multicast group, make sure to add the necessary PIM and IGMP/MDL configuration. When this property is set, the vteps-ip-version automatically gets updated to the used multicast IP version.
    interfaceVxlanId String
    interface_ String
    Interface name used for multicast forwarding. This property requires specifying the group setting.
    localAddress String
    Specifies the local source address for the VXLAN interface. If not set, one IP address of the egress interface will be selected as a source address for VXLAN packets. When the property is set, the vteps-ip-version automatically gets updated to the used local IP version. The setting is available since RouterOS version 7.7.
    macAddress String
    Static MAC address of the interface. A randomly generated MAC address will be assigned when not specified.
    maxFdbSize Double
    Limits the maximum number of MAC addresses that VXLAN can store in the forwarding database (FDB).
    mtu String
    Layer3 Maximum transmission unit ('auto', 0 .. 65535)
    name String
    Name of the interface.
    port Double
    Used UDP port number.
    vni Double
    VXLAN Network Identifier (VNI).
    vrf String
    The VRF table this resource operates on.
    vtepsIpVersion String
    Used IP protocol version for statically configured VTEPs. The RouterOS VXLAN interface does not support dual-stack, any configured remote VTEPs with the opposite IP version will be ignored. When multicast group or local-address properties are set, the vteps-ip-version automatically gets updated to the used IP version. The setting is available since RouterOS version 7.6.
    ___id_ number
    Resource ID type (.id / name). This is an internal service field, setting a value is not required.
    ___path_ string
    Resource path for CRUD operations. This is an internal service field, setting a value is not required.
    allowFastPath boolean
    Whether to allow Fast Path processing. Fragmented and flooded packets over VXLAN are redirected via a slow path. Fast Path is disabled for VXLAN interface that uses IPv6 VTEP version or VRF. The setting is available since RouterOS version 7.8.
    arp string
    Address Resolution Protocol mode: * disabled - the interface will not use ARP * enabled - the interface will use ARP * local-proxy-arp - the router performs proxy ARP on the interface and sends replies to the same interface * proxy-arp - the router performs proxy ARP on the interface and sends replies to other interfaces * reply-only - the interface will only reply to requests originated from matching IP address/MAC address combinations which are entered as static entries in the ARP table. No dynamic entries will be automatically stored in the ARP table. Therefore for communications to be successful, a valid static entry must already exist.
    arpTimeout string
    ARP timeout is time how long ARP record is kept in ARP table after no packets are received from IP. Value auto equals to the value of arp-timeout in IP/Settings, default is 30s. Can use postfix ms, s, m, h, d for milliseconds, seconds, minutes, hours or days. If no postfix is set then seconds (s) is used.
    comment string
    disabled boolean
    dontFragment string
    The Don't Fragment (DF) flag controls whether a packet can be broken into smaller packets, called fragments, before being sent over a network. When configuring VXLAN, this setting determines the presence of the DF flag on the outer IPv4 header and can control packet fragmentation if the encapsulated packet exceeds the outgoing interface MTU. This setting has three options: * disabled - the DF flag is not set on the outer IPv4 header, which means that packets can be fragmented if they are too large to be sent over the outgoing interface. This also allows packet fragmentation when VXLAN uses IPv6 underlay. * enabled - the DF flag is always set on the outer IPv4 header, which means that packets will not be fragmented and will be dropped if they exceed the outgoing interface's MTU. This also avoids packet fragmentation when VXLAN uses IPv6 underlay. * inherit - The DF flag on the outer IPv4 header is based on the inner IPv4 DF flag. If the inner IPv4 header has the DF flag set, the outer IPv4 header will also have it set. If the packet exceeds the outgoing interface's MTU and DF is set, it will be dropped. If the inner packet is non-IP, the outer IPv4 header will not have the DF flag set and packets can be fragmented. If the inner packet is IPv6, the outer IPv4 header will always set the DF flag and packets cannot be fragmented. Note that when VXLAN uses IPv6 underlay, this setting does not have any effect and is treated the same as disabled. The setting is available since RouterOS version 7.8.
    group string
    When specified, a multicast group address can be used to forward broadcast, unknown-unicast, and multicast traffic between VTEPs. This property requires specifying the interface setting. The interface will use IGMP or MLD to join the specified multicast group, make sure to add the necessary PIM and IGMP/MDL configuration. When this property is set, the vteps-ip-version automatically gets updated to the used multicast IP version.
    interface string
    Interface name used for multicast forwarding. This property requires specifying the group setting.
    interfaceVxlanId string
    localAddress string
    Specifies the local source address for the VXLAN interface. If not set, one IP address of the egress interface will be selected as a source address for VXLAN packets. When the property is set, the vteps-ip-version automatically gets updated to the used local IP version. The setting is available since RouterOS version 7.7.
    macAddress string
    Static MAC address of the interface. A randomly generated MAC address will be assigned when not specified.
    maxFdbSize number
    Limits the maximum number of MAC addresses that VXLAN can store in the forwarding database (FDB).
    mtu string
    Layer3 Maximum transmission unit ('auto', 0 .. 65535)
    name string
    Name of the interface.
    port number
    Used UDP port number.
    vni number
    VXLAN Network Identifier (VNI).
    vrf string
    The VRF table this resource operates on.
    vtepsIpVersion string
    Used IP protocol version for statically configured VTEPs. The RouterOS VXLAN interface does not support dual-stack, any configured remote VTEPs with the opposite IP version will be ignored. When multicast group or local-address properties are set, the vteps-ip-version automatically gets updated to the used IP version. The setting is available since RouterOS version 7.6.
    ___id_ float
    Resource ID type (.id / name). This is an internal service field, setting a value is not required.
    ___path_ str
    Resource path for CRUD operations. This is an internal service field, setting a value is not required.
    allow_fast_path bool
    Whether to allow Fast Path processing. Fragmented and flooded packets over VXLAN are redirected via a slow path. Fast Path is disabled for VXLAN interface that uses IPv6 VTEP version or VRF. The setting is available since RouterOS version 7.8.
    arp str
    Address Resolution Protocol mode: * disabled - the interface will not use ARP * enabled - the interface will use ARP * local-proxy-arp - the router performs proxy ARP on the interface and sends replies to the same interface * proxy-arp - the router performs proxy ARP on the interface and sends replies to other interfaces * reply-only - the interface will only reply to requests originated from matching IP address/MAC address combinations which are entered as static entries in the ARP table. No dynamic entries will be automatically stored in the ARP table. Therefore for communications to be successful, a valid static entry must already exist.
    arp_timeout str
    ARP timeout is time how long ARP record is kept in ARP table after no packets are received from IP. Value auto equals to the value of arp-timeout in IP/Settings, default is 30s. Can use postfix ms, s, m, h, d for milliseconds, seconds, minutes, hours or days. If no postfix is set then seconds (s) is used.
    comment str
    disabled bool
    dont_fragment str
    The Don't Fragment (DF) flag controls whether a packet can be broken into smaller packets, called fragments, before being sent over a network. When configuring VXLAN, this setting determines the presence of the DF flag on the outer IPv4 header and can control packet fragmentation if the encapsulated packet exceeds the outgoing interface MTU. This setting has three options: * disabled - the DF flag is not set on the outer IPv4 header, which means that packets can be fragmented if they are too large to be sent over the outgoing interface. This also allows packet fragmentation when VXLAN uses IPv6 underlay. * enabled - the DF flag is always set on the outer IPv4 header, which means that packets will not be fragmented and will be dropped if they exceed the outgoing interface's MTU. This also avoids packet fragmentation when VXLAN uses IPv6 underlay. * inherit - The DF flag on the outer IPv4 header is based on the inner IPv4 DF flag. If the inner IPv4 header has the DF flag set, the outer IPv4 header will also have it set. If the packet exceeds the outgoing interface's MTU and DF is set, it will be dropped. If the inner packet is non-IP, the outer IPv4 header will not have the DF flag set and packets can be fragmented. If the inner packet is IPv6, the outer IPv4 header will always set the DF flag and packets cannot be fragmented. Note that when VXLAN uses IPv6 underlay, this setting does not have any effect and is treated the same as disabled. The setting is available since RouterOS version 7.8.
    group str
    When specified, a multicast group address can be used to forward broadcast, unknown-unicast, and multicast traffic between VTEPs. This property requires specifying the interface setting. The interface will use IGMP or MLD to join the specified multicast group, make sure to add the necessary PIM and IGMP/MDL configuration. When this property is set, the vteps-ip-version automatically gets updated to the used multicast IP version.
    interface str
    Interface name used for multicast forwarding. This property requires specifying the group setting.
    interface_vxlan_id str
    local_address str
    Specifies the local source address for the VXLAN interface. If not set, one IP address of the egress interface will be selected as a source address for VXLAN packets. When the property is set, the vteps-ip-version automatically gets updated to the used local IP version. The setting is available since RouterOS version 7.7.
    mac_address str
    Static MAC address of the interface. A randomly generated MAC address will be assigned when not specified.
    max_fdb_size float
    Limits the maximum number of MAC addresses that VXLAN can store in the forwarding database (FDB).
    mtu str
    Layer3 Maximum transmission unit ('auto', 0 .. 65535)
    name str
    Name of the interface.
    port float
    Used UDP port number.
    vni float
    VXLAN Network Identifier (VNI).
    vrf str
    The VRF table this resource operates on.
    vteps_ip_version str
    Used IP protocol version for statically configured VTEPs. The RouterOS VXLAN interface does not support dual-stack, any configured remote VTEPs with the opposite IP version will be ignored. When multicast group or local-address properties are set, the vteps-ip-version automatically gets updated to the used IP version. The setting is available since RouterOS version 7.6.
    ___id_ Number
    Resource ID type (.id / name). This is an internal service field, setting a value is not required.
    ___path_ String
    Resource path for CRUD operations. This is an internal service field, setting a value is not required.
    allowFastPath Boolean
    Whether to allow Fast Path processing. Fragmented and flooded packets over VXLAN are redirected via a slow path. Fast Path is disabled for VXLAN interface that uses IPv6 VTEP version or VRF. The setting is available since RouterOS version 7.8.
    arp String
    Address Resolution Protocol mode: * disabled - the interface will not use ARP * enabled - the interface will use ARP * local-proxy-arp - the router performs proxy ARP on the interface and sends replies to the same interface * proxy-arp - the router performs proxy ARP on the interface and sends replies to other interfaces * reply-only - the interface will only reply to requests originated from matching IP address/MAC address combinations which are entered as static entries in the ARP table. No dynamic entries will be automatically stored in the ARP table. Therefore for communications to be successful, a valid static entry must already exist.
    arpTimeout String
    ARP timeout is time how long ARP record is kept in ARP table after no packets are received from IP. Value auto equals to the value of arp-timeout in IP/Settings, default is 30s. Can use postfix ms, s, m, h, d for milliseconds, seconds, minutes, hours or days. If no postfix is set then seconds (s) is used.
    comment String
    disabled Boolean
    dontFragment String
    The Don't Fragment (DF) flag controls whether a packet can be broken into smaller packets, called fragments, before being sent over a network. When configuring VXLAN, this setting determines the presence of the DF flag on the outer IPv4 header and can control packet fragmentation if the encapsulated packet exceeds the outgoing interface MTU. This setting has three options: * disabled - the DF flag is not set on the outer IPv4 header, which means that packets can be fragmented if they are too large to be sent over the outgoing interface. This also allows packet fragmentation when VXLAN uses IPv6 underlay. * enabled - the DF flag is always set on the outer IPv4 header, which means that packets will not be fragmented and will be dropped if they exceed the outgoing interface's MTU. This also avoids packet fragmentation when VXLAN uses IPv6 underlay. * inherit - The DF flag on the outer IPv4 header is based on the inner IPv4 DF flag. If the inner IPv4 header has the DF flag set, the outer IPv4 header will also have it set. If the packet exceeds the outgoing interface's MTU and DF is set, it will be dropped. If the inner packet is non-IP, the outer IPv4 header will not have the DF flag set and packets can be fragmented. If the inner packet is IPv6, the outer IPv4 header will always set the DF flag and packets cannot be fragmented. Note that when VXLAN uses IPv6 underlay, this setting does not have any effect and is treated the same as disabled. The setting is available since RouterOS version 7.8.
    group String
    When specified, a multicast group address can be used to forward broadcast, unknown-unicast, and multicast traffic between VTEPs. This property requires specifying the interface setting. The interface will use IGMP or MLD to join the specified multicast group, make sure to add the necessary PIM and IGMP/MDL configuration. When this property is set, the vteps-ip-version automatically gets updated to the used multicast IP version.
    interface String
    Interface name used for multicast forwarding. This property requires specifying the group setting.
    interfaceVxlanId String
    localAddress String
    Specifies the local source address for the VXLAN interface. If not set, one IP address of the egress interface will be selected as a source address for VXLAN packets. When the property is set, the vteps-ip-version automatically gets updated to the used local IP version. The setting is available since RouterOS version 7.7.
    macAddress String
    Static MAC address of the interface. A randomly generated MAC address will be assigned when not specified.
    maxFdbSize Number
    Limits the maximum number of MAC addresses that VXLAN can store in the forwarding database (FDB).
    mtu String
    Layer3 Maximum transmission unit ('auto', 0 .. 65535)
    name String
    Name of the interface.
    port Number
    Used UDP port number.
    vni Number
    VXLAN Network Identifier (VNI).
    vrf String
    The VRF table this resource operates on.
    vtepsIpVersion String
    Used IP protocol version for statically configured VTEPs. The RouterOS VXLAN interface does not support dual-stack, any configured remote VTEPs with the opposite IP version will be ignored. When multicast group or local-address properties are set, the vteps-ip-version automatically gets updated to the used IP version. The setting is available since RouterOS version 7.6.

    Outputs

    All input properties are implicitly available as output properties. Additionally, the InterfaceVxlan resource produces the following output properties:

    Id string
    The provider-assigned unique ID for this managed resource.
    Id string
    The provider-assigned unique ID for this managed resource.
    id String
    The provider-assigned unique ID for this managed resource.
    id string
    The provider-assigned unique ID for this managed resource.
    id str
    The provider-assigned unique ID for this managed resource.
    id String
    The provider-assigned unique ID for this managed resource.

    Look up Existing InterfaceVxlan Resource

    Get an existing InterfaceVxlan resource’s state with the given name, ID, and optional extra properties used to qualify the lookup.

    public static get(name: string, id: Input<ID>, state?: InterfaceVxlanState, opts?: CustomResourceOptions): InterfaceVxlan
    @staticmethod
def get(resource_name: str,
        id: str,
        opts: Optional[ResourceOptions] = None,
        ___id_: Optional[float] = None,
        ___path_: Optional[str] = None,
        allow_fast_path: Optional[bool] = None,
        arp: Optional[str] = None,
        arp_timeout: Optional[str] = None,
        comment: Optional[str] = None,
        disabled: Optional[bool] = None,
        dont_fragment: Optional[str] = None,
        group: Optional[str] = None,
        interface: Optional[str] = None,
        interface_vxlan_id: Optional[str] = None,
        local_address: Optional[str] = None,
        mac_address: Optional[str] = None,
        max_fdb_size: Optional[float] = None,
        mtu: Optional[str] = None,
        name: Optional[str] = None,
        port: Optional[float] = None,
        vni: Optional[float] = None,
        vrf: Optional[str] = None,
        vteps_ip_version: Optional[str] = None) -> InterfaceVxlan
    func GetInterfaceVxlan(ctx *Context, name string, id IDInput, state *InterfaceVxlanState, opts ...ResourceOption) (*InterfaceVxlan, error)
    public static InterfaceVxlan Get(string name, Input<string> id, InterfaceVxlanState? state, CustomResourceOptions? opts = null)
    public static InterfaceVxlan get(String name, Output<String> id, InterfaceVxlanState state, CustomResourceOptions options)
    resources:  _:    type: routeros:InterfaceVxlan    get:      id: ${id}
    name
    The unique name of the resulting resource.
    id
    The unique provider ID of the resource to lookup.
    state
    Any extra arguments used during the lookup.
    opts
    A bag of options that control this resource's behavior.
    resource_name
    The unique name of the resulting resource.
    id
    The unique provider ID of the resource to lookup.
    name
    The unique name of the resulting resource.
    id
    The unique provider ID of the resource to lookup.
    state
    Any extra arguments used during the lookup.
    opts
    A bag of options that control this resource's behavior.
    name
    The unique name of the resulting resource.
    id
    The unique provider ID of the resource to lookup.
    state
    Any extra arguments used during the lookup.
    opts
    A bag of options that control this resource's behavior.
    name
    The unique name of the resulting resource.
    id
    The unique provider ID of the resource to lookup.
    state
    Any extra arguments used during the lookup.
    opts
    A bag of options that control this resource's behavior.
    The following state arguments are supported:
    AllowFastPath bool
    Whether to allow Fast Path processing. Fragmented and flooded packets over VXLAN are redirected via a slow path. Fast Path is disabled for VXLAN interface that uses IPv6 VTEP version or VRF. The setting is available since RouterOS version 7.8.
    Arp string
    Address Resolution Protocol mode: * disabled - the interface will not use ARP * enabled - the interface will use ARP * local-proxy-arp - the router performs proxy ARP on the interface and sends replies to the same interface * proxy-arp - the router performs proxy ARP on the interface and sends replies to other interfaces * reply-only - the interface will only reply to requests originated from matching IP address/MAC address combinations which are entered as static entries in the ARP table. No dynamic entries will be automatically stored in the ARP table. Therefore for communications to be successful, a valid static entry must already exist.
    ArpTimeout string
    ARP timeout is time how long ARP record is kept in ARP table after no packets are received from IP. Value auto equals to the value of arp-timeout in IP/Settings, default is 30s. Can use postfix ms, s, m, h, d for milliseconds, seconds, minutes, hours or days. If no postfix is set then seconds (s) is used.
    Comment string
    Disabled bool
    DontFragment string
    The Don't Fragment (DF) flag controls whether a packet can be broken into smaller packets, called fragments, before being sent over a network. When configuring VXLAN, this setting determines the presence of the DF flag on the outer IPv4 header and can control packet fragmentation if the encapsulated packet exceeds the outgoing interface MTU. This setting has three options: * disabled - the DF flag is not set on the outer IPv4 header, which means that packets can be fragmented if they are too large to be sent over the outgoing interface. This also allows packet fragmentation when VXLAN uses IPv6 underlay. * enabled - the DF flag is always set on the outer IPv4 header, which means that packets will not be fragmented and will be dropped if they exceed the outgoing interface's MTU. This also avoids packet fragmentation when VXLAN uses IPv6 underlay. * inherit - The DF flag on the outer IPv4 header is based on the inner IPv4 DF flag. If the inner IPv4 header has the DF flag set, the outer IPv4 header will also have it set. If the packet exceeds the outgoing interface's MTU and DF is set, it will be dropped. If the inner packet is non-IP, the outer IPv4 header will not have the DF flag set and packets can be fragmented. If the inner packet is IPv6, the outer IPv4 header will always set the DF flag and packets cannot be fragmented. Note that when VXLAN uses IPv6 underlay, this setting does not have any effect and is treated the same as disabled. The setting is available since RouterOS version 7.8.
    Group string
    When specified, a multicast group address can be used to forward broadcast, unknown-unicast, and multicast traffic between VTEPs. This property requires specifying the interface setting. The interface will use IGMP or MLD to join the specified multicast group, make sure to add the necessary PIM and IGMP/MDL configuration. When this property is set, the vteps-ip-version automatically gets updated to the used multicast IP version.
    Interface string
    Interface name used for multicast forwarding. This property requires specifying the group setting.
    InterfaceVxlanId string
    LocalAddress string
    Specifies the local source address for the VXLAN interface. If not set, one IP address of the egress interface will be selected as a source address for VXLAN packets. When the property is set, the vteps-ip-version automatically gets updated to the used local IP version. The setting is available since RouterOS version 7.7.
    MacAddress string
    Static MAC address of the interface. A randomly generated MAC address will be assigned when not specified.
    MaxFdbSize double
    Limits the maximum number of MAC addresses that VXLAN can store in the forwarding database (FDB).
    Mtu string
    Layer3 Maximum transmission unit ('auto', 0 .. 65535)
    Name string
    Name of the interface.
    Port double
    Used UDP port number.
    Vni double
    VXLAN Network Identifier (VNI).
    Vrf string
    The VRF table this resource operates on.
    VtepsIpVersion string
    Used IP protocol version for statically configured VTEPs. The RouterOS VXLAN interface does not support dual-stack, any configured remote VTEPs with the opposite IP version will be ignored. When multicast group or local-address properties are set, the vteps-ip-version automatically gets updated to the used IP version. The setting is available since RouterOS version 7.6.
    ___id_ double
    Resource ID type (.id / name). This is an internal service field, setting a value is not required.
    ___path_ string
    Resource path for CRUD operations. This is an internal service field, setting a value is not required.
    AllowFastPath bool
    Whether to allow Fast Path processing. Fragmented and flooded packets over VXLAN are redirected via a slow path. Fast Path is disabled for VXLAN interface that uses IPv6 VTEP version or VRF. The setting is available since RouterOS version 7.8.
    Arp string
    Address Resolution Protocol mode: * disabled - the interface will not use ARP * enabled - the interface will use ARP * local-proxy-arp - the router performs proxy ARP on the interface and sends replies to the same interface * proxy-arp - the router performs proxy ARP on the interface and sends replies to other interfaces * reply-only - the interface will only reply to requests originated from matching IP address/MAC address combinations which are entered as static entries in the ARP table. No dynamic entries will be automatically stored in the ARP table. Therefore for communications to be successful, a valid static entry must already exist.
    ArpTimeout string
    ARP timeout is time how long ARP record is kept in ARP table after no packets are received from IP. Value auto equals to the value of arp-timeout in IP/Settings, default is 30s. Can use postfix ms, s, m, h, d for milliseconds, seconds, minutes, hours or days. If no postfix is set then seconds (s) is used.
    Comment string
    Disabled bool
    DontFragment string
    The Don't Fragment (DF) flag controls whether a packet can be broken into smaller packets, called fragments, before being sent over a network. When configuring VXLAN, this setting determines the presence of the DF flag on the outer IPv4 header and can control packet fragmentation if the encapsulated packet exceeds the outgoing interface MTU. This setting has three options: * disabled - the DF flag is not set on the outer IPv4 header, which means that packets can be fragmented if they are too large to be sent over the outgoing interface. This also allows packet fragmentation when VXLAN uses IPv6 underlay. * enabled - the DF flag is always set on the outer IPv4 header, which means that packets will not be fragmented and will be dropped if they exceed the outgoing interface's MTU. This also avoids packet fragmentation when VXLAN uses IPv6 underlay. * inherit - The DF flag on the outer IPv4 header is based on the inner IPv4 DF flag. If the inner IPv4 header has the DF flag set, the outer IPv4 header will also have it set. If the packet exceeds the outgoing interface's MTU and DF is set, it will be dropped. If the inner packet is non-IP, the outer IPv4 header will not have the DF flag set and packets can be fragmented. If the inner packet is IPv6, the outer IPv4 header will always set the DF flag and packets cannot be fragmented. Note that when VXLAN uses IPv6 underlay, this setting does not have any effect and is treated the same as disabled. The setting is available since RouterOS version 7.8.
    Group string
    When specified, a multicast group address can be used to forward broadcast, unknown-unicast, and multicast traffic between VTEPs. This property requires specifying the interface setting. The interface will use IGMP or MLD to join the specified multicast group, make sure to add the necessary PIM and IGMP/MDL configuration. When this property is set, the vteps-ip-version automatically gets updated to the used multicast IP version.
    Interface string
    Interface name used for multicast forwarding. This property requires specifying the group setting.
    InterfaceVxlanId string
    LocalAddress string
    Specifies the local source address for the VXLAN interface. If not set, one IP address of the egress interface will be selected as a source address for VXLAN packets. When the property is set, the vteps-ip-version automatically gets updated to the used local IP version. The setting is available since RouterOS version 7.7.
    MacAddress string
    Static MAC address of the interface. A randomly generated MAC address will be assigned when not specified.
    MaxFdbSize float64
    Limits the maximum number of MAC addresses that VXLAN can store in the forwarding database (FDB).
    Mtu string
    Layer3 Maximum transmission unit ('auto', 0 .. 65535)
    Name string
    Name of the interface.
    Port float64
    Used UDP port number.
    Vni float64
    VXLAN Network Identifier (VNI).
    Vrf string
    The VRF table this resource operates on.
    VtepsIpVersion string
    Used IP protocol version for statically configured VTEPs. The RouterOS VXLAN interface does not support dual-stack, any configured remote VTEPs with the opposite IP version will be ignored. When multicast group or local-address properties are set, the vteps-ip-version automatically gets updated to the used IP version. The setting is available since RouterOS version 7.6.
    ___id_ float64
    Resource ID type (.id / name). This is an internal service field, setting a value is not required.
    ___path_ string
    Resource path for CRUD operations. This is an internal service field, setting a value is not required.
    ___id_ Double
    Resource ID type (.id / name). This is an internal service field, setting a value is not required.
    ___path_ String
    Resource path for CRUD operations. This is an internal service field, setting a value is not required.
    allowFastPath Boolean
    Whether to allow Fast Path processing. Fragmented and flooded packets over VXLAN are redirected via a slow path. Fast Path is disabled for VXLAN interface that uses IPv6 VTEP version or VRF. The setting is available since RouterOS version 7.8.
    arp String
    Address Resolution Protocol mode: * disabled - the interface will not use ARP * enabled - the interface will use ARP * local-proxy-arp - the router performs proxy ARP on the interface and sends replies to the same interface * proxy-arp - the router performs proxy ARP on the interface and sends replies to other interfaces * reply-only - the interface will only reply to requests originated from matching IP address/MAC address combinations which are entered as static entries in the ARP table. No dynamic entries will be automatically stored in the ARP table. Therefore for communications to be successful, a valid static entry must already exist.
    arpTimeout String
    ARP timeout is time how long ARP record is kept in ARP table after no packets are received from IP. Value auto equals to the value of arp-timeout in IP/Settings, default is 30s. Can use postfix ms, s, m, h, d for milliseconds, seconds, minutes, hours or days. If no postfix is set then seconds (s) is used.
    comment String
    disabled Boolean
    dontFragment String
    The Don't Fragment (DF) flag controls whether a packet can be broken into smaller packets, called fragments, before being sent over a network. When configuring VXLAN, this setting determines the presence of the DF flag on the outer IPv4 header and can control packet fragmentation if the encapsulated packet exceeds the outgoing interface MTU. This setting has three options: * disabled - the DF flag is not set on the outer IPv4 header, which means that packets can be fragmented if they are too large to be sent over the outgoing interface. This also allows packet fragmentation when VXLAN uses IPv6 underlay. * enabled - the DF flag is always set on the outer IPv4 header, which means that packets will not be fragmented and will be dropped if they exceed the outgoing interface's MTU. This also avoids packet fragmentation when VXLAN uses IPv6 underlay. * inherit - The DF flag on the outer IPv4 header is based on the inner IPv4 DF flag. If the inner IPv4 header has the DF flag set, the outer IPv4 header will also have it set. If the packet exceeds the outgoing interface's MTU and DF is set, it will be dropped. If the inner packet is non-IP, the outer IPv4 header will not have the DF flag set and packets can be fragmented. If the inner packet is IPv6, the outer IPv4 header will always set the DF flag and packets cannot be fragmented. Note that when VXLAN uses IPv6 underlay, this setting does not have any effect and is treated the same as disabled. The setting is available since RouterOS version 7.8.
    group String
    When specified, a multicast group address can be used to forward broadcast, unknown-unicast, and multicast traffic between VTEPs. This property requires specifying the interface setting. The interface will use IGMP or MLD to join the specified multicast group, make sure to add the necessary PIM and IGMP/MDL configuration. When this property is set, the vteps-ip-version automatically gets updated to the used multicast IP version.
    interfaceVxlanId String
    interface_ String
    Interface name used for multicast forwarding. This property requires specifying the group setting.
    localAddress String
    Specifies the local source address for the VXLAN interface. If not set, one IP address of the egress interface will be selected as a source address for VXLAN packets. When the property is set, the vteps-ip-version automatically gets updated to the used local IP version. The setting is available since RouterOS version 7.7.
    macAddress String
    Static MAC address of the interface. A randomly generated MAC address will be assigned when not specified.
    maxFdbSize Double
    Limits the maximum number of MAC addresses that VXLAN can store in the forwarding database (FDB).
    mtu String
    Layer3 Maximum transmission unit ('auto', 0 .. 65535)
    name String
    Name of the interface.
    port Double
    Used UDP port number.
    vni Double
    VXLAN Network Identifier (VNI).
    vrf String
    The VRF table this resource operates on.
    vtepsIpVersion String
    Used IP protocol version for statically configured VTEPs. The RouterOS VXLAN interface does not support dual-stack, any configured remote VTEPs with the opposite IP version will be ignored. When multicast group or local-address properties are set, the vteps-ip-version automatically gets updated to the used IP version. The setting is available since RouterOS version 7.6.
    ___id_ number
    Resource ID type (.id / name). This is an internal service field, setting a value is not required.
    ___path_ string
    Resource path for CRUD operations. This is an internal service field, setting a value is not required.
    allowFastPath boolean
    Whether to allow Fast Path processing. Fragmented and flooded packets over VXLAN are redirected via a slow path. Fast Path is disabled for VXLAN interface that uses IPv6 VTEP version or VRF. The setting is available since RouterOS version 7.8.
    arp string
    Address Resolution Protocol mode: * disabled - the interface will not use ARP * enabled - the interface will use ARP * local-proxy-arp - the router performs proxy ARP on the interface and sends replies to the same interface * proxy-arp - the router performs proxy ARP on the interface and sends replies to other interfaces * reply-only - the interface will only reply to requests originated from matching IP address/MAC address combinations which are entered as static entries in the ARP table. No dynamic entries will be automatically stored in the ARP table. Therefore for communications to be successful, a valid static entry must already exist.
    arpTimeout string
    ARP timeout is time how long ARP record is kept in ARP table after no packets are received from IP. Value auto equals to the value of arp-timeout in IP/Settings, default is 30s. Can use postfix ms, s, m, h, d for milliseconds, seconds, minutes, hours or days. If no postfix is set then seconds (s) is used.
    comment string
    disabled boolean
    dontFragment string
    The Don't Fragment (DF) flag controls whether a packet can be broken into smaller packets, called fragments, before being sent over a network. When configuring VXLAN, this setting determines the presence of the DF flag on the outer IPv4 header and can control packet fragmentation if the encapsulated packet exceeds the outgoing interface MTU. This setting has three options: * disabled - the DF flag is not set on the outer IPv4 header, which means that packets can be fragmented if they are too large to be sent over the outgoing interface. This also allows packet fragmentation when VXLAN uses IPv6 underlay. * enabled - the DF flag is always set on the outer IPv4 header, which means that packets will not be fragmented and will be dropped if they exceed the outgoing interface's MTU. This also avoids packet fragmentation when VXLAN uses IPv6 underlay. * inherit - The DF flag on the outer IPv4 header is based on the inner IPv4 DF flag. If the inner IPv4 header has the DF flag set, the outer IPv4 header will also have it set. If the packet exceeds the outgoing interface's MTU and DF is set, it will be dropped. If the inner packet is non-IP, the outer IPv4 header will not have the DF flag set and packets can be fragmented. If the inner packet is IPv6, the outer IPv4 header will always set the DF flag and packets cannot be fragmented. Note that when VXLAN uses IPv6 underlay, this setting does not have any effect and is treated the same as disabled. The setting is available since RouterOS version 7.8.
    group string
    When specified, a multicast group address can be used to forward broadcast, unknown-unicast, and multicast traffic between VTEPs. This property requires specifying the interface setting. The interface will use IGMP or MLD to join the specified multicast group, make sure to add the necessary PIM and IGMP/MDL configuration. When this property is set, the vteps-ip-version automatically gets updated to the used multicast IP version.
    interface string
    Interface name used for multicast forwarding. This property requires specifying the group setting.
    interfaceVxlanId string
    localAddress string
    Specifies the local source address for the VXLAN interface. If not set, one IP address of the egress interface will be selected as a source address for VXLAN packets. When the property is set, the vteps-ip-version automatically gets updated to the used local IP version. The setting is available since RouterOS version 7.7.
    macAddress string
    Static MAC address of the interface. A randomly generated MAC address will be assigned when not specified.
    maxFdbSize number
    Limits the maximum number of MAC addresses that VXLAN can store in the forwarding database (FDB).
    mtu string
    Layer3 Maximum transmission unit ('auto', 0 .. 65535)
    name string
    Name of the interface.
    port number
    Used UDP port number.
    vni number
    VXLAN Network Identifier (VNI).
    vrf string
    The VRF table this resource operates on.
    vtepsIpVersion string
    Used IP protocol version for statically configured VTEPs. The RouterOS VXLAN interface does not support dual-stack, any configured remote VTEPs with the opposite IP version will be ignored. When multicast group or local-address properties are set, the vteps-ip-version automatically gets updated to the used IP version. The setting is available since RouterOS version 7.6.
    ___id_ float
    Resource ID type (.id / name). This is an internal service field, setting a value is not required.
    ___path_ str
    Resource path for CRUD operations. This is an internal service field, setting a value is not required.
    allow_fast_path bool
    Whether to allow Fast Path processing. Fragmented and flooded packets over VXLAN are redirected via a slow path. Fast Path is disabled for VXLAN interface that uses IPv6 VTEP version or VRF. The setting is available since RouterOS version 7.8.
    arp str
    Address Resolution Protocol mode: * disabled - the interface will not use ARP * enabled - the interface will use ARP * local-proxy-arp - the router performs proxy ARP on the interface and sends replies to the same interface * proxy-arp - the router performs proxy ARP on the interface and sends replies to other interfaces * reply-only - the interface will only reply to requests originated from matching IP address/MAC address combinations which are entered as static entries in the ARP table. No dynamic entries will be automatically stored in the ARP table. Therefore for communications to be successful, a valid static entry must already exist.
    arp_timeout str
    ARP timeout is time how long ARP record is kept in ARP table after no packets are received from IP. Value auto equals to the value of arp-timeout in IP/Settings, default is 30s. Can use postfix ms, s, m, h, d for milliseconds, seconds, minutes, hours or days. If no postfix is set then seconds (s) is used.
    comment str
    disabled bool
    dont_fragment str
    The Don't Fragment (DF) flag controls whether a packet can be broken into smaller packets, called fragments, before being sent over a network. When configuring VXLAN, this setting determines the presence of the DF flag on the outer IPv4 header and can control packet fragmentation if the encapsulated packet exceeds the outgoing interface MTU. This setting has three options: * disabled - the DF flag is not set on the outer IPv4 header, which means that packets can be fragmented if they are too large to be sent over the outgoing interface. This also allows packet fragmentation when VXLAN uses IPv6 underlay. * enabled - the DF flag is always set on the outer IPv4 header, which means that packets will not be fragmented and will be dropped if they exceed the outgoing interface's MTU. This also avoids packet fragmentation when VXLAN uses IPv6 underlay. * inherit - The DF flag on the outer IPv4 header is based on the inner IPv4 DF flag. If the inner IPv4 header has the DF flag set, the outer IPv4 header will also have it set. If the packet exceeds the outgoing interface's MTU and DF is set, it will be dropped. If the inner packet is non-IP, the outer IPv4 header will not have the DF flag set and packets can be fragmented. If the inner packet is IPv6, the outer IPv4 header will always set the DF flag and packets cannot be fragmented. Note that when VXLAN uses IPv6 underlay, this setting does not have any effect and is treated the same as disabled. The setting is available since RouterOS version 7.8.
    group str
    When specified, a multicast group address can be used to forward broadcast, unknown-unicast, and multicast traffic between VTEPs. This property requires specifying the interface setting. The interface will use IGMP or MLD to join the specified multicast group, make sure to add the necessary PIM and IGMP/MDL configuration. When this property is set, the vteps-ip-version automatically gets updated to the used multicast IP version.
    interface str
    Interface name used for multicast forwarding. This property requires specifying the group setting.
    interface_vxlan_id str
    local_address str
    Specifies the local source address for the VXLAN interface. If not set, one IP address of the egress interface will be selected as a source address for VXLAN packets. When the property is set, the vteps-ip-version automatically gets updated to the used local IP version. The setting is available since RouterOS version 7.7.
    mac_address str
    Static MAC address of the interface. A randomly generated MAC address will be assigned when not specified.
    max_fdb_size float
    Limits the maximum number of MAC addresses that VXLAN can store in the forwarding database (FDB).
    mtu str
    Layer3 Maximum transmission unit ('auto', 0 .. 65535)
    name str
    Name of the interface.
    port float
    Used UDP port number.
    vni float
    VXLAN Network Identifier (VNI).
    vrf str
    The VRF table this resource operates on.
    vteps_ip_version str
    Used IP protocol version for statically configured VTEPs. The RouterOS VXLAN interface does not support dual-stack, any configured remote VTEPs with the opposite IP version will be ignored. When multicast group or local-address properties are set, the vteps-ip-version automatically gets updated to the used IP version. The setting is available since RouterOS version 7.6.
    ___id_ Number
    Resource ID type (.id / name). This is an internal service field, setting a value is not required.
    ___path_ String
    Resource path for CRUD operations. This is an internal service field, setting a value is not required.
    allowFastPath Boolean
    Whether to allow Fast Path processing. Fragmented and flooded packets over VXLAN are redirected via a slow path. Fast Path is disabled for VXLAN interface that uses IPv6 VTEP version or VRF. The setting is available since RouterOS version 7.8.
    arp String
    Address Resolution Protocol mode: * disabled - the interface will not use ARP * enabled - the interface will use ARP * local-proxy-arp - the router performs proxy ARP on the interface and sends replies to the same interface * proxy-arp - the router performs proxy ARP on the interface and sends replies to other interfaces * reply-only - the interface will only reply to requests originated from matching IP address/MAC address combinations which are entered as static entries in the ARP table. No dynamic entries will be automatically stored in the ARP table. Therefore for communications to be successful, a valid static entry must already exist.
    arpTimeout String
    ARP timeout is time how long ARP record is kept in ARP table after no packets are received from IP. Value auto equals to the value of arp-timeout in IP/Settings, default is 30s. Can use postfix ms, s, m, h, d for milliseconds, seconds, minutes, hours or days. If no postfix is set then seconds (s) is used.
    comment String
    disabled Boolean
    dontFragment String
    The Don't Fragment (DF) flag controls whether a packet can be broken into smaller packets, called fragments, before being sent over a network. When configuring VXLAN, this setting determines the presence of the DF flag on the outer IPv4 header and can control packet fragmentation if the encapsulated packet exceeds the outgoing interface MTU. This setting has three options: * disabled - the DF flag is not set on the outer IPv4 header, which means that packets can be fragmented if they are too large to be sent over the outgoing interface. This also allows packet fragmentation when VXLAN uses IPv6 underlay. * enabled - the DF flag is always set on the outer IPv4 header, which means that packets will not be fragmented and will be dropped if they exceed the outgoing interface's MTU. This also avoids packet fragmentation when VXLAN uses IPv6 underlay. * inherit - The DF flag on the outer IPv4 header is based on the inner IPv4 DF flag. If the inner IPv4 header has the DF flag set, the outer IPv4 header will also have it set. If the packet exceeds the outgoing interface's MTU and DF is set, it will be dropped. If the inner packet is non-IP, the outer IPv4 header will not have the DF flag set and packets can be fragmented. If the inner packet is IPv6, the outer IPv4 header will always set the DF flag and packets cannot be fragmented. Note that when VXLAN uses IPv6 underlay, this setting does not have any effect and is treated the same as disabled. The setting is available since RouterOS version 7.8.
    group String
    When specified, a multicast group address can be used to forward broadcast, unknown-unicast, and multicast traffic between VTEPs. This property requires specifying the interface setting. The interface will use IGMP or MLD to join the specified multicast group, make sure to add the necessary PIM and IGMP/MDL configuration. When this property is set, the vteps-ip-version automatically gets updated to the used multicast IP version.
    interface String
    Interface name used for multicast forwarding. This property requires specifying the group setting.
    interfaceVxlanId String
    localAddress String
    Specifies the local source address for the VXLAN interface. If not set, one IP address of the egress interface will be selected as a source address for VXLAN packets. When the property is set, the vteps-ip-version automatically gets updated to the used local IP version. The setting is available since RouterOS version 7.7.
    macAddress String
    Static MAC address of the interface. A randomly generated MAC address will be assigned when not specified.
    maxFdbSize Number
    Limits the maximum number of MAC addresses that VXLAN can store in the forwarding database (FDB).
    mtu String
    Layer3 Maximum transmission unit ('auto', 0 .. 65535)
    name String
    Name of the interface.
    port Number
    Used UDP port number.
    vni Number
    VXLAN Network Identifier (VNI).
    vrf String
    The VRF table this resource operates on.
    vtepsIpVersion String
    Used IP protocol version for statically configured VTEPs. The RouterOS VXLAN interface does not support dual-stack, any configured remote VTEPs with the opposite IP version will be ignored. When multicast group or local-address properties are set, the vteps-ip-version automatically gets updated to the used IP version. The setting is available since RouterOS version 7.6.

    Import

    #The ID can be found via API or the terminal

    #The command for the terminal is -> :put [/interface/vxlan get [print show-ids]]

    $ pulumi import routeros:index/interfaceVxlan:InterfaceVxlan test *3

    #Or you can import a resource using one of its attributes

    $ pulumi import routeros:index/interfaceVxlan:InterfaceVxlan test "name=vxlan1"

    To learn more about importing existing cloud resources, see Importing resources.

    Package Details

    Repository
    routeros terraform-routeros/terraform-provider-routeros
    License
    Notes
    This Pulumi package is based on the routeros Terraform Provider.
    routeros logo
    routeros 1.81.2 published on Tuesday, Apr 15, 2025 by terraform-routeros
    terraform-routeros/terraform-provider-routeros