Docs Home Pulumi IaC Pulumi ESC Pulumi Insights Pulumi Cloud Packages Tutorials
  1. Packages
  2. Netbox Provider
  3. API Docs
  4. getVlanGroup
netbox 3.10.0 published on Monday, Apr 14, 2025 by e-breuninger
e-breuninger/terraform-provider-netbox

netbox.getVlanGroup

Explore with Pulumi AI

netbox 3.10.0 published on Monday, Apr 14, 2025 by e-breuninger
e-breuninger/terraform-provider-netbox

Example Usage

import * as pulumi from "@pulumi/pulumi";
import * as netbox from "@pulumi/netbox";

const example1 = netbox.getVlanGroup({
    name: "example1",
});
const example2 = netbox.getVlanGroup({
    slug: "example2",
});
const example3 = netbox.getVlanGroup({
    name: "example",
    scopeType: "dcim.site",
    scopeId: netbox_site.example.id,
});
Copy
import pulumi
import pulumi_netbox as netbox

example1 = netbox.get_vlan_group(name="example1")
example2 = netbox.get_vlan_group(slug="example2")
example3 = netbox.get_vlan_group(name="example",
    scope_type="dcim.site",
    scope_id=netbox_site["example"]["id"])
Copy
package main

import (
	"github.com/pulumi/pulumi-terraform-provider/sdks/go/netbox/v3/netbox"
	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
)

func main() {
	pulumi.Run(func(ctx *pulumi.Context) error {
		_, err := netbox.LookupVlanGroup(ctx, &netbox.LookupVlanGroupArgs{
			Name: pulumi.StringRef("example1"),
		}, nil)
		if err != nil {
			return err
		}
		_, err = netbox.LookupVlanGroup(ctx, &netbox.LookupVlanGroupArgs{
			Slug: pulumi.StringRef("example2"),
		}, nil)
		if err != nil {
			return err
		}
		_, err = netbox.LookupVlanGroup(ctx, &netbox.LookupVlanGroupArgs{
			Name:      pulumi.StringRef("example"),
			ScopeType: pulumi.StringRef("dcim.site"),
			ScopeId:   pulumi.Float64Ref(netbox_site.Example.Id),
		}, nil)
		if err != nil {
			return err
		}
		return nil
	})
}
Copy
using System.Collections.Generic;
using System.Linq;
using Pulumi;
using Netbox = Pulumi.Netbox;

return await Deployment.RunAsync(() => 
{
    var example1 = Netbox.GetVlanGroup.Invoke(new()
    {
        Name = "example1",
    });

    var example2 = Netbox.GetVlanGroup.Invoke(new()
    {
        Slug = "example2",
    });

    var example3 = Netbox.GetVlanGroup.Invoke(new()
    {
        Name = "example",
        ScopeType = "dcim.site",
        ScopeId = netbox_site.Example.Id,
    });

});
Copy
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.GetVlanGroupArgs;
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) {
        final var example1 = NetboxFunctions.getVlanGroup(GetVlanGroupArgs.builder()
            .name("example1")
            .build());

        final var example2 = NetboxFunctions.getVlanGroup(GetVlanGroupArgs.builder()
            .slug("example2")
            .build());

        final var example3 = NetboxFunctions.getVlanGroup(GetVlanGroupArgs.builder()
            .name("example")
            .scopeType("dcim.site")
            .scopeId(netbox_site.example().id())
            .build());

    }
}
Copy
variables:
  example1:
    fn::invoke:
      function: netbox:getVlanGroup
      arguments:
        name: example1
  example2:
    fn::invoke:
      function: netbox:getVlanGroup
      arguments:
        slug: example2
  example3:
    fn::invoke:
      function: netbox:getVlanGroup
      arguments:
        name: example
        scopeType: dcim.site
        scopeId: ${netbox_site.example.id}
Copy

Using getVlanGroup

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 getVlanGroup(args: GetVlanGroupArgs, opts?: InvokeOptions): Promise<GetVlanGroupResult>
function getVlanGroupOutput(args: GetVlanGroupOutputArgs, opts?: InvokeOptions): Output<GetVlanGroupResult>
Copy
def get_vlan_group(id: Optional[str] = None,
                   name: Optional[str] = None,
                   scope_id: Optional[float] = None,
                   scope_type: Optional[str] = None,
                   slug: Optional[str] = None,
                   opts: Optional[InvokeOptions] = None) -> GetVlanGroupResult
def get_vlan_group_output(id: Optional[pulumi.Input[str]] = None,
                   name: Optional[pulumi.Input[str]] = None,
                   scope_id: Optional[pulumi.Input[float]] = None,
                   scope_type: Optional[pulumi.Input[str]] = None,
                   slug: Optional[pulumi.Input[str]] = None,
                   opts: Optional[InvokeOptions] = None) -> Output[GetVlanGroupResult]
Copy
func LookupVlanGroup(ctx *Context, args *LookupVlanGroupArgs, opts ...InvokeOption) (*LookupVlanGroupResult, error)
func LookupVlanGroupOutput(ctx *Context, args *LookupVlanGroupOutputArgs, opts ...InvokeOption) LookupVlanGroupResultOutput
Copy

> Note: This function is named LookupVlanGroup in the Go SDK.

public static class GetVlanGroup 
{
    public static Task<GetVlanGroupResult> InvokeAsync(GetVlanGroupArgs args, InvokeOptions? opts = null)
    public static Output<GetVlanGroupResult> Invoke(GetVlanGroupInvokeArgs args, InvokeOptions? opts = null)
}
Copy
public static CompletableFuture<GetVlanGroupResult> getVlanGroup(GetVlanGroupArgs args, InvokeOptions options)
public static Output<GetVlanGroupResult> getVlanGroup(GetVlanGroupArgs args, InvokeOptions options)
Copy
fn::invoke:
  function: netbox:index/getVlanGroup:getVlanGroup
  arguments:
    # arguments dictionary
