Set-NBDCIMCoolingOutflowTemplate
Since
v4.7.0.1
SYNOPSIS
Updates an existing DCIM CoolingOutflowTemplate in Netbox DCIM module.
SYNTAX
Set-NBDCIMCoolingOutflowTemplate [-Id] <UInt64> [[-Device_Type] <UInt64>] [[-Module_Type] <UInt64>]
[[-Name] <String>] [[-Label] <String>] [[-Type] <String>] [[-Diameter] <Decimal>] [[-Diameter_Unit] <String>]
[[-Cooling_Intake] <UInt64>] [[-Description] <String>] [-Raw] [-ProgressAction <ActionPreference>] [-WhatIf]
[-Confirm] [<CommonParameters>]
DESCRIPTION
Updates an existing Cooling Outflow Template (NetBox 4.7+) via PATCH. Supports pipeline input for the Id parameter. Nullable numeric and FK parameters accept $null to clear the field; clearable enum parameters accept '' (empty string) to clear the field.
EXAMPLES
EXAMPLE 1
Set-NBDCIMCoolingOutflowTemplate -Id 5 -Label 'OUT-1'
Sets the label of cooling outflow template 5.
PARAMETERS
-Id
Database ID of the object to update.
Type: UInt64
Parameter Sets: (All)
Aliases:
Required: True
Position: 1
Default value: 0
Accept pipeline input: True (ByPropertyName)
Accept wildcard characters: False
-Device_Type
Device type this template belongs to (database ID). Mutually exclusive with -Module_Type. Pass $null to clear.
Type: UInt64
Parameter Sets: (All)
Aliases:
Required: False
Position: 2
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
-Module_Type
Module type this template belongs to (database ID). Mutually exclusive with -Device_Type. 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 template. Use {module} as a placeholder for the module bay position on module type templates.
Type: String
Parameter Sets: (All)
Aliases:
Required: False
Position: 4
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
-Label
Physical label.
Type: String
Parameter Sets: (All)
Aliases:
Required: False
Position: 5
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
-Type
Connector type: 'uqd', 'uqdb', 'qdc', 'camlock', 'npt', 'bsp' or 'proprietary'. Pass '' to clear the field server-side (sent as JSON null).
Type: String
Parameter Sets: (All)
Aliases:
Required: False
Position: 6
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
-Diameter
Connector diameter (number, 0.01 - 1000000). Pass $null to clear.
Type: Decimal
Parameter Sets: (All)
Aliases:
Required: False
Position: 7
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
-Diameter_Unit
Unit for -Diameter: 'mm', 'cm' or 'in'. Pass '' to clear the field server-side (sent as JSON null). NetBox requires a unit whenever -Diameter is set, so clear both together: -Diameter $null -Diameter_Unit ''.
Type: String
Parameter Sets: (All)
Aliases:
Required: False
Position: 8
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
-Cooling_Intake
Cooling intake template on the same device type that this outflow template is paired with (database ID). Pass $null to clear.
Type: UInt64
Parameter Sets: (All)
Aliases:
Required: False
Position: 9
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
-Description
Brief description.
Type: String
Parameter Sets: (All)
Aliases:
Required: False
Position: 10
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