Proxmox Virtual Environment (Proxmox VE) v7.4.0 published on Sunday, Aug 17, 2025 by Daniel Muehlbachler-Pietrzykowski
proxmoxve.SDNZone.getVlan
Explore with Pulumi AI

Proxmox Virtual Environment (Proxmox VE) v7.4.0 published on Sunday, Aug 17, 2025 by Daniel Muehlbachler-Pietrzykowski
Retrieves information about a VLAN Zone in Proxmox SDN. It uses an existing local Linux or OVS bridge to connect to the node’s physical interface. It uses VLAN tagging defined in the VNet to isolate the network segments. This allows connectivity of VMs between different nodes.
Example Usage
import * as pulumi from "@pulumi/pulumi";
import * as proxmoxve from "@muhlba91/pulumi-proxmoxve";
const example = proxmoxve.SDNZone.getVlan({
id: "vlan1",
});
export const dataProxmoxVirtualEnvironmentSdnZoneVlan = {
id: example.then(example => example.id),
nodes: example.then(example => example.nodes),
bridge: example.then(example => example.bridge),
mtu: example.then(example => example.mtu),
dns: example.then(example => example.dns),
dns_zone: example.then(example => example.dnsZone),
ipam: example.then(example => example.ipam),
reverse_dns: example.then(example => example.reverseDns),
};
import pulumi
import pulumi_proxmoxve as proxmoxve
example = proxmoxve.SDNZone.get_vlan(id="vlan1")
pulumi.export("dataProxmoxVirtualEnvironmentSdnZoneVlan", {
"id": example.id,
"nodes": example.nodes,
"bridge": example.bridge,
"mtu": example.mtu,
"dns": example.dns,
"dns_zone": example.dns_zone,
"ipam": example.ipam,
"reverse_dns": example.reverse_dns,
})
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 {
example, err := sdnzone.GetVlan(ctx, &sdnzone.GetVlanArgs{
Id: "vlan1",
}, nil)
if err != nil {
return err
}
ctx.Export("dataProxmoxVirtualEnvironmentSdnZoneVlan", pulumi.Map{
"id": example.Id,
"nodes": example.Nodes,
"bridge": example.Bridge,
"mtu": example.Mtu,
"dns": example.Dns,
"dns_zone": example.DnsZone,
"ipam": example.Ipam,
"reverse_dns": example.ReverseDns,
})
return nil
})
}
using System.Collections.Generic;
using System.Linq;
using Pulumi;
using ProxmoxVE = Pulumi.ProxmoxVE;
return await Deployment.RunAsync(() =>
{
var example = ProxmoxVE.SDNZone.GetVlan.Invoke(new()
{
Id = "vlan1",
});
return new Dictionary<string, object?>
{
["dataProxmoxVirtualEnvironmentSdnZoneVlan"] =
{
{ "id", example.Apply(getVlanResult => getVlanResult.Id) },
{ "nodes", example.Apply(getVlanResult => getVlanResult.Nodes) },
{ "bridge", example.Apply(getVlanResult => getVlanResult.Bridge) },
{ "mtu", example.Apply(getVlanResult => getVlanResult.Mtu) },
{ "dns", example.Apply(getVlanResult => getVlanResult.Dns) },
{ "dns_zone", example.Apply(getVlanResult => getVlanResult.DnsZone) },
{ "ipam", example.Apply(getVlanResult => getVlanResult.Ipam) },
{ "reverse_dns", example.Apply(getVlanResult => getVlanResult.ReverseDns) },
},
};
});
package generated_program;
import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.proxmoxve.SDNZone.SDNZoneFunctions;
import com.pulumi.proxmoxve.SDNZone.inputs.GetVlanArgs;
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) {
final var example = SDNZoneFunctions.getVlan(GetVlanArgs.builder()
.id("vlan1")
.build());
ctx.export("dataProxmoxVirtualEnvironmentSdnZoneVlan", Map.ofEntries(
Map.entry("id", example.id()),
Map.entry("nodes", example.nodes()),
Map.entry("bridge", example.bridge()),
Map.entry("mtu", example.mtu()),
Map.entry("dns", example.dns()),
Map.entry("dns_zone", example.dnsZone()),
Map.entry("ipam", example.ipam()),
Map.entry("reverse_dns", example.reverseDns())
));
}
}
variables:
example:
fn::invoke:
function: proxmoxve:SDNZone:getVlan
arguments:
id: vlan1
outputs:
dataProxmoxVirtualEnvironmentSdnZoneVlan:
id: ${example.id}
nodes: ${example.nodes}
bridge: ${example.bridge}
mtu: ${example.mtu}
dns: ${example.dns}
dns_zone: ${example.dnsZone}
ipam: ${example.ipam}
reverse_dns: ${example.reverseDns}
Using getVlan
Two invocation forms are available. The direct form accepts plain arguments and either blocks until the result value is available, or returns a Promise-wrapped result. The output form accepts Input-wrapped arguments and returns an Output-wrapped result.
function getVlan(args: GetVlanArgs, opts?: InvokeOptions): Promise<GetVlanResult>
function getVlanOutput(args: GetVlanOutputArgs, opts?: InvokeOptions): Output<GetVlanResult>
def get_vlan(id: Optional[str] = None,
opts: Optional[InvokeOptions] = None) -> GetVlanResult
def get_vlan_output(id: Optional[pulumi.Input[str]] = None,
opts: Optional[InvokeOptions] = None) -> Output[GetVlanResult]
func LookupVlan(ctx *Context, args *LookupVlanArgs, opts ...InvokeOption) (*LookupVlanResult, error)
func LookupVlanOutput(ctx *Context, args *LookupVlanOutputArgs, opts ...InvokeOption) LookupVlanResultOutput
> Note: This function is named LookupVlan
in the Go SDK.
public static class GetVlan
{
public static Task<GetVlanResult> InvokeAsync(GetVlanArgs args, InvokeOptions? opts = null)
public static Output<GetVlanResult> Invoke(GetVlanInvokeArgs args, InvokeOptions? opts = null)
}
public static CompletableFuture<GetVlanResult> getVlan(GetVlanArgs args, InvokeOptions options)
public static Output<GetVlanResult> getVlan(GetVlanArgs args, InvokeOptions options)
fn::invoke:
function: proxmoxve:SDNZone/getVlan:getVlan
arguments:
# arguments dictionary
The following arguments are supported:
- Id string
- The unique identifier of the SDN zone.
- Id string
- The unique identifier of the SDN zone.
- id String
- The unique identifier of the SDN zone.
- id string
- The unique identifier of the SDN zone.
- id str
- The unique identifier of the SDN zone.
- id String
- The unique identifier of the SDN zone.
getVlan Result
The following output properties are available:
- Bridge string
- The local bridge or OVS switch, already configured on each node that allows node-to-node connection.
- 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. - Id string
- The unique identifier of the SDN zone.
- 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 are deployed on
- Reverse
Dns string - Reverse DNS API server address.
- Bridge string
- The local bridge or OVS switch, already configured on each node that allows node-to-node connection.
- 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. - Id string
- The unique identifier of the SDN zone.
- Ipam string
- IP Address Management system.
- Mtu int
- MTU value for the zone.
- Nodes []string
- The Proxmox nodes which the zone and associated VNets are deployed on
- Reverse
Dns string - Reverse DNS API server address.
- bridge String
- The local bridge or OVS switch, already configured on each node that allows node-to-node connection.
- 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. - id String
- The unique identifier of the SDN zone.
- 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 are deployed on
- reverse
Dns String - Reverse DNS API server address.
- bridge string
- The local bridge or OVS switch, already configured on each node that allows node-to-node connection.
- 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. - id string
- The unique identifier of the SDN zone.
- ipam string
- IP Address Management system.
- mtu number
- MTU value for the zone.
- nodes string[]
- The Proxmox nodes which the zone and associated VNets are deployed on
- reverse
Dns string - Reverse DNS API server address.
- bridge str
- The local bridge or OVS switch, already configured on each node that allows node-to-node connection.
- 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. - id str
- The unique identifier of the SDN zone.
- 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 are deployed on
- reverse_
dns str - Reverse DNS API server address.
- bridge String
- The local bridge or OVS switch, already configured on each node that allows node-to-node connection.
- 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. - id String
- The unique identifier of the SDN zone.
- 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 are deployed on
- reverse
Dns String - Reverse DNS API server address.
Package Details
- Repository
- proxmoxve muhlba91/pulumi-proxmoxve
- License
- Apache-2.0
- Notes
- This Pulumi package is based on the
proxmox
Terraform Provider.

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