1. Packages
  2. Proxmox Virtual Environment (Proxmox VE)
  3. API Docs
  4. sdn
  5. sdn/zone
  6. getVlan
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.getVlan

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

    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.

    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:sdn/zone/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.
    DnsZone 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
    Pending bool
    Indicates if the zone has pending configuration changes that need to be applied.
    ReverseDns string
    Reverse DNS API server address.
    State string
    Indicates the current state of the zone.
    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.
    DnsZone 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
    Pending bool
    Indicates if the zone has pending configuration changes that need to be applied.
    ReverseDns string
    Reverse DNS API server address.
    State string
    Indicates the current state of the zone.
    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.
    dnsZone 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
    pending Boolean
    Indicates if the zone has pending configuration changes that need to be applied.
    reverseDns String
    Reverse DNS API server address.
    state String
    Indicates the current state of the zone.
    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.
    dnsZone 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
    pending boolean
    Indicates if the zone has pending configuration changes that need to be applied.
    reverseDns string
    Reverse DNS API server address.
    state string
    Indicates the current state of the zone.
    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
    pending bool
    Indicates if the zone has pending configuration changes that need to be applied.
    reverse_dns str
    Reverse DNS API server address.
    state str
    Indicates the current state of the zone.
    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.
    dnsZone 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
    pending Boolean
    Indicates if the zone has pending configuration changes that need to be applied.
    reverseDns String
    Reverse DNS API server address.
    state String
    Indicates the current state of the zone.

    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.