Set-NBDCIMCable
Since
v4.4.10.0
SYNOPSIS
Updates an existing cable in Netbox DCIM module.
SYNTAX
Set-NBDCIMCable [-Id] <UInt64> [[-Type] <String>] [[-Status] <String>] [[-Tenant] <UInt64>] [[-Label] <String>]
[[-Color] <String>] [[-Length] <Decimal>] [[-Length_Unit] <String>] [[-Description] <String>]
[[-Comments] <String>] [[-Tags] <String[]>] [[-Custom_Fields] <Hashtable>] [[-Cable_Profile] <String>] [-Raw]
[-ProgressAction <ActionPreference>] [-WhatIf] [-Confirm] [<CommonParameters>]
DESCRIPTION
Updates an existing cable in Netbox DCIM module. Supports pipeline input for Id parameter.
EXAMPLES
EXAMPLE 1
Set-NBDCIMCable -Id 1 -Label 'Patch-001'
EXAMPLE 2
Set-NBDCIMCable -Id 1 -Cable_Profile '1c4p-4c1p' -Status 'connected'
PARAMETERS
-Id
The ID of the cable to update.
```yaml Type: UInt64 Parameter Sets: (All) Aliases:
Required: True Position: 1 Default value: 0 Accept pipeline input: True (ByPropertyName) Accept wildcard characters: False ```
-Type
Cable type.
```yaml Type: String Parameter Sets: (All) Aliases:
Required: False Position: 2 Default value: None Accept pipeline input: False Accept wildcard characters: False ```
-Status
Cable status: connected, planned, decommissioning.
```yaml Type: String Parameter Sets: (All) Aliases:
Required: False Position: 3 Default value: None Accept pipeline input: False Accept wildcard characters: False ```
-Tenant
Tenant ID.
```yaml Type: UInt64 Parameter Sets: (All) Aliases:
Required: False Position: 4 Default value: 0 Accept pipeline input: False Accept wildcard characters: False ```
-Label
Cable label.
```yaml Type: String Parameter Sets: (All) Aliases:
Required: False Position: 5 Default value: None Accept pipeline input: False Accept wildcard characters: False ```
-Color
Cable color (hex code without #).
```yaml Type: String Parameter Sets: (All) Aliases:
Required: False Position: 6 Default value: None Accept pipeline input: False Accept wildcard characters: False ```
-Length
Cable length.
```yaml Type: Decimal Parameter Sets: (All) Aliases:
Required: False Position: 7 Default value: 0 Accept pipeline input: False Accept wildcard characters: False ```
-Length_Unit
Length unit: m, cm, ft, in.
```yaml Type: String Parameter Sets: (All) Aliases:
Required: False Position: 8 Default value: None Accept pipeline input: False Accept wildcard characters: False ```
-Description
Cable description.
```yaml Type: String Parameter Sets: (All) Aliases:
Required: False Position: 9 Default value: None Accept pipeline input: False Accept wildcard characters: False ```
-Comments
Additional comments.
```yaml Type: String Parameter Sets: (All) Aliases:
Required: False Position: 10 Default value: None Accept pipeline input: False Accept wildcard characters: False ```
-Tags
Array of tag names.
```yaml Type: String[] Parameter Sets: (All) Aliases:
Required: False Position: 11 Default value: None Accept pipeline input: False Accept wildcard characters: False ```
-Custom_Fields
Hashtable of custom field values.
```yaml Type: Hashtable Parameter Sets: (All) Aliases:
Required: False Position: 12 Default value: None Accept pipeline input: False Accept wildcard characters: False ```
-Cable_Profile
Cable profile for path tracing (Netbox 4.5+ only). Defines how connectors/lanes on one side map to those on the other side.
```yaml Type: String Parameter Sets: (All) Aliases: Profile
Required: False Position: 13 Default value: None Accept pipeline input: False Accept wildcard characters: False ```
-Raw
Return the raw API response.
```yaml 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.
```yaml 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.
```yaml 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 }}
```yaml 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