Set-NBDCIMModuleBayType
Since
v4.7.0.1
SYNOPSIS
Updates an existing Module Bay Type in Netbox DCIM module.
SYNTAX
Set-NBDCIMModuleBayType [-Id] <UInt64> [[-Name] <String>] [[-Slug] <String>] [[-Manufacturer] <UInt64>]
[[-Color] <String>] [[-Description] <String>] [[-Owner] <UInt64>] [[-Comments] <String>] [[-Tags] <Object[]>]
[[-Custom_Fields] <Hashtable>] [-Raw] [-ProgressAction <ActionPreference>] [-WhatIf] [-Confirm]
[<CommonParameters>]
DESCRIPTION
Updates an existing Module Bay Type in Netbox DCIM module (NetBox 4.7+). Supports pipeline input for Id parameter.
EXAMPLES
EXAMPLE 1
Set-NBDCIMModuleBayType -Id 4 -Color 'ff0000' -Description 'Hot-swappable'
Updates the color and description of module bay type 4.
EXAMPLE 2
Set-NBDCIMModuleBayType -Id 4 -Manufacturer $null
Clears the manufacturer assignment of module bay type 4.
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
-Name
Name of the module bay type.
Type: String
Parameter Sets: (All)
Aliases:
Required: False
Position: 2
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
-Slug
URL-friendly unique identifier (slug).
Type: String
Parameter Sets: (All)
Aliases:
Required: False
Position: 3
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
-Manufacturer
Manufacturer assigned to this object (database ID). Pass $null to clear.
Type: UInt64
Parameter Sets: (All)
Aliases:
Required: False
Position: 4
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
-Color
Color as a 6-digit hex code (RRGGBB), e.g. 'ff0000'. Pass '' to clear.
Type: String
Parameter Sets: (All)
Aliases:
Required: False
Position: 5
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
-Description
Brief description.
Type: String
Parameter Sets: (All)
Aliases:
Required: False
Position: 6
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
-Owner
Owner assigned to this object (database ID).
Type: UInt64
Parameter Sets: (All)
Aliases:
Required: False
Position: 7
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: 8
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: 9
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: 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 Requires NetBox 4.7.0 or later.