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

netbox.getVlans

Explore with Pulumi AI

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

    Using getVlans

    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 getVlans(args: GetVlansArgs, opts?: InvokeOptions): Promise<GetVlansResult>
function getVlansOutput(args: GetVlansOutputArgs, opts?: InvokeOptions): Output<GetVlansResult>
    def get_vlans(filters: Optional[Sequence[GetVlansFilter]] = None,
              id: Optional[str] = None,
              limit: Optional[float] = None,
              opts: Optional[InvokeOptions] = None) -> GetVlansResult
def get_vlans_output(filters: Optional[pulumi.Input[Sequence[pulumi.Input[GetVlansFilterArgs]]]] = None,
              id: Optional[pulumi.Input[str]] = None,
              limit: Optional[pulumi.Input[float]] = None,
              opts: Optional[InvokeOptions] = None) -> Output[GetVlansResult]
    func GetVlans(ctx *Context, args *GetVlansArgs, opts ...InvokeOption) (*GetVlansResult, error)
func GetVlansOutput(ctx *Context, args *GetVlansOutputArgs, opts ...InvokeOption) GetVlansResultOutput

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

    public static class GetVlans 
{
    public static Task<GetVlansResult> InvokeAsync(GetVlansArgs args, InvokeOptions? opts = null)
    public static Output<GetVlansResult> Invoke(GetVlansInvokeArgs args, InvokeOptions? opts = null)
}
    public static CompletableFuture<GetVlansResult> getVlans(GetVlansArgs args, InvokeOptions options)
public static Output<GetVlansResult> getVlans(GetVlansArgs args, InvokeOptions options)

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

    The following arguments are supported:

    Filters List<GetVlansFilter>
    Id string
    The ID of this resource.
    Limit double
    Defaults to 0.
    Filters []GetVlansFilter
    Id string
    The ID of this resource.
    Limit float64
    Defaults to 0.
    filters List<GetVlansFilter>
    id String
    The ID of this resource.
    limit Double
    Defaults to 0.
    filters GetVlansFilter[]
    id string
    The ID of this resource.
    limit number
    Defaults to 0.
    filters Sequence[GetVlansFilter]
    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.

    getVlans Result

    The following output properties are available:

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

    Supporting Types

    GetVlansFilter

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

    GetVlansVlan

    Description string
    GroupId double
    Name string
    Role double
    Site double
    Status string
    TagIds List<double>
    Tenant double
    Vid double
    Description string
    GroupId float64
    Name string
    Role float64
    Site float64
    Status string
    TagIds []float64
    Tenant float64
    Vid float64
    description String
    groupId Double
    name String
    role Double
    site Double
    status String
    tagIds List<Double>
    tenant Double
    vid Double
    description string
    groupId number
    name string
    role number
    site number
    status string
    tagIds number[]
    tenant number
    vid number
    description str
    group_id float
    name str
    role float
    site float
    status str
    tag_ids Sequence[float]
    tenant float
    vid float
    description String
    groupId Number
    name String
    role Number
    site Number
    status String
    tagIds List<Number>
    tenant Number
    vid Number

    Package Details

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