1. Packages
  2. Netbox Provider
  3. API Docs
  4. getVlanGroups
Viewing docs for netbox 5.2.1
published on Thursday, Mar 12, 2026 by e-breuninger
Schema (JSON)
e-breuninger/terraform-provider-netbox

netbox.getVlanGroups

netbox logo
Viewing docs for netbox 5.2.1
published on Thursday, Mar 12, 2026 by e-breuninger
Schema (JSON)
e-breuninger/terraform-provider-netbox

    Using getVlanGroups

    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 getVlanGroups(args: GetVlanGroupsArgs, opts?: InvokeOptions): Promise<GetVlanGroupsResult>
function getVlanGroupsOutput(args: GetVlanGroupsOutputArgs, opts?: InvokeOptions): Output<GetVlanGroupsResult>
    def get_vlan_groups(filters: Optional[Sequence[GetVlanGroupsFilter]] = None,
                    id: Optional[str] = None,
                    limit: Optional[float] = None,
                    opts: Optional[InvokeOptions] = None) -> GetVlanGroupsResult
def get_vlan_groups_output(filters: Optional[pulumi.Input[Sequence[pulumi.Input[GetVlanGroupsFilterArgs]]]] = None,
                    id: Optional[pulumi.Input[str]] = None,
                    limit: Optional[pulumi.Input[float]] = None,
                    opts: Optional[InvokeOptions] = None) -> Output[GetVlanGroupsResult]
    func GetVlanGroups(ctx *Context, args *GetVlanGroupsArgs, opts ...InvokeOption) (*GetVlanGroupsResult, error)
func GetVlanGroupsOutput(ctx *Context, args *GetVlanGroupsOutputArgs, opts ...InvokeOption) GetVlanGroupsResultOutput

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

    public static class GetVlanGroups 
{
    public static Task<GetVlanGroupsResult> InvokeAsync(GetVlanGroupsArgs args, InvokeOptions? opts = null)
    public static Output<GetVlanGroupsResult> Invoke(GetVlanGroupsInvokeArgs args, InvokeOptions? opts = null)
}
    public static CompletableFuture<GetVlanGroupsResult> getVlanGroups(GetVlanGroupsArgs args, InvokeOptions options)
public static Output<GetVlanGroupsResult> getVlanGroups(GetVlanGroupsArgs args, InvokeOptions options)

    fn::invoke:
  function: netbox:index/getVlanGroups:getVlanGroups
  arguments:
    # arguments dictionary

    The following arguments are supported:

    Filters List<GetVlanGroupsFilter>
    Id string
    The ID of this resource.
    Limit double
    Defaults to 0.
    Filters []GetVlanGroupsFilter
    Id string
    The ID of this resource.
    Limit float64
    Defaults to 0.
    filters List<GetVlanGroupsFilter>
    id String
    The ID of this resource.
    limit Double
    Defaults to 0.
    filters GetVlanGroupsFilter[]
    id string
    The ID of this resource.
    limit number
    Defaults to 0.
    filters Sequence[GetVlanGroupsFilter]
    id str
    The ID of this resource.
    limit float
    Defaults to 0.
    filters List<Property Map>
    id String
    The ID of this resource.
    limit Number
    Defaults to 0.

    getVlanGroups Result

    The following output properties are available:

    Id string
    The ID of this resource.
    VlanGroups List<GetVlanGroupsVlanGroup>
    Filters List<GetVlanGroupsFilter>
    Limit double
    Defaults to 0.
    Id string
    The ID of this resource.
    VlanGroups []GetVlanGroupsVlanGroup
    Filters []GetVlanGroupsFilter
    Limit float64
    Defaults to 0.
    id String
    The ID of this resource.
    vlanGroups List<GetVlanGroupsVlanGroup>
    filters List<GetVlanGroupsFilter>
    limit Double
    Defaults to 0.
    id string
    The ID of this resource.
    vlanGroups GetVlanGroupsVlanGroup[]
    filters GetVlanGroupsFilter[]
    limit number
    Defaults to 0.
    id String
    The ID of this resource.
    vlanGroups List<Property Map>
    filters List<Property Map>
    limit Number
    Defaults to 0.

    Supporting Types

    GetVlanGroupsFilter

    Name string
    Value string
    Name string
    Value string
    name String
    value String
    name string
    value string
    name str
    value str
    name String
    value String

    GetVlanGroupsVlanGroup

    Description string
    Id double
    Name string
    Ranges List<GetVlanGroupsVlanGroupRange>
    Slug string
    TagIds List<double>
    Used double
    Description string
    Id float64
    Name string
    Ranges []GetVlanGroupsVlanGroupRange
    Slug string
    TagIds []float64
    Used float64
    description String
    id Double
    name String
    ranges List<GetVlanGroupsVlanGroupRange>
    slug String
    tagIds List<Double>
    used Double
    description string
    id number
    name string
    ranges GetVlanGroupsVlanGroupRange[]
    slug string
    tagIds number[]
    used number
    description String
    id Number
    name String
    ranges List<Property Map>
    slug String
    tagIds List<Number>
    used Number

    GetVlanGroupsVlanGroupRange

    End double
    Start double
    End float64
    Start float64
    end Double
    start Double
    end number
    start number
    end float
    start float
    end Number
    start Number

    Package Details

    Repository
    netbox e-breuninger/terraform-provider-netbox
    License
    Notes
    This Pulumi package is based on the netbox Terraform Provider.
    netbox logo
    Viewing docs for netbox 5.2.1
    published on Thursday, Mar 12, 2026 by e-breuninger
    Schema (JSON)
    e-breuninger/terraform-provider-netbox
      Try Pulumi Cloud free. Your team will thank you.