Copy

The following arguments are supported:

Id string
The ID of this resource.
Name string
At least one of name, slug or scope_type must be given.
ScopeId double
Required when scope_type is set.
ScopeType string
Valid values are dcim.location, dcim.site, dcim.sitegroup, dcim.region, dcim.rack, virtualization.cluster and virtualization.clustergroup. At least one of name, slug or scope_type must be given.
Slug string
At least one of name, slug or scope_type must be given.
Id string
The ID of this resource.
Name string
At least one of name, slug or scope_type must be given.
ScopeId float64
Required when scope_type is set.
ScopeType string
Valid values are dcim.location, dcim.site, dcim.sitegroup, dcim.region, dcim.rack, virtualization.cluster and virtualization.clustergroup. At least one of name, slug or scope_type must be given.
Slug string
At least one of name, slug or scope_type must be given.
id String
The ID of this resource.
name String
At least one of name, slug or scope_type must be given.
scopeId Double
Required when scope_type is set.
scopeType String
Valid values are dcim.location, dcim.site, dcim.sitegroup, dcim.region, dcim.rack, virtualization.cluster and virtualization.clustergroup. At least one of name, slug or scope_type must be given.
slug String
At least one of name, slug or scope_type must be given.
id string
The ID of this resource.
name string
At least one of name, slug or scope_type must be given.
scopeId number
Required when scope_type is set.
scopeType string
Valid values are dcim.location, dcim.site, dcim.sitegroup, dcim.region, dcim.rack, virtualization.cluster and virtualization.clustergroup. At least one of name, slug or scope_type must be given.
slug string
At least one of name, slug or scope_type must be given.
id str
The ID of this resource.
name str
At least one of name, slug or scope_type must be given.
scope_id float
Required when scope_type is set.
scope_type str
Valid values are dcim.location, dcim.site, dcim.sitegroup, dcim.region, dcim.rack, virtualization.cluster and virtualization.clustergroup. At least one of name, slug or scope_type must be given.
slug str
At least one of name, slug or scope_type must be given.
id String
The ID of this resource.
name String
At least one of name, slug or scope_type must be given.
scopeId Number
Required when scope_type is set.
scopeType String
Valid values are dcim.location, dcim.site, dcim.sitegroup, dcim.region, dcim.rack, virtualization.cluster and virtualization.clustergroup. At least one of name, slug or scope_type must be given.
slug String
At least one of name, slug or scope_type must be given.

getVlanGroup Result

The following output properties are available:

Description string
Id string
The ID of this resource.
Name string
At least one of name, slug or scope_type must be given.
Slug string
At least one of name, slug or scope_type must be given.
VlanCount double
ScopeId double
Required when scope_type is set.
ScopeType string
Valid values are dcim.location, dcim.site, dcim.sitegroup, dcim.region, dcim.rack, virtualization.cluster and virtualization.clustergroup. At least one of name, slug or scope_type must be given.
Description string
Id string
The ID of this resource.
Name string
At least one of name, slug or scope_type must be given.
Slug string
At least one of name, slug or scope_type must be given.
VlanCount float64
ScopeId float64
Required when scope_type is set.
ScopeType string
Valid values are dcim.location, dcim.site, dcim.sitegroup, dcim.region, dcim.rack, virtualization.cluster and virtualization.clustergroup. At least one of name, slug or scope_type must be given.
description String
id String
The ID of this resource.
name String
At least one of name, slug or scope_type must be given.
slug String
At least one of name, slug or scope_type must be given.
vlanCount Double
scopeId Double
Required when scope_type is set.
scopeType String
Valid values are dcim.location, dcim.site, dcim.sitegroup, dcim.region, dcim.rack, virtualization.cluster and virtualization.clustergroup. At least one of name, slug or scope_type must be given.
description string
id string
The ID of this resource.
name string
At least one of name, slug or scope_type must be given.
slug string
At least one of name, slug or scope_type must be given.
vlanCount number
scopeId number
Required when scope_type is set.
scopeType string
Valid values are dcim.location, dcim.site, dcim.sitegroup, dcim.region, dcim.rack, virtualization.cluster and virtualization.clustergroup. At least one of name, slug or scope_type must be given.
description str
id str
The ID of this resource.
name str
At least one of name, slug or scope_type must be given.
slug str
At least one of name, slug or scope_type must be given.
vlan_count float
scope_id float
Required when scope_type is set.
scope_type str
Valid values are dcim.location, dcim.site, dcim.sitegroup, dcim.region, dcim.rack, virtualization.cluster and virtualization.clustergroup. At least one of name, slug or scope_type must be given.
description String
id String
The ID of this resource.
name String
At least one of name, slug or scope_type must be given.
slug String
At least one of name, slug or scope_type must be given.
vlanCount Number
scopeId Number
Required when scope_type is set.
scopeType String
Valid values are dcim.location, dcim.site, dcim.sitegroup, dcim.region, dcim.rack, virtualization.cluster and virtualization.clustergroup. At least one of name, slug or scope_type must be given.

Package Details

Repository
netbox e-breuninger/terraform-provider-netbox
License
Notes
This Pulumi package is based on the netbox Terraform Provider.
netbox 3.10.0 published on Monday, Apr 14, 2025 by e-breuninger
e-breuninger/terraform-provider-netbox