Get-NBDCIMRackGroup
Since
v4.6.0.1
SYNOPSIS
Retrieve rack groups from Netbox DCIM.
SYNTAX
Query (Default)
Get-NBDCIMRackGroup [-All] [-PageSize <Int32>] [-Name <String>] [-Slug <String>] [-Query <String>]
[-Limit <UInt16>] [-Offset <UInt16>] [-Brief] [-Fields <String[]>] [-Omit <String[]>] [-Raw]
[-ProgressAction <ActionPreference>] [<CommonParameters>]
ByID
Get-NBDCIMRackGroup [-All] [-PageSize <Int32>] [-Id <UInt64[]>] [-Limit <UInt16>] [-Offset <UInt16>] [-Brief]
[-Fields <String[]>] [-Omit <String[]>] [-Raw] [-ProgressAction <ActionPreference>] [<CommonParameters>]
DESCRIPTION
Returns rack groups (NetBox 4.6+). A RackGroup is a flat, location-independent grouping axis for racks (e.g. by row or aisle).
EXAMPLES
EXAMPLE 1
Get-NBDCIMRackGroup -Name 'Row A'
PARAMETERS
-All
Retrieve all matching results, following pagination automatically.
Type: SwitchParameter
Parameter Sets: (All)
Aliases:
Required: False
Position: Named
Default value: False
Accept pipeline input: False
Accept wildcard characters: False
-PageSize
Page size to request while -All follows pagination.
Type: Int32
Parameter Sets: (All)
Aliases:
Required: False
Position: Named
Default value: 100
Accept pipeline input: False
Accept wildcard characters: False
-Id
One or more rack group database IDs (detail endpoint).
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 name.
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
-Query
Free-text search filter (NetBox ?q= parameter).
Type: String
Parameter Sets: Query
Aliases:
Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
-Limit
Maximum number of results to return per request (1-1000).
Type: UInt16
Parameter Sets: (All)
Aliases:
Required: False
Position: Named
Default value: 0
Accept pipeline input: False
Accept wildcard characters: False
-Offset
Number of results to skip (pagination offset).
Type: UInt16
Parameter Sets: (All)
Aliases:
Required: False
Position: Named
Default value: 0
Accept pipeline input: False
Accept wildcard characters: False
-Brief
Return the brief representation.
Type: SwitchParameter
Parameter Sets: (All)
Aliases:
Required: False
Position: Named
Default value: False
Accept pipeline input: False
Accept wildcard characters: False
-Fields
Return only the specified fields.
Type: String[]
Parameter Sets: (All)
Aliases:
Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
-Omit
Return all fields except the specified ones.
Type: String[]
Parameter Sets: (All)
Aliases:
Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
-Raw
Return the raw API response instead of the results array.
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.6.0.1