Get-NBDCIMCoolingIntake
Since
v4.7.0.1
SYNOPSIS
Retrieves Cooling Intakes objects from Netbox DCIM module.
SYNTAX
Query (Default)
Get-NBDCIMCoolingIntake [-All] [-PageSize <Int32>] [-Brief] [-Fields <String[]>] [-Omit <String[]>]
[-Name <String[]>] [-Label <String[]>] [-Device_Id <UInt64[]>] [-Device <String[]>]
[-Device_Type_Id <UInt64[]>] [-Module_Id <UInt64[]>] [-Site_Id <UInt64[]>] [-Site <String[]>]
[-Location_Id <UInt64[]>] [-Rack_Id <UInt64[]>] [-Type <String[]>] [-Diameter <Decimal[]>]
[-Diameter_Unit <String[]>] [-Max_Flow <Decimal[]>] [-Max_Flow_Unit <String[]>]
[-Cooling_Outflow_Id <UInt64[]>] [-Description <String[]>] [-Tag <String[]>] [-Tag_Id <UInt64[]>]
[-Query <String>] [-Limit <UInt16>] [-Offset <UInt32>] [-Raw] [-ProgressAction <ActionPreference>]
[<CommonParameters>]
ByID
Get-NBDCIMCoolingIntake [-All] [-PageSize <Int32>] [-Brief] [-Fields <String[]>] [-Omit <String[]>]
[-Id <UInt64[]>] [-Limit <UInt16>] [-Offset <UInt32>] [-Raw] [-ProgressAction <ActionPreference>]
[<CommonParameters>]
DESCRIPTION
Retrieves Cooling Intakes objects from Netbox DCIM module (NetBox 4.7+). Array-typed filters accept multiple values and are sent as repeated query keys.
EXAMPLES
EXAMPLE 1
Get-NBDCIMCoolingIntake
Retrieves all cooling intakes.
EXAMPLE 2
Get-NBDCIMCoolingIntake -Device_Id 12 -Type 'uqd'
Lists the UQD cooling intakes on device 12.
EXAMPLE 3
Get-NBDCIMCoolingIntake -Id 5
Retrieves the cooling intake with ID 5.
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., 'device.name', 'module.display').
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 (one or more values).
Type: String[]
Parameter Sets: Query
Aliases:
Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
-Label
Filter by physical label (one or more values).
Type: String[]
Parameter Sets: Query
Aliases:
Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
-Device_Id
Filter by device database ID.
Type: UInt64[]
Parameter Sets: Query
Aliases:
Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
-Device
Filter by device name.
Type: String[]
Parameter Sets: Query
Aliases:
Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
-Device_Type_Id
Filter by the device type database ID of the parent device.
Type: UInt64[]
Parameter Sets: Query
Aliases:
Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
-Module_Id
Filter by module database ID.
Type: UInt64[]
Parameter Sets: Query
Aliases:
Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
-Site_Id
Filter by site database ID.
Type: UInt64[]
Parameter Sets: Query
Aliases:
Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
-Site
Filter by site slug.
Type: String[]
Parameter Sets: Query
Aliases:
Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
-Location_Id
Filter by location database ID.
Type: UInt64[]
Parameter Sets: Query
Aliases:
Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
-Rack_Id
Filter by rack database ID.
Type: UInt64[]
Parameter Sets: Query
Aliases:
Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
-Type
Filter by connector type ('uqd', 'uqdb', 'qdc', 'camlock', 'npt', 'bsp', 'proprietary').
Type: String[]
Parameter Sets: Query
Aliases:
Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
-Diameter
Filter by connector diameter.
Type: Decimal[]
Parameter Sets: Query
Aliases:
Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
-Diameter_Unit
Filter by diameter unit ('mm', 'cm', 'in').
Type: String[]
Parameter Sets: Query
Aliases:
Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
-Max_Flow
Filter by maximum flow rate.
Type: Decimal[]
Parameter Sets: Query
Aliases:
Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
-Max_Flow_Unit
Filter by maximum flow unit ('lpm', 'm3ph', 'gpm').
Type: String[]
Parameter Sets: Query
Aliases:
Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
-Cooling_Outflow_Id
Filter by the upstream cooling outflow database ID.
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 (one or more values).
Type: String[]
Parameter Sets: Query
Aliases:
Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
-Tag
Filter by tag slug (one or more 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 The -Brief, -Fields, and -Omit parameters are mutually exclusive.