Set-NBDCIMModule
Since
v4.4.10.0
SYNOPSIS
Updates an existing DCIM Module in Netbox DCIM module.
SYNTAX
Set-NBDCIMModule [-Id] <UInt64> [[-Device] <UInt64>] [[-Module_Bay] <UInt64>] [[-Module_Type] <UInt64>]
[[-Status] <String>] [[-Serial] <String>] [[-Asset_Tag] <String>] [[-Description] <String>]
[[-Comments] <String>] [[-Tags] <String[]>] [[-Custom_Fields] <Hashtable>] [-Raw]
[-ProgressAction <ActionPreference>] [-WhatIf] [-Confirm] [<CommonParameters>]
DESCRIPTION
Updates an existing DCIM Module in Netbox DCIM module. Supports pipeline input for Id parameter where applicable.
To relocate an installed module (NetBox 4.7+), pass -Module_Bay with the target bay ID; to move it to a bay on another device, pass -Device and -Module_Bay together. The source bay is vacated automatically. NetBox rejects the move (400) when the target bay is already occupied or when the module type is not compatible with the target bay's module bay types.
EXAMPLES
EXAMPLE 1
Set-NBDCIMModule -Id 1 -Serial 'SN12345'
Updates the serial number of module 1.
EXAMPLE 2
Set-NBDCIMModule -Id 1 -Module_Bay 12
Moves module 1 into module bay 12 on the same device.
EXAMPLE 3
Set-NBDCIMModule -Id 1 -Device 7 -Module_Bay 30
Moves module 1 into module bay 30 on device 7.
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
Device assigned to this object (database ID). Combine with -Module_Bay to move the module to a bay on a different device.
Type: UInt64
Parameter Sets: (All)
Aliases:
Required: False
Position: 2
Default value: 0
Accept pipeline input: False
Accept wildcard characters: False
-Module_Bay
Module bay the module is installed in (database ID). Passing a different bay relocates the module into that bay.
Type: UInt64
Parameter Sets: (All)
Aliases:
Required: False
Position: 3
Default value: 0
Accept pipeline input: False
Accept wildcard characters: False
-Module_Type
Module type assigned to this object (database ID).
Type: UInt64
Parameter Sets: (All)
Aliases:
Required: False
Position: 4
Default value: 0
Accept pipeline input: False
Accept wildcard characters: False
-Status
Operational status.
Type: String
Parameter Sets: (All)
Aliases:
Required: False
Position: 5
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
-Serial
Serial number assigned by the manufacturer.
Type: String
Parameter Sets: (All)
Aliases:
Required: False
Position: 6
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
-Asset_Tag
Unique asset tag.
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
-Comments
Detailed comments (Markdown is supported).
Type: String
Parameter Sets: (All)
Aliases:
Required: False
Position: 9
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: String[]
Parameter Sets: (All)
Aliases:
Required: False
Position: 10
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: 11
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.4.10.0