1. Packages
  2. Proxmox Virtual Environment (Proxmox VE)
  3. API Docs
  4. sdn
  5. sdn/zone
  6. VxlanLegacy
Viewing docs for Proxmox Virtual Environment (Proxmox VE) v8.0.0
published on Sunday, Apr 5, 2026 by Daniel Muehlbachler-Pietrzykowski
Schema (JSON)
muhlba91/pulumi-proxmoxve

proxmoxve.sdn/zone.VxlanLegacy

proxmoxve logo
Viewing docs for Proxmox Virtual Environment (Proxmox VE) v8.0.0
published on Sunday, Apr 5, 2026 by Daniel Muehlbachler-Pietrzykowski
Schema (JSON)
muhlba91/pulumi-proxmoxve

    Deprecated: Use proxmoxve.sdn/zone.Vxlan instead. This resource will be removed in v1.0.

    VXLAN Zone in Proxmox SDN. It establishes a tunnel (overlay) on top of an existing network (underlay). This encapsulates layer 2 Ethernet frames within layer 4 UDP datagrams using the default destination port 4789. You have to configure the underlay network yourself to enable UDP connectivity between all peers. Because VXLAN encapsulation uses 50 bytes, the MTU needs to be 50 bytes lower than the outgoing physical interface.

    Example Usage

    import * as pulumi from "@pulumi/pulumi";
import * as proxmoxve from "@muhlba91/pulumi-proxmoxve";

const example = new proxmoxve.sdn.zone.VxlanLegacy("example", {
    resourceId: "vxlan1",
    peers: [
        "10.0.0.1",
        "10.0.0.2",
        "10.0.0.3",
    ],
    mtu: 1450,
    dns: "1.1.1.1",
    dnsZone: "example.com",
    ipam: "pve",
    reverseDns: "1.1.1.1",
});

    import pulumi
import pulumi_proxmoxve as proxmoxve

example = proxmoxve.sdn.zone.VxlanLegacy("example",
    resource_id="vxlan1",
    peers=[
        "10.0.0.1",
        "10.0.0.2",
        "10.0.0.3",
    ],
    mtu=1450,
    dns="1.1.1.1",
    dns_zone="example.com",
    ipam="pve",
    reverse_dns="1.1.1.1")

    package main

import (
	"github.com/muhlba91/pulumi-proxmoxve/sdk/v8/go/proxmoxve/sdn"
	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
)

func main() {
	pulumi.Run(func(ctx *pulumi.Context) error {
		_, err := sdn.NewVxlanLegacy(ctx, "example", &sdn.VxlanLegacyArgs{
			ResourceId: pulumi.String("vxlan1"),
			Peers: pulumi.StringArray{
				pulumi.String("10.0.0.1"),
				pulumi.String("10.0.0.2"),
				pulumi.String("10.0.0.3"),
			},
			Mtu:        pulumi.Int(1450),
			Dns:        pulumi.String("1.1.1.1"),
			DnsZone:    pulumi.String("example.com"),
			Ipam:       pulumi.String("pve"),
			ReverseDns: pulumi.String("1.1.1.1"),
		})
		if err != nil {
			return err
		}
		return nil
	})
}

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

return await Deployment.RunAsync(() => 
{
    var example = new ProxmoxVE.Sdn.Zone.VxlanLegacy("example", new()
    {
        ResourceId = "vxlan1",
        Peers = new[]
        {
            "10.0.0.1",
            "10.0.0.2",
            "10.0.0.3",
        },
        Mtu = %!v(PANIC=Format method: fatal: A failure has occurred: unexpected literal type in GenLiteralValueExpression: cty.NumberIntVal(1450) (example.pp:3,16-20)),
        Dns = "1.1.1.1",
        DnsZone = "example.com",
        Ipam = "pve",
        ReverseDns = "1.1.1.1",
    });

});

    package generated_program;

import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import io.muehlbachler.pulumi.proxmoxve.sdn.VxlanLegacy;
import io.muehlbachler.pulumi.proxmoxve.sdn.VxlanLegacyArgs;
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 example = new VxlanLegacy("example", VxlanLegacyArgs.builder()
            .resourceId("vxlan1")
            .peers(            
                "10.0.0.1",
                "10.0.0.2",
                "10.0.0.3")
            .mtu(%!v(PANIC=Format method: fatal: A failure has occurred: unexpected literal type in GenLiteralValueExpression: cty.NumberIntVal(1450) (example.pp:3,16-20)))
            .dns("1.1.1.1")
            .dnsZone("example.com")
            .ipam("pve")
            .reverseDns("1.1.1.1")
            .build());

    }
}

    resources:
  example:
    type: proxmoxve:sdn/zone:VxlanLegacy
    properties:
      resourceId: vxlan1
      peers:
        - 10.0.0.1
        - 10.0.0.2
        - 10.0.0.3
      mtu: 1450 # Optional attributes
      dns: 1.1.1.1
      dnsZone: example.com
      ipam: pve
      reverseDns: 1.1.1.1

    Create VxlanLegacy Resource

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

    Constructor syntax

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

