netbox 3.10.0, Apr 14 25

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

netbox.getLocations

Explore with Pulumi AI

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

Using getLocations

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.

TypeScript
Python
Go
C#
Java
YAML

function getLocations(args: GetLocationsArgs, opts?: InvokeOptions): Promise<GetLocationsResult>
function getLocationsOutput(args: GetLocationsOutputArgs, opts?: InvokeOptions): Output<GetLocationsResult>

def get_locations(filters: Optional[Sequence[GetLocationsFilter]] = None,
                  id: Optional[str] = None,
                  limit: Optional[float] = None,
                  tags: Optional[Sequence[str]] = None,
                  opts: Optional[InvokeOptions] = None) -> GetLocationsResult
def get_locations_output(filters: Optional[pulumi.Input[Sequence[pulumi.Input[GetLocationsFilterArgs]]]] = None,
                  id: Optional[pulumi.Input[str]] = None,
                  limit: Optional[pulumi.Input[float]] = None,
                  tags: Optional[pulumi.Input[Sequence[pulumi.Input[str]]]] = None,
                  opts: Optional[InvokeOptions] = None) -> Output[GetLocationsResult]

func GetLocations(ctx *Context, args *GetLocationsArgs, opts ...InvokeOption) (*GetLocationsResult, error)
func GetLocationsOutput(ctx *Context, args *GetLocationsOutputArgs, opts ...InvokeOption) GetLocationsResultOutput

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

public static class GetLocations 
{
    public static Task<GetLocationsResult> InvokeAsync(GetLocationsArgs args, InvokeOptions? opts = null)
    public static Output<GetLocationsResult> Invoke(GetLocationsInvokeArgs args, InvokeOptions? opts = null)
}

public static CompletableFuture<GetLocationsResult> getLocations(GetLocationsArgs args, InvokeOptions options)
public static Output<GetLocationsResult> getLocations(GetLocationsArgs args, InvokeOptions options)

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

The following arguments are supported:

Filters List<GetLocationsFilter>: A list of filter to apply to the API query when requesting locations.
Id string: The ID of this resource.
Limit double: The limit of objects to return from the API lookup. Defaults to 0.
Tags List<string>: A list of tags to filter on.

Filters []GetLocationsFilter: A list of filter to apply to the API query when requesting locations.
Id string: The ID of this resource.
Limit float64: The limit of objects to return from the API lookup. Defaults to 0.
Tags []string: A list of tags to filter on.

filters List<GetLocationsFilter>: A list of filter to apply to the API query when requesting locations.
id String: The ID of this resource.
limit Double: The limit of objects to return from the API lookup. Defaults to 0.
tags List<String>: A list of tags to filter on.

filters GetLocationsFilter[]: A list of filter to apply to the API query when requesting locations.
id string: The ID of this resource.
limit number: The limit of objects to return from the API lookup. Defaults to 0.
tags string[]: A list of tags to filter on.

filters Sequence[GetLocationsFilter]: A list of filter to apply to the API query when requesting locations.
id str: The ID of this resource.
limit float: The limit of objects to return from the API lookup. Defaults to 0.
tags Sequence[str]: A list of tags to filter on.

filters List<Property Map>: A list of filter to apply to the API query when requesting locations.
id String: The ID of this resource.
limit Number: The limit of objects to return from the API lookup. Defaults to 0.
tags List<String>: A list of tags to filter on.

getLocations Result

The following output properties are available:

Id string: The ID of this resource.
Locations List<GetLocationsLocation>
Filters List<GetLocationsFilter>: A list of filter to apply to the API query when requesting locations.
Limit double: The limit of objects to return from the API lookup. Defaults to 0.
Tags List<string>: A list of tags to filter on.

Id string: The ID of this resource.
Locations []GetLocationsLocation
Filters []GetLocationsFilter: A list of filter to apply to the API query when requesting locations.
Limit float64: The limit of objects to return from the API lookup. Defaults to 0.
Tags []string: A list of tags to filter on.

id String: The ID of this resource.
locations List<GetLocationsLocation>
filters List<GetLocationsFilter>: A list of filter to apply to the API query when requesting locations.
limit Double: The limit of objects to return from the API lookup. Defaults to 0.
tags List<String>: A list of tags to filter on.

id string: The ID of this resource.
locations GetLocationsLocation[]
filters GetLocationsFilter[]: A list of filter to apply to the API query when requesting locations.
limit number: The limit of objects to return from the API lookup. Defaults to 0.
tags string[]: A list of tags to filter on.

id str: The ID of this resource.
locations Sequence[GetLocationsLocation]
filters Sequence[GetLocationsFilter]: A list of filter to apply to the API query when requesting locations.
limit float: The limit of objects to return from the API lookup. Defaults to 0.
tags Sequence[str]: A list of tags to filter on.

id String: The ID of this resource.
locations List<Property Map>
filters List<Property Map>: A list of filter to apply to the API query when requesting locations.
limit Number: The limit of objects to return from the API lookup. Defaults to 0.
tags List<String>: A list of tags to filter on.

Supporting Types

GetLocationsFilter

Name string: The name of the field to filter on. Supported fields are: .
Value string: The value to pass to the specified filter.

Name string: The name of the field to filter on. Supported fields are: .
Value string: The value to pass to the specified filter.

name String: The name of the field to filter on. Supported fields are: .
value String: The value to pass to the specified filter.

name string: The name of the field to filter on. Supported fields are: .
value string: The value to pass to the specified filter.

name str: The name of the field to filter on. Supported fields are: .
value str: The value to pass to the specified filter.

name String: The name of the field to filter on. Supported fields are: .
value String: The value to pass to the specified filter.

GetLocationsLocation

Description string
Id string
Name string
ParentId double
SiteId double
Slug string
Status string
TenantId double

Description string
Id string
Name string
ParentId float64
SiteId float64
Slug string
Status string
TenantId float64

description String
id String
name String
parentId Double
siteId Double
slug String
status String
tenantId Double

description string
id string
name string
parentId number
siteId number
slug string
status string
tenantId number

description str
id str
name str
parent_id float
site_id float
slug str
status str
tenant_id float

description String
id String
name String
parentId Number
siteId Number
slug String
status String
tenantId Number

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

netbox.getLocations

On this page

On this page

Using getLocations

getLocations Result

Supporting Types

GetLocationsFilter

GetLocationsLocation

Package Details

On this page

On this page