Get-NBDCIMModuleBayType
Since
v4.7.0.1
SYNOPSIS
Retrieves Module Bay Type objects from Netbox DCIM module.
SYNTAX
Query (Default)
Get-NBDCIMModuleBayType [-All] [-PageSize <Int32>] [-Brief] [-Fields <String[]>] [-Omit <String[]>]
[-Name <String[]>] [-Slug <String[]>] [-Color <String[]>] [-Manufacturer_Id <UInt64[]>]
[-Manufacturer <String[]>] [-Module_Bay_Id <UInt64[]>] [-Module_Bay_Template_Id <UInt64[]>]
[-Module_Type_Id <UInt64[]>] [-Description <String[]>] [-Owner_Id <UInt64[]>] [-Tag <String[]>]
[-Tag_Id <UInt64[]>] [-Query <String>] [-Limit <UInt16>] [-Offset <UInt32>] [-Raw]
[-ProgressAction <ActionPreference>] [<CommonParameters>]
ByID
Get-NBDCIMModuleBayType [-All] [-PageSize <Int32>] [-Brief] [-Fields <String[]>] [-Omit <String[]>]
[-Id <UInt64[]>] [-Limit <UInt16>] [-Offset <UInt32>] [-Raw] [-ProgressAction <ActionPreference>]
[<CommonParameters>]
DESCRIPTION
Retrieves Module Bay Type objects from Netbox DCIM module. A module bay type describes which kinds of modules a module bay accepts (NetBox 4.7+). Module bays, module bay templates and module types reference one or more module bay types.
EXAMPLES
EXAMPLE 1
Get-NBDCIMModuleBayType
Retrieves all module bay types.
EXAMPLE 2
Get-NBDCIMModuleBayType -Module_Type_Id 12
Retrieves the module bay types accepted by module type 12.
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., 'manufacturer.name').
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
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
-Name
Filter by name. Accepts multiple values.
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. Accepts multiple values.
Type: String[]
Parameter Sets: Query
Aliases:
Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
-Color
Filter by color (6-digit hex code, e.g. 'ff0000'). Accepts multiple values.
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. Accepts multiple values.
Type: UInt64[]
Parameter Sets: Query
Aliases:
Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
-Manufacturer
Filter by manufacturer slug. Accepts multiple values.
Type: String[]
Parameter Sets: Query
Aliases:
Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
-Module_Bay_Id
Filter by module bay database ID (module bay types assigned to that bay). Accepts multiple values.
Type: UInt64[]
Parameter Sets: Query
Aliases:
Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
-Module_Bay_Template_Id
Filter by module bay template database ID. Accepts multiple values.
Type: UInt64[]
Parameter Sets: Query
Aliases:
Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
-Module_Type_Id
Filter by module type database ID (module bay types accepted by that module type). Accepts multiple values.
Type: UInt64[]
Parameter Sets: Query
Aliases:
Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
-Description
Filter by description. Accepts multiple values.
Type: String[]
Parameter Sets: Query
Aliases:
Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
-Owner_Id
Filter by owner database ID. Accepts multiple values.
Type: UInt64[]
Parameter Sets: Query
Aliases:
Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
-Tag
Filter by tag slug. Accepts multiple values.
Type: String[]
Parameter Sets: Query
Aliases:
Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
-Tag_Id
Filter by tag ID(s); combines like -Tag.
Type: UInt64[]
Parameter Sets: Query
Aliases:
Required: False
Position: Named
Default value: None
Accept pipeline input: False
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
-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: UInt32
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 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.7.0.1 Requires NetBox 4.7.0 or later (the /api/dcim/module-bay-types/ endpoint). The -Brief, -Fields, and -Omit parameters are mutually exclusive.