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

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 Proxmox VE SDN VNet.

    Create Vnet Resource

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

    Constructor syntax

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

@overload
def Vnet(resource_name: str,
         opts: Optional[ResourceOptions] = None,
         resource_id: Optional[str] = None,
         zone: Optional[str] = None,
         alias: Optional[str] = None,
         isolate_ports: Optional[bool] = None,
         tag: Optional[int] = None,
         vlan_aware: Optional[bool] = None)
    func NewVnet(ctx *Context, name string, args VnetArgs, opts ...ResourceOption) (*Vnet, error)
    public Vnet(string name, VnetArgs args, CustomResourceOptions? opts = null)
    public Vnet(String name, VnetArgs args)
public Vnet(String name, VnetArgs args, CustomResourceOptions options)

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

    Constructor example

    The following reference example uses placeholder values for all input properties.

    var vnetResource = new ProxmoxVE.Sdn.Vnet("vnetResource", new()
{
    ResourceId = "string",
    Zone = "string",
    Alias = "string",
    IsolatePorts = false,
    Tag = 0,
    VlanAware = false,
});

    example, err := sdn.NewVnet(ctx, "vnetResource", &sdn.VnetArgs{
	ResourceId:   pulumi.String("string"),
	Zone:         pulumi.String("string"),
	Alias:        pulumi.String("string"),
	IsolatePorts: pulumi.Bool(false),
	Tag:          pulumi.Int(0),
	VlanAware:    pulumi.Bool(false),
})

    var vnetResource = new Vnet("vnetResource", VnetArgs.builder()
    .resourceId("string")
    .zone("string")
    .alias("string")
    .isolatePorts(false)
    .tag(0)
    .vlanAware(false)
    .build());

    vnet_resource = proxmoxve.sdn.Vnet("vnetResource",
    resource_id="string",
    zone="string",
    alias="string",
    isolate_ports=False,
    tag=0,
    vlan_aware=False)

    const vnetResource = new proxmoxve.sdn.Vnet("vnetResource", {
    resourceId: "string",
    zone: "string",
    alias: "string",
    isolatePorts: false,
    tag: 0,
    vlanAware: false,
});

    type: proxmoxve:sdn:Vnet
