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

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

    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.

    Create Vlan Resource

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

    Constructor syntax

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

@overload
def Vlan(resource_name: str,
         opts: Optional[ResourceOptions] = None,
         bridge: Optional[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 NewVlan(ctx *Context, name string, args VlanArgs, opts ...ResourceOption) (*Vlan, error)
    public Vlan(string name, VlanArgs args, CustomResourceOptions? opts = null)
    public Vlan(String name, VlanArgs args)
public Vlan(String name, VlanArgs args, CustomResourceOptions options)

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

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

    Bridge string
    The local bridge or OVS switch, already configured on each node that allows node-to-node connection.
    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.
    Bridge string
    The local bridge or OVS switch, already configured on each node that allows node-to-node connection.
    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.
    bridge String
    The local bridge or OVS switch, already configured on each node that allows node-to-node connection.
    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.
    bridge string
    The local bridge or OVS switch, already configured on each node that allows node-to-node connection.
    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.
    bridge str
    The local bridge or OVS switch, already configured on each node that allows node-to-node connection.
    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.
    bridge String
    The local bridge or OVS switch, already configured on each node that allows node-to-node connection.
    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 Vlan 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 Vlan Resource

    Get an existing Vlan 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?: VlanState, opts?: CustomResourceOptions): Vlan
    @staticmethod
def get(resource_name: str,
        id: str,
        opts: Optional[ResourceOptions] = None,
        bridge: 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,
        pending: Optional[bool] = None,
        resource_id: Optional[str] = None,
        reverse_dns: Optional[str] = None,
        state: Optional[str] = None) -> Vlan
    func GetVlan(ctx *Context, name string, id IDInput, state *VlanState, opts ...ResourceOption) (*Vlan, error)
    public static Vlan Get(string name, Input<string> id, VlanState? state, CustomResourceOptions? opts = null)
    public static Vlan get(String name, Output<String> id, VlanState state, CustomResourceOptions options)
    resources:  _:    type: proxmoxve:sdn/zone/vlan:Vlan    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:
    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.
    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
    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.
    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.
    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
    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.
    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.
    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
    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.
    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.
    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
    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.
    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.
    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
    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.
    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.
    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
    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.

    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.