Get-NBDCIMDeviceType
Since
v1.0.4
SYNOPSIS
Retrieves Devices objects from Netbox DCIM module.
SYNTAX
Query (Default)
Get-NBDCIMDeviceType [-All] [-PageSize <Int32>] [-Brief] [-Fields <String[]>] [-Omit <String[]>]
[-Offset <UInt16>] [-Limit <UInt16>] [-Query <String>] [-Slug <String>] [-Manufacturer <String>]
[-Manufacturer_Id <UInt64>] [-Model <String>] [-Part_Number <String>] [-U_Height <UInt16>]
[-Is_Full_Depth <Boolean>] [-Is_Console_Server <Boolean>] [-Is_PDU <Boolean>] [-Is_Network_Device <Boolean>]
[-Subdevice_Role <UInt16>] [-Raw] [-ProgressAction <ActionPreference>] [<CommonParameters>]
ByID
Get-NBDCIMDeviceType [-All] [-PageSize <Int32>] [-Brief] [-Fields <String[]>] [-Omit <String[]>]
[-Offset <UInt16>] [-Limit <UInt16>] [-Id <UInt64[]>] [-Raw] [-ProgressAction <ActionPreference>]
[<CommonParameters>]
DESCRIPTION
Retrieves Devices objects from Netbox DCIM module.
EXAMPLES
EXAMPLE 1
Get-NBDCIMDeviceType
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
-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
-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
-Id
One or more database IDs to retrieve.
Type: UInt64[]
Parameter Sets: ByID
Aliases:
Required: False
Position: Named
Default value: None
Accept pipeline input: True (ByPropertyName)
Accept wildcard characters: False
-Query
Free-text search across the object (NetBox 'q' parameter).
Type: String
Parameter Sets: Query
Aliases:
Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
-Slug
Filter by URL slug.
Type: String
Parameter Sets: Query
Aliases:
Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
-Manufacturer
Filter by manufacturer (name or slug).
Type: String
Parameter Sets: Query
Aliases:
Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
-Manufacturer_Id
Filter by manufacturer database ID.
Type: UInt64
Parameter Sets: Query
Aliases:
Required: False
Position: Named
Default value: 0
Accept pipeline input: False
Accept wildcard characters: False
-Model
Filter by model.
Type: String
Parameter Sets: Query
Aliases:
Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
-Part_Number
Discrete part number (optional)
Type: String
Parameter Sets: Query
Aliases:
Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
-U_Height
Height in rack units
Type: UInt16
Parameter Sets: Query
Aliases:
Required: False
Position: Named
Default value: 0
Accept pipeline input: False
Accept wildcard characters: False
-Is_Full_Depth
Device consumes both front and rear rack faces.
Type: Boolean
Parameter Sets: Query
Aliases:
Required: False
Position: Named
Default value: False
Accept pipeline input: False
Accept wildcard characters: False
-Is_Console_Server
Filter by is console server.
Type: Boolean
Parameter Sets: Query
Aliases:
Required: False
Position: Named
Default value: False
Accept pipeline input: False
Accept wildcard characters: False
-Is_PDU
Filter by is pdu.
Type: Boolean
Parameter Sets: Query
Aliases:
Required: False
Position: Named
Default value: False
Accept pipeline input: False
Accept wildcard characters: False
-Is_Network_Device
Filter by is network device.
Type: Boolean
Parameter Sets: Query
Aliases:
Required: False
Position: Named
Default value: False
Accept pipeline input: False
Accept wildcard characters: False
-Subdevice_Role
Filter by subdevice role.
Type: UInt16
Parameter Sets: Query
Aliases:
Required: False
Position: Named
Default value: 0
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: v1.0.4 The -Brief, -Fields, and -Omit parameters are mutually exclusive.