Get-NBDCIMRackElevation
Since
v4.4.10.0
SYNOPSIS
Get rack elevation data from Netbox
SYNTAX
Get-NBDCIMRackElevation [-All] [[-PageSize] <Int32>] [-Id] <UInt64[]> [[-Face] <String>] [[-Render] <String>]
[-IncludeImages] [[-Limit] <UInt16>] [[-Offset] <UInt16>] [-Raw] [-ProgressAction <ActionPreference>]
[<CommonParameters>]
DESCRIPTION
Retrieves rack elevation data showing which devices occupy which rack units. Supports both JSON data output and native SVG rendering from Netbox.
EXAMPLES
EXAMPLE 1
Get-NBDCIMRackElevation -Id 24
Returns elevation data for rack ID 24 (front face, JSON format)
EXAMPLE 2
Get-NBDCIMRackElevation -Id 24 -Face rear
Returns elevation data for the rear face of rack ID 24
EXAMPLE 3
Get-NBDCIMRackElevation -Id 24 -Render svg
Returns the native Netbox SVG rendering of the rack elevation
EXAMPLE 4
Get-NBDCIMRack -Name "Amsterdam-R01" | Get-NBDCIMRackElevation
Pipeline support: get elevation for rack by name
EXAMPLE 5
Get-NBDCIMRackElevation -Id 24 | Where-Object { $_.device }
Get only occupied rack units
EXAMPLE 6
Get-NBDCIMRackElevation -Id 24 -All
Get all rack units without manual pagination
PARAMETERS
-All
Automatically paginate through all results. Cannot be used with Limit or Offset.
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: 1
Default value: 100
Accept pipeline input: False
Accept wildcard characters: False
-Id
The ID of the rack to retrieve elevation for (required)
Type: UInt64[]
Parameter Sets: (All)
Aliases:
Required: True
Position: 2
Default value: None
Accept pipeline input: True (ByPropertyName)
Accept wildcard characters: False
-Face
Which face of the rack to show: front (default) or rear
Type: String
Parameter Sets: (All)
Aliases:
Required: False
Position: 3
Default value: Front
Accept pipeline input: False
Accept wildcard characters: False
-Render
Output format: json (default) returns structured data, svg returns Netbox-rendered SVG image
Type: String
Parameter Sets: (All)
Aliases:
Required: False
Position: 4
Default value: Json
Accept pipeline input: False
Accept wildcard characters: False
-IncludeImages
Include device images in SVG output (only applies when -Render svg)
Type: SwitchParameter
Parameter Sets: (All)
Aliases:
Required: False
Position: Named
Default value: False
Accept pipeline input: False
Accept wildcard characters: False
-Limit
Limit the number of rack units returned (for pagination)
Type: UInt16
Parameter Sets: (All)
Aliases:
Required: False
Position: 5
Default value: 0
Accept pipeline input: False
Accept wildcard characters: False
-Offset
Offset for pagination
Type: UInt16
Parameter Sets: (All)
Aliases:
Required: False
Position: 6
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
System.String
NOTES
AddedInVersion: v4.4.10.0