Set-NBDCIMCoolingSource
Since
v4.7.0.1
SYNOPSIS
Updates an existing Cooling Source in Netbox DCIM module.
SYNTAX
Set-NBDCIMCoolingSource [-Id] <UInt64> [[-Site] <UInt64>] [[-Location] <UInt64>] [[-Name] <String>]
[[-Type] <String>] [[-Status] <String>] [[-Fluid_Type] <String>] [[-Cooling_Capacity] <Decimal>]
[[-Description] <String>] [[-Owner] <UInt64>] [[-Comments] <String>] [[-Tags] <Object[]>]
[[-Custom_Fields] <Hashtable>] [-Raw] [-ProgressAction <ActionPreference>] [-WhatIf] [-Confirm]
[<CommonParameters>]
DESCRIPTION
Updates an existing Cooling Source in Netbox DCIM module (NetBox 4.7+) via a PATCH request. Only the parameters you supply are sent. Supports pipeline input for the Id parameter.
Nullable fields can be cleared server-side: - Pass $null to -Location or -Cooling_Capacity. - Pass '' (empty string) to -Fluid_Type.
EXAMPLES
EXAMPLE 1
Set-NBDCIMCoolingSource -Id 5 -Status offline
Marks cooling source ID 5 as offline.
EXAMPLE 2
Set-NBDCIMCoolingSource -Id 5 -Fluid_Type '' -Cooling_Capacity $null
Clears the fluid type and cooling capacity of cooling source ID 5.
PARAMETERS
-Id
Database ID of the cooling source to update.
Type: UInt64
Parameter Sets: (All)
Aliases:
Required: True
Position: 1
Default value: 0
Accept pipeline input: True (ByPropertyName)
Accept wildcard characters: False
-Site
Site this cooling source is installed at (database ID).
Type: UInt64
Parameter Sets: (All)
Aliases:
Required: False
Position: 2
Default value: 0
Accept pipeline input: False
Accept wildcard characters: False
-Location
Location within the site (database ID). Pass $null to clear.
Type: UInt64
Parameter Sets: (All)
Aliases:
Required: False
Position: 3
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
-Name
Name of the cooling source.
Type: String
Parameter Sets: (All)
Aliases:
Required: False
Position: 4
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
-Type
Type of cooling equipment: chiller, cooling-tower, dry-cooler, crac or crah.
Type: String
Parameter Sets: (All)
Aliases:
Required: False
Position: 5
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
-Status
Operational status: offline, active, planned or failed.
Type: String
Parameter Sets: (All)
Aliases:
Required: False
Position: 6
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
-Fluid_Type
Cooling fluid type: water, water-glycol, dielectric or refrigerant. Pass '' (empty string) to clear the field server-side.
Type: String
Parameter Sets: (All)
Aliases:
Required: False
Position: 7
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
-Cooling_Capacity
Total rated cooling capacity in kW. Pass $null to clear.
Type: Decimal
Parameter Sets: (All)
Aliases:
Required: False
Position: 8
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
-Description
Brief description.
Type: String
Parameter Sets: (All)
Aliases:
Required: False
Position: 9
Default value: None
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.