properties:
    alias: string
    isolatePorts: false
    resourceId: string
    tag: 0
    vlanAware: false
    zone: string

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

    ResourceId string
    The unique identifier of the SDN VNet.
    Zone string
    The zone to which this VNet belongs.
    Alias string
    An optional alias for this VNet.
    IsolatePorts bool
    Isolate ports within this VNet.
    Tag int
    Tag value for VLAN/VXLAN (can't be used with other zone types).
    VlanAware bool
    Allow VM VLANs to pass through this VNet.
    ResourceId string
    The unique identifier of the SDN VNet.
    Zone string
    The zone to which this VNet belongs.
    Alias string
    An optional alias for this VNet.
    IsolatePorts bool
    Isolate ports within this VNet.
    Tag int
    Tag value for VLAN/VXLAN (can't be used with other zone types).
    VlanAware bool
    Allow VM VLANs to pass through this VNet.
    resourceId String
    The unique identifier of the SDN VNet.
    zone String
    The zone to which this VNet belongs.
    alias String
    An optional alias for this VNet.
    isolatePorts Boolean
    Isolate ports within this VNet.
    tag Integer
    Tag value for VLAN/VXLAN (can't be used with other zone types).
    vlanAware Boolean
    Allow VM VLANs to pass through this VNet.
    resourceId string
    The unique identifier of the SDN VNet.
    zone string
    The zone to which this VNet belongs.
    alias string
    An optional alias for this VNet.
    isolatePorts boolean
    Isolate ports within this VNet.
    tag number
    Tag value for VLAN/VXLAN (can't be used with other zone types).
    vlanAware boolean
    Allow VM VLANs to pass through this VNet.
    resource_id str
    The unique identifier of the SDN VNet.
    zone str
    The zone to which this VNet belongs.
    alias str
    An optional alias for this VNet.
    isolate_ports bool
    Isolate ports within this VNet.
    tag int
    Tag value for VLAN/VXLAN (can't be used with other zone types).
    vlan_aware bool
    Allow VM VLANs to pass through this VNet.
    resourceId String
    The unique identifier of the SDN VNet.
    zone String
    The zone to which this VNet belongs.
    alias String
    An optional alias for this VNet.
    isolatePorts Boolean
    Isolate ports within this VNet.
    tag Number
    Tag value for VLAN/VXLAN (can't be used with other zone types).
    vlanAware Boolean
    Allow VM VLANs to pass through this VNet.

    Outputs

    All input properties are implicitly available as output properties. Additionally, the Vnet 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 Vnet Resource

    Get an existing Vnet 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?: VnetState, opts?: CustomResourceOptions): Vnet
    @staticmethod
def get(resource_name: str,
        id: str,
        opts: Optional[ResourceOptions] = None,
        alias: Optional[str] = None,
        isolate_ports: Optional[bool] = None,
        resource_id: Optional[str] = None,
        tag: Optional[int] = None,
        vlan_aware: Optional[bool] = None,
        zone: Optional[str] = None) -> Vnet
    func GetVnet(ctx *Context, name string, id IDInput, state *VnetState, opts ...ResourceOption) (*Vnet, error)
    public static Vnet Get(string name, Input<string> id, VnetState? state, CustomResourceOptions? opts = null)
    public static Vnet get(String name, Output<String> id, VnetState state, CustomResourceOptions options)
    resources:  _:    type: proxmoxve:sdn:Vnet    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:
    Alias string
    An optional alias for this VNet.
    IsolatePorts bool
    Isolate ports within this VNet.
    ResourceId string
    The unique identifier of the SDN VNet.
    Tag int
    Tag value for VLAN/VXLAN (can't be used with other zone types).
    VlanAware bool
    Allow VM VLANs to pass through this VNet.
    Zone string
    The zone to which this VNet belongs.
    Alias string
    An optional alias for this VNet.
    IsolatePorts bool
    Isolate ports within this VNet.
    ResourceId string
    The unique identifier of the SDN VNet.
    Tag int
    Tag value for VLAN/VXLAN (can't be used with other zone types).
    VlanAware bool
    Allow VM VLANs to pass through this VNet.
    Zone string
    The zone to which this VNet belongs.
    alias String
    An optional alias for this VNet.
    isolatePorts Boolean
    Isolate ports within this VNet.
    resourceId String
    The unique identifier of the SDN VNet.
    tag Integer
    Tag value for VLAN/VXLAN (can't be used with other zone types).
    vlanAware Boolean
    Allow VM VLANs to pass through this VNet.
    zone String
    The zone to which this VNet belongs.
    alias string
    An optional alias for this VNet.
    isolatePorts boolean
    Isolate ports within this VNet.
    resourceId string
    The unique identifier of the SDN VNet.
    tag number
    Tag value for VLAN/VXLAN (can't be used with other zone types).
    vlanAware boolean
    Allow VM VLANs to pass through this VNet.
    zone string
    The zone to which this VNet belongs.
    alias str
    An optional alias for this VNet.
    isolate_ports bool
    Isolate ports within this VNet.
    resource_id str
    The unique identifier of the SDN VNet.
    tag int
    Tag value for VLAN/VXLAN (can't be used with other zone types).
    vlan_aware bool
    Allow VM VLANs to pass through this VNet.
    zone str
    The zone to which this VNet belongs.
    alias String
    An optional alias for this VNet.
    isolatePorts Boolean
    Isolate ports within this VNet.
    resourceId String
    The unique identifier of the SDN VNet.
    tag Number
    Tag value for VLAN/VXLAN (can't be used with other zone types).
    vlanAware Boolean
    Allow VM VLANs to pass through this VNet.
    zone String
    The zone to which this VNet belongs.

    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.