Get-NBDCIMCoolingSource
Since
v4.7.0.1
SYNOPSIS
Retrieves Cooling Source objects from Netbox DCIM module.
SYNTAX
Query (Default)
Get-NBDCIMCoolingSource [-All] [-PageSize <Int32>] [-Brief] [-Fields <String[]>] [-Omit <String[]>]
[-Name <String[]>] [-Site_Id <UInt64[]>] [-Site <String[]>] [-Location_Id <UInt64[]>] [-Location <String[]>]
[-Region_Id <UInt64[]>] [-Region <String[]>] [-Site_Group_Id <UInt64[]>] [-Type <String[]>]
[-Status <String[]>] [-Fluid_Type <String[]>] [-Cooling_Capacity <Decimal[]>] [-Description <String[]>]
[-Owner_Id <UInt64[]>] [-Tag <String[]>] [-Tag_Id <UInt64[]>] [-Query <String>] [-Limit <UInt16>]
[-Offset <UInt32>] [-Raw] [-ProgressAction <ActionPreference>] [<CommonParameters>]
ByID
Get-NBDCIMCoolingSource [-All] [-PageSize <Int32>] [-Brief] [-Fields <String[]>] [-Omit <String[]>]
[-Id <UInt64[]>] [-Limit <UInt16>] [-Offset <UInt32>] [-Raw] [-ProgressAction <ActionPreference>]
[<CommonParameters>]
DESCRIPTION
Retrieves Cooling Source objects from Netbox DCIM module (NetBox 4.7+). A cooling source is a facility-level piece of cooling equipment (chiller, cooling tower, dry cooler, CRAC or CRAH) installed at a site, analogous to a power panel for the power distribution model.
EXAMPLES
EXAMPLE 1
Get-NBDCIMCoolingSource
Returns all cooling sources.
EXAMPLE 2
Get-NBDCIMCoolingSource -Site_Id 1 -Type chiller
Returns all chillers at site ID 1.
EXAMPLE 3
Get-NBDCIMCoolingSource -Id 5 -Brief
Returns the brief representation of cooling source 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., 'site.name', 'location.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
-Site_Id
Filter by site 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
-Site
Filter by site 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
-Location_Id
Filter by location 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
-Location
Filter by location 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
-Region_Id
Filter by region 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
-Region
Filter by region 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
-Site_Group_Id
Filter by site group 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
-Type
Filter by cooling source type (chiller, cooling-tower, dry-cooler, crac, crah). Accepts multiple values.
Type: String[]
Parameter Sets: Query
Aliases:
Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
-Status
Filter by operational status (offline, active, planned, failed). Accepts multiple values.
Type: String[]
Parameter Sets: Query
Aliases:
Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
-Fluid_Type
Filter by cooling fluid type (water, water-glycol, dielectric, refrigerant). Accepts multiple values.
Type: String[]
Parameter Sets: Query
Aliases:
Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
-Cooling_Capacity
Filter by total rated cooling capacity in kW. Accepts multiple values.
Type: Decimal[]
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 -Brief, -Fields, and -Omit parameters are mutually exclusive.