Set-NBDCIMFrontPort
Since
v4.4.7
SYNOPSIS
Updates an existing front port in Netbox DCIM module.
SYNTAX
Set-NBDCIMFrontPort [-Id] <UInt64> [[-Device] <UInt16>] [[-Module] <UInt16>] [[-Name] <String>]
[[-Label] <String>] [[-Type] <String>] [[-Color] <String>] [[-Rear_Ports] <PSObject[]>]
[[-Rear_Port] <UInt64>] [[-Rear_Port_Position] <UInt16>] [[-Description] <String>]
[[-Mark_Connected] <Boolean>] [[-Tags] <UInt64[]>] [-Force] [-Raw] [-ProgressAction <ActionPreference>]
[-WhatIf] [-Confirm] [<CommonParameters>]
DESCRIPTION
Updates an existing front port in Netbox DCIM module. Supports pipeline input for Id parameter.
NOTE: Netbox 4.5+ uses a new port mapping model. The Rear_Port and Rear_Port_Position parameters are deprecated on 4.5+ and will be automatically converted to the new Rear_Ports array format.
EXAMPLES
EXAMPLE 1
Set-NBDCIMFrontPort -Id 1 -Name "Port 1 Updated"
Updates the name of front port with ID 1.
EXAMPLE 2
Set-NBDCIMFrontPort -Id 1 -Rear_Ports @(
@{ rear_port = 100; rear_port_position = 2; position = 1 }
)
Updates the rear port mappings using Netbox 4.5+ format.
PARAMETERS
-Id
The database ID of the front port 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
The database ID of the device.
Type: UInt16
Parameter Sets: (All)
Aliases:
Required: False
Position: 2
Default value: 0
Accept pipeline input: False
Accept wildcard characters: False
-Module
The database ID of the module within the device.
Type: UInt16
Parameter Sets: (All)
Aliases:
Required: False
Position: 3
Default value: 0
Accept pipeline input: False
Accept wildcard characters: False
-Name
The name of the front port.
Type: String
Parameter Sets: (All)
Aliases:
Required: False
Position: 4
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
-Label
A physical label for the port.
Type: String
Parameter Sets: (All)
Aliases:
Required: False
Position: 5
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
-Type
The connector type of the front port.
Type: String
Parameter Sets: (All)
Aliases:
Required: False
Position: 6
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
-Color
The color of the port in 6-character hex format.
Type: String
Parameter Sets: (All)
Aliases:
Required: False
Position: 7
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
-Rear_Ports
Array of rear port mappings for Netbox 4.5+. Each mapping should be a hashtable or PSCustomObject with the following properties: - rear_port: (Required) The database ID of the rear port - rear_port_position: (Optional) Position on the rear port (1-1024) - position: (Optional) Position on the front port
Type: PSObject[]
Parameter Sets: (All)
Aliases:
Required: False
Position: 8
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
-Rear_Port
DEPRECATED on Netbox 4.5+. Use Rear_Ports instead. The database ID of the rear port that this front port maps to.
Type: UInt64
Parameter Sets: (All)
Aliases:
Required: False
Position: 9
Default value: 0
Accept pipeline input: False
Accept wildcard characters: False
-Rear_Port_Position
DEPRECATED on Netbox 4.5+. Use Rear_Ports instead. The position on the rear port.
Type: UInt16
Parameter Sets: (All)
Aliases:
Required: False
Position: 10
Default value: 0
Accept pipeline input: False
Accept wildcard characters: False
-Description
A description of the front port.
Type: String
Parameter Sets: (All)
Aliases:
Required: False
Position: 11
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
-Mark_Connected
Whether to mark this port as connected.
Type: Boolean
Parameter Sets: (All)
Aliases:
Required: False
Position: 12
Default value: False
Accept pipeline input: False
Accept wildcard characters: False
-Tags
Array of tag IDs to assign to this front port.
Type: UInt64[]
Parameter Sets: (All)
Aliases:
Required: False
Position: 13
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
-Force
Skip confirmation prompt.
Type: SwitchParameter
Parameter Sets: (All)
Aliases:
Required: False
Position: Named
Default value: False
Accept pipeline input: False
Accept wildcard characters: False
-Raw
Return the raw API response object instead of the .results collection.
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.7