Get-NBDCIMLocation
Since
v4.4.10.0
SYNOPSIS
Get locations from Netbox
SYNTAX
Query (Default)
Get-NBDCIMLocation [-All] [-PageSize <Int32>] [-Brief] [-Fields <String[]>] [-Omit <String[]>] [-Name <String>]
[-Query <String>] [-Slug <String>] [-Site_Id <UInt64>] [-Site <String>] [-Parent_Id <UInt64>]
[-Status <String>] [-Tenant_Id <UInt64>] [-Limit <UInt16>] [-Offset <UInt16>] [-Raw]
[-ProgressAction <ActionPreference>] [<CommonParameters>]
ByID
Get-NBDCIMLocation [-All] [-PageSize <Int32>] [-Brief] [-Fields <String[]>] [-Omit <String[]>] [-Id <UInt64[]>]
[-Limit <UInt16>] [-Offset <UInt16>] [-Raw] [-ProgressAction <ActionPreference>] [<CommonParameters>]
DESCRIPTION
Retrieves location objects from Netbox with optional filtering. Locations represent physical areas within a site (e.g., floors, rooms, cages).
EXAMPLES
EXAMPLE 1
Get-NBDCIMLocation
Returns all locations
EXAMPLE 2
Get-NBDCIMLocation -Site_Id 1
Returns all locations at site with ID 1
EXAMPLE 3
Get-NBDCIMLocation -Name "Server Room"
Returns locations matching the name "Server Room"
PARAMETERS
-All
Automatically fetch all pages of results. Uses the API's pagination to retrieve all items across multiple requests.
Type: SwitchParameter
Parameter Sets: (All)
Aliases:
Required: False
Position: Named
Default value: False
Accept pipeline input: False
Accept wildcard characters: False
-PageSize
Number of items per page when using -All. Default: 100. Range: 1-1000.
Type: Int32
Parameter Sets: (All)
Aliases:
Required: False
Position: Named
Default value: 100
Accept pipeline input: False
Accept wildcard characters: False
-Brief
Return a minimal representation of objects (id, url, display, name only). Reduces response size by ~90%. Ideal for dropdowns and reference lists.
Type: SwitchParameter
Parameter Sets: (All)
Aliases:
Required: False
Position: Named
Default value: False
Accept pipeline input: False
Accept wildcard characters: False
-Fields
Specify which fields to include in the response. Supports nested field selection (e.g., 'site.name', 'device_type.model').
Type: String[]
Parameter Sets: (All)
Aliases:
Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
-Omit
Specify which fields to exclude from the response. Requires Netbox 4.5.0 or later.
Type: String[]
Parameter Sets: (All)
Aliases:
Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
-Id
The ID of the location to retrieve
Type: UInt64[]
Parameter Sets: ByID
Aliases:
Required: False
Position: Named
Default value: None
Accept pipeline input: True (ByPropertyName)
Accept wildcard characters: False
-Name
Filter by location name
Type: String
Parameter Sets: Query
Aliases:
Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
-Query
A general search query
Type: String
Parameter Sets: Query
Aliases:
Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
-Slug
Filter by slug
Type: String
Parameter Sets: Query
Aliases:
Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
-Site_Id
Filter by site ID
Type: UInt64
Parameter Sets: Query
Aliases:
Required: False
Position: Named
Default value: 0
Accept pipeline input: False
Accept wildcard characters: False
-Site
Filter by site name
Type: String
Parameter Sets: Query
Aliases:
Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
-Parent_Id
Filter by parent location ID
Type: UInt64
Parameter Sets: Query
Aliases:
Required: False
Position: Named
Default value: 0
Accept pipeline input: False
Accept wildcard characters: False
-Status
Filter by status (planned, staging, active, decommissioning, retired)
Type: String
Parameter Sets: Query
Aliases:
Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
-Tenant_Id
Filter by tenant ID
Type: UInt64
Parameter Sets: Query
Aliases:
Required: False
Position: Named
Default value: 0
Accept pipeline input: False
Accept wildcard characters: False
-Limit
Limit the number of results
Type: UInt16
Parameter Sets: (All)
Aliases:
Required: False
Position: Named
Default value: 0
Accept pipeline input: False
Accept wildcard characters: False
-Offset
Offset for pagination
Type: UInt16
Parameter Sets: (All)
Aliases:
Required: False
Position: Named
Default value: 0
Accept pipeline input: False
Accept wildcard characters: False
-Raw
Return the raw API response
Type: SwitchParameter
Parameter Sets: (All)
Aliases:
Required: False
Position: Named
Default value: False
Accept pipeline input: False
Accept wildcard characters: False
-ProgressAction
{{ Fill ProgressAction Description }}
Type: ActionPreference
Parameter Sets: (All)
Aliases: proga
Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
CommonParameters
This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters.
INPUTS
OUTPUTS
System.Management.Automation.PSObject
NOTES
AddedInVersion: v4.4.10.0 The -Brief, -Fields, and -Omit parameters are mutually exclusive.