Docs Home Pulumi IaC Pulumi ESC Pulumi Insights Pulumi IDP Pulumi Cloud Packages Tutorials
  1. Packages
  2. Proxmox Virtual Environment (Proxmox VE)
  3. API Docs
  4. SDNZone
  5. Vxlan
Proxmox Virtual Environment (Proxmox VE) v7.4.0 published on Sunday, Aug 17, 2025 by Daniel Muehlbachler-Pietrzykowski
muhlba91/pulumi-proxmoxve

proxmoxve.SDNZone.Vxlan

Explore with Pulumi AI

proxmoxve logo
Proxmox Virtual Environment (Proxmox VE) v7.4.0 published on Sunday, Aug 17, 2025 by Daniel Muehlbachler-Pietrzykowski
muhlba91/pulumi-proxmoxve

    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.sdnzone.Vxlan("example", {
    dns: "1.1.1.1",
    dnsZone: "example.com",
    zoneId: "vxlan1",
    ipam: "pve",
    mtu: 1450,
    nodes: ["pve"],
    peers: [
        "10.0.0.1",
        "10.0.0.2",
        "10.0.0.3",
    ],
    reverseDns: "1.1.1.1",
});

    import pulumi
import pulumi_proxmoxve as proxmoxve

example = proxmoxve.sdnzone.Vxlan("example",
    dns="1.1.1.1",
    dns_zone="example.com",
    zone_id="vxlan1",
    ipam="pve",
    mtu=1450,
    nodes=["pve"],
    peers=[
        "10.0.0.1",
        "10.0.0.2",
        "10.0.0.3",
    ],
    reverse_dns="1.1.1.1")

    package main

import (
	"github.com/muhlba91/pulumi-proxmoxve/sdk/v7/go/proxmoxve/sdnzone"
	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
)

