0
0
mirror of https://github.com/bpg/terraform-provider-proxmox.git synced 2025-08-22 19:38:35 +00:00
terraform-provider-proxmox/docs/resources/virtual_environment_sdn_zone_vxlan.md
Pavel Boldyrev 6b73d822a5
feat(sdn): add support for zone resources and datasources (#2046)
Signed-off-by: Pavel Boldyrev <627562+bpg@users.noreply.github.com>
2025-07-31 20:30:18 -04:00

2.3 KiB

layout title parent subcategory description
page proxmox_virtual_environment_sdn_zone_vxlan Resources Virtual Environment 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.

Resource: proxmox_virtual_environment_sdn_zone_vxlan

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

resource "proxmox_virtual_environment_sdn_zone_vxlan" "example" {
  id    = "vxlan1"
  nodes = ["pve"]
  peers = ["10.0.0.1", "10.0.0.2", "10.0.0.3"]
  mtu   = 1450

  # Optional attributes
  dns         = "1.1.1.1"
  dns_zone    = "example.com"
  ipam        = "pve"
  reverse_dns = "1.1.1.1"
}

Schema

Required

  • id (String) The unique identifier of the SDN zone.
  • nodes (Set of String) The Proxmox nodes which the zone and associated VNets should be deployed on
  • peers (Set of 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

Optional

  • dns (String) DNS API server address.
  • dns_zone (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.
  • reverse_dns (String) Reverse DNS API server address.

Import

Import is supported using the following syntax:

#!/usr/bin/env sh
# VXLAN SDN zone can be imported using its unique identifier (zone ID)
terraform import proxmox_virtual_environment_sdn_zone_vxlan.example vxlan1