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

    Manages a Linux VLAN network interface in a Proxmox VE node.

    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,
         node_name: Optional[str] = None,
         address: Optional[str] = None,
         address6: Optional[str] = None,
         autostart: Optional[bool] = None,
         comment: Optional[str] = None,
         gateway: Optional[str] = None,
         gateway6: Optional[str] = None,
         interface: Optional[str] = None,
         mtu: Optional[int] = None,
         name: Optional[str] = None,
         timeout_reload: Optional[int] = None,
         vlan: Optional[int] = 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:network/linux/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:

    NodeName string
    The name of the node.
    Address string
    The interface IPv4/CIDR address.
    Address6 string
    The interface IPv6/CIDR address.
    Autostart bool
    Automatically start interface on boot (defaults to true).
    Comment string
    Comment for the interface.
    Gateway string
    Default gateway address.
    Gateway6 string
    Default IPv6 gateway address.
    Interface string
    The VLAN raw device. See also name.
    Mtu int
    The interface MTU.
    Name string
    The interface name. Either add the VLAN tag number to an existing interface name, e.g. ens18.21 (and do not set interface and vlan), or use custom name, e.g. vlanLab (interface and vlan are then required).
    TimeoutReload int
    Timeout for network reload operations in seconds (defaults to 100).
    vlanId int
    The VLAN tag. See also name.
    NodeName string
    The name of the node.
    Address string
    The interface IPv4/CIDR address.
    Address6 string
    The interface IPv6/CIDR address.
    Autostart bool
    Automatically start interface on boot (defaults to true).
    Comment string
    Comment for the interface.
    Gateway string
    Default gateway address.
    Gateway6 string
    Default IPv6 gateway address.
    Interface string
    The VLAN raw device. See also name.
    Mtu int
    The interface MTU.
    Name string
    The interface name. Either add the VLAN tag number to an existing interface name, e.g. ens18.21 (and do not set interface and vlan), or use custom name, e.g. vlanLab (interface and vlan are then required).
    TimeoutReload int
    Timeout for network reload operations in seconds (defaults to 100).
    Vlan int
    The VLAN tag. See also name.
    nodeName String
    The name of the node.
    address String
    The interface IPv4/CIDR address.
    address6 String
    The interface IPv6/CIDR address.
    autostart Boolean
    Automatically start interface on boot (defaults to true).
    comment String
    Comment for the interface.
    gateway String
    Default gateway address.
    gateway6 String
    Default IPv6 gateway address.
    interface_ String
    The VLAN raw device. See also name.
    mtu Integer
    The interface MTU.
    name String
    The interface name. Either add the VLAN tag number to an existing interface name, e.g. ens18.21 (and do not set interface and vlan), or use custom name, e.g. vlanLab (interface and vlan are then required).
    timeoutReload Integer
    Timeout for network reload operations in seconds (defaults to 100).
    vlan Integer
    The VLAN tag. See also name.
    nodeName string
    The name of the node.
    address string
    The interface IPv4/CIDR address.
    address6 string
    The interface IPv6/CIDR address.
    autostart boolean
    Automatically start interface on boot (defaults to true).
    comment string
    Comment for the interface.
    gateway string
    Default gateway address.
    gateway6 string
    Default IPv6 gateway address.
    interface string
    The VLAN raw device. See also name.
    mtu number
    The interface MTU.
    name string
    The interface name. Either add the VLAN tag number to an existing interface name, e.g. ens18.21 (and do not set interface and vlan), or use custom name, e.g. vlanLab (interface and vlan are then required).
    timeoutReload number
    Timeout for network reload operations in seconds (defaults to 100).
    vlan number
    The VLAN tag. See also name.
    node_name str
    The name of the node.
    address str
    The interface IPv4/CIDR address.
    address6 str
    The interface IPv6/CIDR address.
    autostart bool
    Automatically start interface on boot (defaults to true).
    comment str
    Comment for the interface.
    gateway str
    Default gateway address.
    gateway6 str
    Default IPv6 gateway address.
    interface str
    The VLAN raw device. See also name.
    mtu int
    The interface MTU.
    name str
    The interface name. Either add the VLAN tag number to an existing interface name, e.g. ens18.21 (and do not set interface and vlan), or use custom name, e.g. vlanLab (interface and vlan are then required).
    timeout_reload int
    Timeout for network reload operations in seconds (defaults to 100).
    vlan int
    The VLAN tag. See also name.
    nodeName String
    The name of the node.
    address String
    The interface IPv4/CIDR address.
    address6 String
    The interface IPv6/CIDR address.
    autostart Boolean
    Automatically start interface on boot (defaults to true).
    comment String
    Comment for the interface.
    gateway String
    Default gateway address.
    gateway6 String
    Default IPv6 gateway address.
    interface String
    The VLAN raw device. See also name.
    mtu Number
    The interface MTU.
    name String
    The interface name. Either add the VLAN tag number to an existing interface name, e.g. ens18.21 (and do not set interface and vlan), or use custom name, e.g. vlanLab (interface and vlan are then required).
    timeoutReload Number
    Timeout for network reload operations in seconds (defaults to 100).
    vlan Number
    The VLAN tag. See also name.

    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.
    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 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,
        address: Optional[str] = None,
        address6: Optional[str] = None,
        autostart: Optional[bool] = None,
        comment: Optional[str] = None,
        gateway: Optional[str] = None,
        gateway6: Optional[str] = None,
        interface: Optional[str] = None,
        mtu: Optional[int] = None,
        name: Optional[str] = None,
        node_name: Optional[str] = None,
        timeout_reload: Optional[int] = None,
        vlan: Optional[int] = 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:network/linux/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:
    Address string
    The interface IPv4/CIDR address.
    Address6 string
    The interface IPv6/CIDR address.
    Autostart bool
    Automatically start interface on boot (defaults to true).
    Comment string
    Comment for the interface.
    Gateway string
    Default gateway address.
    Gateway6 string
    Default IPv6 gateway address.
    Interface string
    The VLAN raw device. See also name.
    Mtu int
    The interface MTU.
    Name string
    The interface name. Either add the VLAN tag number to an existing interface name, e.g. ens18.21 (and do not set interface and vlan), or use custom name, e.g. vlanLab (interface and vlan are then required).
    NodeName string
    The name of the node.
    TimeoutReload int
    Timeout for network reload operations in seconds (defaults to 100).
    vlanId int
    The VLAN tag. See also name.
    Address string
    The interface IPv4/CIDR address.
    Address6 string
    The interface IPv6/CIDR address.
    Autostart bool
    Automatically start interface on boot (defaults to true).
    Comment string
    Comment for the interface.
    Gateway string
    Default gateway address.
    Gateway6 string
    Default IPv6 gateway address.
    Interface string
    The VLAN raw device. See also name.
    Mtu int
    The interface MTU.
    Name string
    The interface name. Either add the VLAN tag number to an existing interface name, e.g. ens18.21 (and do not set interface and vlan), or use custom name, e.g. vlanLab (interface and vlan are then required).
    NodeName string
    The name of the node.
    TimeoutReload int
    Timeout for network reload operations in seconds (defaults to 100).
    Vlan int
    The VLAN tag. See also name.
    address String
    The interface IPv4/CIDR address.
    address6 String
    The interface IPv6/CIDR address.
    autostart Boolean
    Automatically start interface on boot (defaults to true).
    comment String
    Comment for the interface.
    gateway String
    Default gateway address.
    gateway6 String
    Default IPv6 gateway address.
    interface_ String
    The VLAN raw device. See also name.
    mtu Integer
    The interface MTU.
    name String
    The interface name. Either add the VLAN tag number to an existing interface name, e.g. ens18.21 (and do not set interface and vlan), or use custom name, e.g. vlanLab (interface and vlan are then required).
    nodeName String
    The name of the node.
    timeoutReload Integer
    Timeout for network reload operations in seconds (defaults to 100).
    vlan Integer
    The VLAN tag. See also name.
    address string
    The interface IPv4/CIDR address.
    address6 string
    The interface IPv6/CIDR address.
    autostart boolean
    Automatically start interface on boot (defaults to true).
    comment string
    Comment for the interface.
    gateway string
    Default gateway address.
    gateway6 string
    Default IPv6 gateway address.
    interface string
    The VLAN raw device. See also name.
    mtu number
    The interface MTU.
    name string
    The interface name. Either add the VLAN tag number to an existing interface name, e.g. ens18.21 (and do not set interface and vlan), or use custom name, e.g. vlanLab (interface and vlan are then required).
    nodeName string
    The name of the node.
    timeoutReload number
    Timeout for network reload operations in seconds (defaults to 100).
    vlan number
    The VLAN tag. See also name.
    address str
    The interface IPv4/CIDR address.
    address6 str
    The interface IPv6/CIDR address.
    autostart bool
    Automatically start interface on boot (defaults to true).
    comment str
    Comment for the interface.
    gateway str
    Default gateway address.
    gateway6 str
    Default IPv6 gateway address.
    interface str
    The VLAN raw device. See also name.
    mtu int
    The interface MTU.
    name str
    The interface name. Either add the VLAN tag number to an existing interface name, e.g. ens18.21 (and do not set interface and vlan), or use custom name, e.g. vlanLab (interface and vlan are then required).
    node_name str
    The name of the node.
    timeout_reload int
    Timeout for network reload operations in seconds (defaults to 100).
    vlan int
    The VLAN tag. See also name.
    address String
    The interface IPv4/CIDR address.
    address6 String
    The interface IPv6/CIDR address.
    autostart Boolean
    Automatically start interface on boot (defaults to true).
    comment String
    Comment for the interface.
    gateway String
    Default gateway address.
    gateway6 String
    Default IPv6 gateway address.
    interface String
    The VLAN raw device. See also name.
    mtu Number
    The interface MTU.
    name String
    The interface name. Either add the VLAN tag number to an existing interface name, e.g. ens18.21 (and do not set interface and vlan), or use custom name, e.g. vlanLab (interface and vlan are then required).
    nodeName String
    The name of the node.
    timeoutReload Number
    Timeout for network reload operations in seconds (defaults to 100).
    vlan Number
    The VLAN tag. See also name.

    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.