func main() {
	pulumi.Run(func(ctx *pulumi.Context) error {
		_, err := sdnzone.NewVxlan(ctx, "example", &sdnzone.VxlanArgs{
			Dns:     pulumi.String("1.1.1.1"),
			DnsZone: pulumi.String("example.com"),
			ZoneId:  pulumi.String("vxlan1"),
			Ipam:    pulumi.String("pve"),
			Mtu:     pulumi.Int(1450),
			Nodes: pulumi.StringArray{
				pulumi.String("pve"),
			},
			Peers: pulumi.StringArray{
				pulumi.String("10.0.0.1"),
				pulumi.String("10.0.0.2"),
				pulumi.String("10.0.0.3"),
			},
			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.SDNZone.Vxlan("example", new()
    {
        Dns = "1.1.1.1",
        DnsZone = "example.com",
        ZoneId = "vxlan1",
        Ipam = "pve",
        Mtu = 1450,
        Nodes = new[]
        {
            "pve",
        },
        Peers = new[]
        {
            "10.0.0.1",
            "10.0.0.2",
            "10.0.0.3",
        },
        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.SDNZone.Vxlan;
import io.muehlbachler.pulumi.proxmoxve.SDNZone.VxlanArgs;
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 Vxlan("example", VxlanArgs.builder()
            .dns("1.1.1.1")
            .dnsZone("example.com")
            .zoneId("vxlan1")
            .ipam("pve")
            .mtu(1450)
            .nodes("pve")
            .peers(            
                "10.0.0.1",
                "10.0.0.2",
                "10.0.0.3")
            .reverseDns("1.1.1.1")
            .build());

    }
}

    resources:
  example:
    type: proxmoxve:SDNZone:Vxlan
    properties:
      # Optional attributes
      dns: 1.1.1.1
      dnsZone: example.com
      zoneId: vxlan1
      ipam: pve
      mtu: 1450
      nodes:
        - pve
      peers:
        - 10.0.0.1
        - 10.0.0.2
        - 10.0.0.3
      reverseDns: 1.1.1.1

    Create Vxlan Resource

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

    Constructor syntax

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

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

    type: proxmoxve:SDNZone:Vxlan
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 VxlanArgs
    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 VxlanArgs
    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 VxlanArgs
    The arguments to resource properties.
    opts ResourceOption
    Bag of options to control resource's behavior.
    name string
    The unique name of the resource.
    args VxlanArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    name String
    The unique name of the resource.
    args VxlanArgs
    The arguments to resource properties.
    options CustomResourceOptions
    Bag of options to control resource's behavior.

    Constructor example

    The following reference example uses placeholder values for all input properties.

    var vxlanResource = new ProxmoxVE.SDNZone.Vxlan("vxlanResource", new()
{
    Nodes = new[]
    {
        "string",
    },
    Peers = new[]
    {
        "string",
    },
    ZoneId = "string",
    Dns = "string",
    DnsZone = "string",
    Ipam = "string",
    Mtu = 0,
    ReverseDns = "string",
});

    example, err := sdnzone.NewVxlan(ctx, "vxlanResource", &sdnzone.VxlanArgs{
	Nodes: pulumi.StringArray{
		pulumi.String("string"),
	},
	Peers: pulumi.StringArray{
		pulumi.String("string"),
	},
	ZoneId:     pulumi.String("string"),
	Dns:        pulumi.String("string"),
	DnsZone:    pulumi.String("string"),
	Ipam:       pulumi.String("string"),
	Mtu:        pulumi.Int(0),
	ReverseDns: pulumi.String("string"),
})

    var vxlanResource = new Vxlan("vxlanResource", VxlanArgs.builder()
    .nodes("string")
    .peers("string")
    .zoneId("string")
    .dns("string")
    .dnsZone("string")
    .ipam("string")
    .mtu(0)
    .reverseDns("string")
    .build());

    vxlan_resource = proxmoxve.sdnzone.Vxlan("vxlanResource",
    nodes=["string"],
    peers=["string"],
    zone_id="string",
    dns="string",
    dns_zone="string",
    ipam="string",
    mtu=0,
    reverse_dns="string")

    const vxlanResource = new proxmoxve.sdnzone.Vxlan("vxlanResource", {
    nodes: ["string"],
    peers: ["string"],
    zoneId: "string",
    dns: "string",
    dnsZone: "string",
    ipam: "string",
    mtu: 0,
    reverseDns: "string",
});

    type: proxmoxve:SDNZone:Vxlan
properties:
    dns: string
    dnsZone: string
    ipam: string
    mtu: 0
    nodes:
        - string
    peers:
        - string
    reverseDns: string
    zoneId: string

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

    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
    ZoneId 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.
    ReverseDns string
    Reverse DNS API server address.
    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
    ZoneId 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.
    ReverseDns string
    Reverse DNS API server address.
    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
    zoneId 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.
    reverseDns String
    Reverse DNS API server address.
    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
    zoneId 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.
    reverseDns string
    Reverse DNS API server address.
    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
    zone_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.
    reverse_dns str
    Reverse DNS API server address.
    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
    zoneId 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.
    reverseDns String
    Reverse DNS API server address.

    Outputs

    All input properties are implicitly available as output properties. Additionally, the Vxlan 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 Vxlan Resource

    Get an existing Vxlan 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?: VxlanState, opts?: CustomResourceOptions): Vxlan
    @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,
        reverse_dns: Optional[str] = None,
        zone_id: Optional[str] = None) -> Vxlan
    func GetVxlan(ctx *Context, name string, id IDInput, state *VxlanState, opts ...ResourceOption) (*Vxlan, error)
    public static Vxlan Get(string name, Input<string> id, VxlanState? state, CustomResourceOptions? opts = null)
    public static Vxlan get(String name, Output<String> id, VxlanState state, CustomResourceOptions options)
    resources:  _:    type: proxmoxve:SDNZone:Vxlan    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.
    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
    ReverseDns string
    Reverse DNS API server address.
    ZoneId 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.
    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
    ReverseDns string
    Reverse DNS API server address.
    ZoneId 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.
    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
    reverseDns String
    Reverse DNS API server address.
    zoneId 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.
    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
    reverseDns string
    Reverse DNS API server address.
    zoneId string
    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.
    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
    reverse_dns str
    Reverse DNS API server address.
    zone_id str
    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.
    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
    reverseDns String
    Reverse DNS API server address.
    zoneId String
    The unique identifier of the SDN zone.

    Import

    #!/usr/bin/env sh

    VXLAN SDN zone can be imported using its unique identifier (zone ID)

    $ pulumi import proxmoxve:SDNZone/vxlan:Vxlan 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
    Proxmox Virtual Environment (Proxmox VE) v7.4.0 published on Sunday, Aug 17, 2025 by Daniel Muehlbachler-Pietrzykowski
    muhlba91/pulumi-proxmoxve