Skip to content

New-NBDCIMCoolingFeed

Since

v4.7.0.1

SYNOPSIS

Creates a new Cooling Feed in Netbox DCIM module.

SYNTAX

New-NBDCIMCoolingFeed [-Cooling_Source] <UInt64> [[-Rack] <UInt64>] [-Name] <String> [[-Status] <String>]
 [[-Cooling_Capacity] <Decimal>] [[-Max_Flow] <Decimal>] [[-Max_Flow_Unit] <String>] [[-Description] <String>]
 [[-Tenant] <UInt64>] [[-Owner] <UInt64>] [[-Comments] <String>] [[-Tags] <Object[]>]
 [[-Custom_Fields] <Hashtable>] [-Raw] [-ProgressAction <ActionPreference>] [-WhatIf] [-Confirm]
 [<CommonParameters>]

DESCRIPTION

Creates a new Cooling Feed in Netbox DCIM module (NetBox 4.7+). A cooling feed delivers cooling capacity from a cooling source to a rack, analogous to a power feed in the power distribution model.

EXAMPLES

EXAMPLE 1

New-NBDCIMCoolingFeed -Cooling_Source 3 -Name 'CF-01' -Rack 12 -Cooling_Capacity 25 -Max_Flow 40 -Max_Flow_Unit lpm

Creates a 25 kW cooling feed from cooling source ID 3 to rack ID 12 with a 40 L/min maximum flow.

PARAMETERS

-Cooling_Source

Cooling source this feed is provisioned from (database ID). Required.

Type: UInt64
Parameter Sets: (All)
Aliases:

Required: True
Position: 1
Default value: 0
Accept pipeline input: False
Accept wildcard characters: False

-Rack

Rack this feed supplies (database ID).

Type: UInt64
Parameter Sets: (All)
Aliases:

Required: False
Position: 2
Default value: 0
Accept pipeline input: False
Accept wildcard characters: False

-Name

Name of the cooling feed. Required.

Type: String
Parameter Sets: (All)
Aliases:

Required: True
Position: 3
Default value: None
Accept pipeline input: False
Accept wildcard characters: False

-Status

Operational status: offline, active, planned or failed. Defaults to active server-side.

Type: String
Parameter Sets: (All)
Aliases:

Required: False
Position: 4
Default value: None
Accept pipeline input: False
Accept wildcard characters: False

-Cooling_Capacity

Rated cooling capacity in kW.

Type: Decimal
Parameter Sets: (All)
Aliases:

Required: False
Position: 5
Default value: 0
Accept pipeline input: False
Accept wildcard characters: False

-Max_Flow

Maximum flow rate, expressed in the unit given by -Max_Flow_Unit.

Type: Decimal
Parameter Sets: (All)
Aliases:

Required: False
Position: 6
Default value: 0
Accept pipeline input: False
Accept wildcard characters: False

-Max_Flow_Unit

Unit for -Max_Flow: lpm (liters per minute), m3ph (cubic meters per hour) or gpm (gallons per minute).

Type: String
Parameter Sets: (All)
Aliases:

Required: False
Position: 7
Default value: None
Accept pipeline input: False
Accept wildcard characters: False

-Description

Brief description.

Type: String
Parameter Sets: (All)
Aliases:

Required: False
Position: 8
Default value: None
Accept pipeline input: False
Accept wildcard characters: False

-Tenant

Tenant assigned to this object (database ID).

Type: UInt64
Parameter Sets: (All)
Aliases:

Required: False
Position: 9
Default value: 0
Accept pipeline input: False
Accept wildcard characters: False

-Owner

Owner of this object (database ID).

Type: UInt64
Parameter Sets: (All)
Aliases:

Required: False
Position: 10
Default value: 0
Accept pipeline input: False
Accept wildcard characters: False

-Comments

Detailed comments (Markdown is supported).

Type: String
Parameter Sets: (All)
Aliases:

Required: False
Position: 11
Default value: None
Accept pipeline input: False
Accept wildcard characters: False

-Tags

One or more tags to assign to this object (tag names or IDs).

Type: Object[]
Parameter Sets: (All)
Aliases:

Required: False
Position: 12
Default value: None
Accept pipeline input: False
Accept wildcard characters: False

-Custom_Fields

Hashtable of custom field values to set (cf_\<name>).

Type: Hashtable
Parameter Sets: (All)
Aliases:

Required: False
Position: 13
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

-WhatIf

Shows what would happen if the cmdlet runs. The cmdlet is not run.

Type: SwitchParameter
Parameter Sets: (All)
Aliases: wi

Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False

-Confirm

Prompts you for confirmation before running the cmdlet.

Type: SwitchParameter
Parameter Sets: (All)
Aliases: cf

Required: False
Position: Named
Default value: None
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.

Common parameters

common request params

https://netbox.readthedocs.io/en/stable/rest-api/overview/