@overload
def VxlanLegacy(resource_name: str,
                opts: Optional[ResourceOptions] = None,
                peers: Optional[Sequence[str]] = None,
                resource_id: Optional[str] = None,
                dns: Optional[str] = None,
                dns_zone: Optional[str] = None,
                ipam: Optional[str] = None,
                mtu: Optional[int] = None,
                nodes: Optional[Sequence[str]] = None,
                reverse_dns: Optional[str] = None)
    func NewVxlanLegacy(ctx *Context, name string, args VxlanLegacyArgs, opts ...ResourceOption) (*VxlanLegacy, error)
    public VxlanLegacy(string name, VxlanLegacyArgs args, CustomResourceOptions? opts = null)
    public VxlanLegacy(String name, VxlanLegacyArgs args)
public VxlanLegacy(String name, VxlanLegacyArgs args, CustomResourceOptions options)

    type: proxmoxve:sdn/zone/vxlanLegacy:VxlanLegacy
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 VxlanLegacyArgs
    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 VxlanLegacyArgs
    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 VxlanLegacyArgs
    The arguments to resource properties.
    opts ResourceOption
    Bag of options to control resource's behavior.
    name string
    The unique name of the resource.
    args VxlanLegacyArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    name String
    The unique name of the resource.
    args VxlanLegacyArgs
    The arguments to resource properties.
    options CustomResourceOptions
    Bag of options to control resource's behavior.

    VxlanLegacy 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 VxlanLegacy resource accepts the following input properties:

    Peers List<string>
    A list of IP addresses of each node in the VXLAN zone. This can be external nodes reachable at this IP address. All nodes in the cluster need to be mentioned here
    ResourceId string
    The unique identifier of the SDN zone.
    Dns string
    DNS API server address.
    DnsZone string
    DNS domain name. Used to register hostnames, such as <hostname>.<domain>. The DNS zone must already exist on the DNS server.
    Ipam string
    IP Address Management system.
    Mtu int
    MTU value for the zone. There is no support to reset this value back to PVE default once set due to API limitation.
    Nodes List<string>
    The Proxmox nodes which the zone and associated VNets should be deployed on
    ReverseDns string
    Reverse DNS API server address.
    Peers []string
    A list of IP addresses of each node in the VXLAN zone. This can be external nodes reachable at this IP address. All nodes in the cluster need to be mentioned here
    ResourceId string
    The unique identifier of the SDN zone.
    Dns string
    DNS API server address.
    DnsZone string
    DNS domain name. Used to register hostnames, such as <hostname>.<domain>. The DNS zone must already exist on the DNS server.
    Ipam string
    IP Address Management system.
    Mtu int
    MTU value for the zone. There is no support to reset this value back to PVE default once set due to API limitation.
    Nodes []string
    The Proxmox nodes which the zone and associated VNets should be deployed on
    ReverseDns string
    Reverse DNS API server address.
    peers List<String>
    A list of IP addresses of each node in the VXLAN zone. This can be external nodes reachable at this IP address. All nodes in the cluster need to be mentioned here
    resourceId String
    The unique identifier of the SDN zone.
    dns String
    DNS API server address.
    dnsZone String
    DNS domain name. Used to register hostnames, such as <hostname>.<domain>. The DNS zone must already exist on the DNS server.
    ipam String
    IP Address Management system.
    mtu Integer
    MTU value for the zone. There is no support to reset this value back to PVE default once set due to API limitation.
    nodes List<String>
    The Proxmox nodes which the zone and associated VNets should be deployed on
    reverseDns String
    Reverse DNS API server address.
    peers string[]
    A list of IP addresses of each node in the VXLAN zone. This can be external nodes reachable at this IP address. All nodes in the cluster need to be mentioned here
    resourceId string
    The unique identifier of the SDN zone.
    dns string
    DNS API server address.
    dnsZone string
    DNS domain name. Used to register hostnames, such as <hostname>.<domain>. The DNS zone must already exist on the DNS server.
    ipam string
    IP Address Management system.
    mtu number
    MTU value for the zone. There is no support to reset this value back to PVE default once set due to API limitation.
    nodes string[]
    The Proxmox nodes which the zone and associated VNets should be deployed on
    reverseDns string
    Reverse DNS API server address.
    peers Sequence[str]
    A list of IP addresses of each node in the VXLAN zone. This can be external nodes reachable at this IP address. All nodes in the cluster need to be mentioned here
    resource_id str
    The unique identifier of the SDN zone.
    dns str
    DNS API server address.
    dns_zone str
    DNS domain name. Used to register hostnames, such as <hostname>.<domain>. The DNS zone must already exist on the DNS server.
    ipam str
    IP Address Management system.
    mtu int
    MTU value for the zone. There is no support to reset this value back to PVE default once set due to API limitation.
    nodes Sequence[str]
    The Proxmox nodes which the zone and associated VNets should be deployed on
    reverse_dns str
    Reverse DNS API server address.
    peers List<String>
    A list of IP addresses of each node in the VXLAN zone. This can be external nodes reachable at this IP address. All nodes in the cluster need to be mentioned here
    resourceId String
    The unique identifier of the SDN zone.
    dns String
    DNS API server address.
    dnsZone String
    DNS domain name. Used to register hostnames, such as <hostname>.<domain>. The DNS zone must already exist on the DNS server.
    ipam String
    IP Address Management system.
    mtu Number
    MTU value for the zone. There is no support to reset this value back to PVE default once set due to API limitation.
    nodes List<String>
    The Proxmox nodes which the zone and associated VNets should be deployed on
    reverseDns String
    Reverse DNS API server address.

    Outputs

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

    Id string
    The provider-assigned unique ID for this managed resource.
    Pending bool
    Indicates if the zone has pending configuration changes that need to be applied.
    State string
    Indicates the current state of the zone.
    Id string
    The provider-assigned unique ID for this managed resource.
    Pending bool
    Indicates if the zone has pending configuration changes that need to be applied.
    State string
    Indicates the current state of the zone.
    id String
    The provider-assigned unique ID for this managed resource.
    pending Boolean
    Indicates if the zone has pending configuration changes that need to be applied.
    state String
    Indicates the current state of the zone.
    id string
    The provider-assigned unique ID for this managed resource.
    pending boolean
    Indicates if the zone has pending configuration changes that need to be applied.
    state string
    Indicates the current state of the zone.
    id str
    The provider-assigned unique ID for this managed resource.
    pending bool
    Indicates if the zone has pending configuration changes that need to be applied.
    state str
    Indicates the current state of the zone.
    id String
    The provider-assigned unique ID for this managed resource.
    pending Boolean
    Indicates if the zone has pending configuration changes that need to be applied.
    state String
    Indicates the current state of the zone.

    Look up Existing VxlanLegacy Resource

    Get an existing VxlanLegacy 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?: VxlanLegacyState, opts?: CustomResourceOptions): VxlanLegacy
    @staticmethod
