netbox 5.0.1 published on Thursday, Dec 25, 2025 by e-breuninger
netbox 5.0.1 published on Thursday, Dec 25, 2025 by e-breuninger
Example Usage
import * as pulumi from "@pulumi/pulumi";
import * as netbox from "@pulumi/netbox";
// Get VLAN by name
const vlan1 = netbox.getVlan({
name: "vlan-1",
});
// Get VLAN by VID and IPAM role ID
const vlan2 = netbox.getVlan({
vid: 1234,
role: example.id,
});
// Get VLAN by name and tenant ID
const vlan3 = netbox.getVlan({
name: "vlan-3",
tenant: exampleNetboxTenant.id,
});
import pulumi
import pulumi_netbox as netbox
# Get VLAN by name
vlan1 = netbox.get_vlan(name="vlan-1")
# Get VLAN by VID and IPAM role ID
vlan2 = netbox.get_vlan(vid=1234,
role=example["id"])
# Get VLAN by name and tenant ID
vlan3 = netbox.get_vlan(name="vlan-3",
tenant=example_netbox_tenant["id"])
package main
import (
"github.com/pulumi/pulumi-terraform-provider/sdks/go/netbox/v5/netbox"
"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
)
func main() {
pulumi.Run(func(ctx *pulumi.Context) error {
// Get VLAN by name
_, err := netbox.LookupVlan(ctx, &netbox.LookupVlanArgs{
Name: pulumi.StringRef("vlan-1"),
}, nil)
if err != nil {
return err
}
// Get VLAN by VID and IPAM role ID
_, err = netbox.LookupVlan(ctx, &netbox.LookupVlanArgs{
Vid: pulumi.Float64Ref(1234),
Role: pulumi.Float64Ref(example.Id),
}, nil)
if err != nil {
return err
}
// Get VLAN by name and tenant ID
_, err = netbox.LookupVlan(ctx, &netbox.LookupVlanArgs{
Name: pulumi.StringRef("vlan-3"),
Tenant: pulumi.Float64Ref(exampleNetboxTenant.Id),
}, nil)
if err != nil {
return err
}
return nil
})
}
using System.Collections.Generic;
using System.Linq;
using Pulumi;
using Netbox = Pulumi.Netbox;
return await Deployment.RunAsync(() =>
{
// Get VLAN by name
var vlan1 = Netbox.GetVlan.Invoke(new()
{
Name = "vlan-1",
});
// Get VLAN by VID and IPAM role ID
var vlan2 = Netbox.GetVlan.Invoke(new()
{
Vid = 1234,
Role = example.Id,
});
// Get VLAN by name and tenant ID
var vlan3 = Netbox.GetVlan.Invoke(new()
{
Name = "vlan-3",
Tenant = exampleNetboxTenant.Id,
});
});
package generated_program;
import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.netbox.NetboxFunctions;
import com.pulumi.netbox.inputs.GetVlanArgs;
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) {
// Get VLAN by name
final var vlan1 = NetboxFunctions.getVlan(GetVlanArgs.builder()
.name("vlan-1")
.build());
// Get VLAN by VID and IPAM role ID
final var vlan2 = NetboxFunctions.getVlan(GetVlanArgs.builder()
.vid(1234)
.role(example.id())
.build());
// Get VLAN by name and tenant ID
final var vlan3 = NetboxFunctions.getVlan(GetVlanArgs.builder()
.name("vlan-3")
.tenant(exampleNetboxTenant.id())
.build());
}
}
variables:
# Get VLAN by name
vlan1:
fn::invoke:
function: netbox:getVlan
arguments:
name: vlan-1
# Get VLAN by VID and IPAM role ID
vlan2:
fn::invoke:
function: netbox:getVlan
arguments:
vid: 1234
role: ${example.id}
# Get VLAN by name and tenant ID
vlan3:
fn::invoke:
function: netbox:getVlan
arguments:
name: vlan-3
tenant: ${exampleNetboxTenant.id}
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(group_id: Optional[float] = None,
id: Optional[str] = None,
name: Optional[str] = None,
role: Optional[float] = None,
tenant: Optional[float] = None,
vid: Optional[float] = None,
opts: Optional[InvokeOptions] = None) -> GetVlanResult
def get_vlan_output(group_id: Optional[pulumi.Input[float]] = None,
id: Optional[pulumi.Input[str]] = None,
name: Optional[pulumi.Input[str]] = None,
role: Optional[pulumi.Input[float]] = None,
tenant: Optional[pulumi.Input[float]] = None,
vid: Optional[pulumi.Input[float]] = 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: netbox:index/getVlan:getVlan
arguments:
# arguments dictionaryThe following arguments are supported:
getVlan Result
The following output properties are available:
Package Details
- Repository
- netbox e-breuninger/terraform-provider-netbox
- License
- Notes
- This Pulumi package is based on the
netboxTerraform Provider.
netbox 5.0.1 published on Thursday, Dec 25, 2025 by e-breuninger
