1. Packages
  2. Proxmox Virtual Environment (Proxmox VE)
  3. API Docs
  4. SDNZone
  5. Simple
Proxmox Virtual Environment (Proxmox VE) v7.4.0 published on Sunday, Aug 17, 2025 by Daniel Muehlbachler-Pietrzykowski

proxmoxve.SDNZone.Simple

Explore with Pulumi AI

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

    Simple Zone in Proxmox SDN. It will create an isolated VNet bridge. This bridge is not linked to a physical interface, and VM traffic is only local on each the node. It can be used in NAT or routed setups.

    Example Usage

    import * as pulumi from "@pulumi/pulumi";
    import * as proxmoxve from "@muhlba91/pulumi-proxmoxve";
    
    const example = new proxmoxve.sdnzone.Simple("example", {
        dns: "1.1.1.1",
        dnsZone: "example.com",
        zoneId: "simple1",
        ipam: "pve",
        mtu: 1500,
        nodes: ["pve"],
        reverseDns: "1.1.1.1",
    });
    
    import pulumi
    import pulumi_proxmoxve as proxmoxve
    
    example = proxmoxve.sdnzone.Simple("example",
        dns="1.1.1.1",
        dns_zone="example.com",
        zone_id="simple1",
        ipam="pve",
        mtu=1500,
        nodes=["pve"],
        reverse_dns="1.1.1.1")
    
    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 {
    		_, err := sdnzone.NewSimple(ctx, "example", &sdnzone.SimpleArgs{
    			Dns:     pulumi.String("1.1.1.1"),
    			DnsZone: pulumi.String("example.com"),
    			ZoneId:  pulumi.String("simple1"),
    			Ipam:    pulumi.String("pve"),
    			Mtu:     pulumi.Int(1500),
    			Nodes: pulumi.StringArray{
    				pulumi.String("pve"),
    			},
    			ReverseDns: pulumi.String("1.1.1.1"),
    		})
    		if err != nil {
    			return err
    		}
    		return nil
    	})
    }
    
    using System.Collections.Generic;
    using System.Linq;
    using Pulumi;
    using ProxmoxVE = Pulumi.ProxmoxVE;
    
    return await Deployment.RunAsync(() => 
    {
        var example = new ProxmoxVE.SDNZone.Simple("example", new()
        {
            Dns = "1.1.1.1",
            DnsZone = "example.com",
            ZoneId = "simple1",
            Ipam = "pve",
            Mtu = 1500,
            Nodes = new[]
            {
                "pve",
            },
            ReverseDns = "1.1.1.1",
        });
    
    });
    
    package generated_program;
    
    import com.pulumi.Context;
    import com.pulumi.Pulumi;
    import com.pulumi.core.Output;
    import io.muehlbachler.pulumi.proxmoxve.SDNZone.Simple;
    import io.muehlbachler.pulumi.proxmoxve.SDNZone.SimpleArgs;
    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) {
            var example = new Simple("example", SimpleArgs.builder()
                .dns("1.1.1.1")
                .dnsZone("example.com")
                .zoneId("simple1")
                .ipam("pve")
                .mtu(1500)
                .nodes("pve")
                .reverseDns("1.1.1.1")
                .build());
    
        }
    }
    
    resources:
      example:
        type: proxmoxve:SDNZone:Simple
        properties:
          # Optional attributes
          dns: 1.1.1.1
          dnsZone: example.com
          zoneId: simple1
          ipam: pve
          mtu: 1500
          nodes:
            - pve
          reverseDns: 1.1.1.1
    

    Create Simple Resource

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

    Constructor syntax

    new Simple(name: string, args: SimpleArgs, opts?: CustomResourceOptions);
    @overload
    def Simple(resource_name: str,
               args: SimpleArgs,
               opts: Optional[ResourceOptions] = None)
    
    @overload
    def Simple(resource_name: str,
               opts: Optional[ResourceOptions] = None,
               nodes: Optional[Sequence[str]] = None,
               zone_id: Optional[str] = None,
               dns: Optional[str] = None,
               dns_zone: Optional[str] = None,
               ipam: Optional[str] = None,
               mtu: Optional[int] = None,
               reverse_dns: Optional[str] = None)
    func NewSimple(ctx *Context, name string, args SimpleArgs, opts ...ResourceOption) (*Simple, error)
    public Simple(string name, SimpleArgs args, CustomResourceOptions? opts = null)
    public Simple(String name, SimpleArgs args)
    public Simple(String name, SimpleArgs args, CustomResourceOptions options)
    
    type: proxmoxve:SDNZone:Simple
    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 SimpleArgs
    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 SimpleArgs
    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 SimpleArgs
    The arguments to resource properties.
    opts ResourceOption
    Bag of options to control resource's behavior.
    name string
    The unique name of the resource.
    args SimpleArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    name String
    The unique name of the resource.
    args SimpleArgs
    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 simpleResource = new ProxmoxVE.SDNZone.Simple("simpleResource", new()
    {
        Nodes = new[]
        {
            "string",
        },
        ZoneId = "string",
        Dns = "string",
        DnsZone = "string",
        Ipam = "string",
        Mtu = 0,
        ReverseDns = "string",
    });
    
    example, err := sdnzone.NewSimple(ctx, "simpleResource", &sdnzone.SimpleArgs{
    	Nodes: pulumi.StringArray{
    		pulumi.String("string"),
    	},
    	ZoneId:     pulumi.String("string"),
    	Dns:        pulumi.String("string"),
    	DnsZone:    pulumi.String("string"),
    	Ipam:       pulumi.String("string"),
    	Mtu:        pulumi.Int(0),
    	ReverseDns: pulumi.String("string"),
    })
    
    var simpleResource = new Simple("simpleResource", SimpleArgs.builder()
        .nodes("string")
        .zoneId("string")
        .dns("string")
        .dnsZone("string")
        .ipam("string")
        .mtu(0)
        .reverseDns("string")
        .build());
    
    simple_resource = proxmoxve.sdnzone.Simple("simpleResource",
        nodes=["string"],
        zone_id="string",
        dns="string",
        dns_zone="string",
        ipam="string",
        mtu=0,
        reverse_dns="string")
    
    const simpleResource = new proxmoxve.sdnzone.Simple("simpleResource", {
        nodes: ["string"],
        zoneId: "string",
        dns: "string",
        dnsZone: "string",
        ipam: "string",
        mtu: 0,
        reverseDns: "string",
    });
    
    type: proxmoxve:SDNZone:Simple
    properties:
        dns: string
        dnsZone: string
        ipam: string
        mtu: 0
        nodes:
            - string
        reverseDns: string
        zoneId: string
    

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

    Nodes List<string>
    The Proxmox nodes which the zone and associated VNets should be deployed on
    ZoneId 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.
    ReverseDns string
    Reverse DNS API server address.
    Nodes []string
    The Proxmox nodes which the zone and associated VNets should be deployed on
    ZoneId 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.
    ReverseDns string
    Reverse DNS API server address.
    nodes List<String>
    The Proxmox nodes which the zone and associated VNets should be deployed on
    zoneId 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.
    reverseDns String
    Reverse DNS API server address.
    nodes string[]
    The Proxmox nodes which the zone and associated VNets should be deployed on
    zoneId 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.
    reverseDns string
    Reverse DNS API server address.
    nodes Sequence[str]
    The Proxmox nodes which the zone and associated VNets should be deployed on
    zone_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.
    reverse_dns str
    Reverse DNS API server address.
    nodes List<String>
    The Proxmox nodes which the zone and associated VNets should be deployed on
    zoneId 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.
    reverseDns String
    Reverse DNS API server address.

    Outputs

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

    Get an existing Simple 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?: SimpleState, opts?: CustomResourceOptions): Simple
    @staticmethod
    def get(resource_name: str,
            id: str,
            opts: Optional[ResourceOptions] = 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,
            zone_id: Optional[str] = None) -> Simple
    func GetSimple(ctx *Context, name string, id IDInput, state *SimpleState, opts ...ResourceOption) (*Simple, error)
    public static Simple Get(string name, Input<string> id, SimpleState? state, CustomResourceOptions? opts = null)
    public static Simple get(String name, Output<String> id, SimpleState state, CustomResourceOptions options)
    resources:  _:    type: proxmoxve:SDNZone:Simple    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:
    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.
    Nodes List<string>
    The Proxmox nodes which the zone and associated VNets should be deployed on
    ReverseDns string
    Reverse DNS API server address.
    ZoneId 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.
    Nodes []string
    The Proxmox nodes which the zone and associated VNets should be deployed on
    ReverseDns string
    Reverse DNS API server address.
    ZoneId 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.
    nodes List<String>
    The Proxmox nodes which the zone and associated VNets should be deployed on
    reverseDns String
    Reverse DNS API server address.
    zoneId 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.
    nodes string[]
    The Proxmox nodes which the zone and associated VNets should be deployed on
    reverseDns string
    Reverse DNS API server address.
    zoneId string
    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.
    nodes Sequence[str]
    The Proxmox nodes which the zone and associated VNets should be deployed on
    reverse_dns str
    Reverse DNS API server address.
    zone_id str
    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.
    nodes List<String>
    The Proxmox nodes which the zone and associated VNets should be deployed on
    reverseDns String
    Reverse DNS API server address.
    zoneId String
    The unique identifier of the SDN zone.

    Import

    #!/usr/bin/env sh

    Simple SDN zone can be imported using its unique identifier (zone ID)

    $ pulumi import proxmoxve:SDNZone/simple:Simple example simple1
    

    To learn more about importing existing cloud resources, see Importing resources.

    Package Details

    Repository
    proxmoxve muhlba91/pulumi-proxmoxve
    License
    Apache-2.0
    Notes
    This Pulumi package is based on the proxmox Terraform Provider.
    proxmoxve logo
    Proxmox Virtual Environment (Proxmox VE) v7.4.0 published on Sunday, Aug 17, 2025 by Daniel Muehlbachler-Pietrzykowski