def get(resource_name: str,
        id: str,
        opts: Optional[ResourceOptions] = None,
        dns: Optional[str] = None,
        dns_zone: Optional[str] = None,
        ipam: Optional[str] = None,
        mtu: Optional[int] = None,
        nodes: Optional[Sequence[str]] = None,
        peers: Optional[Sequence[str]] = None,
        pending: Optional[bool] = None,
        resource_id: Optional[str] = None,
        reverse_dns: Optional[str] = None,
        state: Optional[str] = None) -> VxlanLegacy
    func GetVxlanLegacy(ctx *Context, name string, id IDInput, state *VxlanLegacyState, opts ...ResourceOption) (*VxlanLegacy, error)
    public static VxlanLegacy Get(string name, Input<string> id, VxlanLegacyState? state, CustomResourceOptions? opts = null)
    public static VxlanLegacy get(String name, Output<String> id, VxlanLegacyState state, CustomResourceOptions options)
    resources:  _:    type: proxmoxve:sdn/zone/vxlanLegacy:VxlanLegacy    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:
    Dns string
    DNS API server address.
    DnsZone string
    DNS domain name. Used to register hostnames, such as <hostname>.<domain>. The DNS zone must already exist on the DNS server.
    Ipam string
    IP Address Management system.
    Mtu int
    MTU value for the zone. There is no support to reset this value back to PVE default once set due to API limitation.
    Nodes List<string>
    The Proxmox nodes which the zone and associated VNets should be deployed on
    Peers List<string>
    A list of IP addresses of each node in the VXLAN zone. This can be external nodes reachable at this IP address. All nodes in the cluster need to be mentioned here
    Pending bool
    Indicates if the zone has pending configuration changes that need to be applied.
    ResourceId string
    The unique identifier of the SDN zone.
    ReverseDns string
    Reverse DNS API server address.
    State string
    Indicates the current state of the zone.
    Dns string
    DNS API server address.
    DnsZone string
    DNS domain name. Used to register hostnames, such as <hostname>.<domain>. The DNS zone must already exist on the DNS server.
    Ipam string
    IP Address Management system.
    Mtu int
    MTU value for the zone. There is no support to reset this value back to PVE default once set due to API limitation.
    Nodes []string
    The Proxmox nodes which the zone and associated VNets should be deployed on
    Peers []string
    A list of IP addresses of each node in the VXLAN zone. This can be external nodes reachable at this IP address. All nodes in the cluster need to be mentioned here
    Pending bool
    Indicates if the zone has pending configuration changes that need to be applied.
    ResourceId string
    The unique identifier of the SDN zone.
    ReverseDns string
    Reverse DNS API server address.
    State string
    Indicates the current state of the zone.
    dns String
    DNS API server address.
    dnsZone String
    DNS domain name. Used to register hostnames, such as <hostname>.<domain>. The DNS zone must already exist on the DNS server.
    ipam String
    IP Address Management system.
    mtu Integer
    MTU value for the zone. There is no support to reset this value back to PVE default once set due to API limitation.
    nodes List<String>
    The Proxmox nodes which the zone and associated VNets should be deployed on
    peers List<String>
    A list of IP addresses of each node in the VXLAN zone. This can be external nodes reachable at this IP address. All nodes in the cluster need to be mentioned here
    pending Boolean
    Indicates if the zone has pending configuration changes that need to be applied.
    resourceId String
    The unique identifier of the SDN zone.
    reverseDns String
    Reverse DNS API server address.
    state String
    Indicates the current state of the zone.
    dns string
    DNS API server address.
    dnsZone string
    DNS domain name. Used to register hostnames, such as <hostname>.<domain>. The DNS zone must already exist on the DNS server.
    ipam string
    IP Address Management system.
    mtu number
    MTU value for the zone. There is no support to reset this value back to PVE default once set due to API limitation.
    nodes string[]
    The Proxmox nodes which the zone and associated VNets should be deployed on
    peers string[]
    A list of IP addresses of each node in the VXLAN zone. This can be external nodes reachable at this IP address. All nodes in the cluster need to be mentioned here
    pending boolean
    Indicates if the zone has pending configuration changes that need to be applied.
    resourceId string
    The unique identifier of the SDN zone.
    reverseDns string
    Reverse DNS API server address.
    state string
    Indicates the current state of the zone.
    dns str
    DNS API server address.
    dns_zone str
    DNS domain name. Used to register hostnames, such as <hostname>.<domain>. The DNS zone must already exist on the DNS server.
    ipam str
    IP Address Management system.
    mtu int
    MTU value for the zone. There is no support to reset this value back to PVE default once set due to API limitation.
    nodes Sequence[str]
    The Proxmox nodes which the zone and associated VNets should be deployed on
    peers Sequence[str]
    A list of IP addresses of each node in the VXLAN zone. This can be external nodes reachable at this IP address. All nodes in the cluster need to be mentioned here
    pending bool
    Indicates if the zone has pending configuration changes that need to be applied.
    resource_id str
    The unique identifier of the SDN zone.
    reverse_dns str
    Reverse DNS API server address.
    state str
    Indicates the current state of the zone.
    dns String
    DNS API server address.
    dnsZone String
    DNS domain name. Used to register hostnames, such as <hostname>.<domain>. The DNS zone must already exist on the DNS server.
    ipam String
    IP Address Management system.
    mtu Number
    MTU value for the zone. There is no support to reset this value back to PVE default once set due to API limitation.
    nodes List<String>
    The Proxmox nodes which the zone and associated VNets should be deployed on
    peers List<String>
    A list of IP addresses of each node in the VXLAN zone. This can be external nodes reachable at this IP address. All nodes in the cluster need to be mentioned here
    pending Boolean
    Indicates if the zone has pending configuration changes that need to be applied.
    resourceId String
    The unique identifier of the SDN zone.
    reverseDns String
    Reverse DNS API server address.
    state String
    Indicates the current state of the zone.

    Import

    !/usr/bin/env sh VXLAN SDN zone can be imported using its unique identifier (zone ID)

    $ pulumi import proxmoxve:sdn/zone/vxlanLegacy:VxlanLegacy example vxlan1

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

    Package Details

    Repository
    proxmoxve muhlba91/pulumi-proxmoxve
    License
    Apache-2.0
    Notes
    This Pulumi package is based on the proxmox Terraform Provider.
    proxmoxve logo
    Viewing docs for Proxmox Virtual Environment (Proxmox VE) v8.0.0
    published on Sunday, Apr 5, 2026 by Daniel Muehlbachler-Pietrzykowski
    Schema (JSON)
    muhlba91/pulumi-proxmoxve
      Try Pulumi Cloud free. Your team will thank you.