New-NBDCIMCable
Since
v4.4.10.0
SYNOPSIS
Creates a new cable in Netbox DCIM module.
SYNTAX
New-NBDCIMCable [-A_Terminations] <Object[]> [-B_Terminations] <Object[]> [[-Type] <String>]
[[-Status] <String>] [[-Tenant] <UInt64>] [[-Label] <String>] [[-Color] <String>] [[-Length] <Decimal>]
[[-Length_Unit] <String>] [[-Description] <String>] [[-Comments] <String>] [[-Tags] <Object[]>]
[[-Custom_Fields] <Hashtable>] [[-Cable_Profile] <String>] [-Raw] [-ProgressAction <ActionPreference>]
[-WhatIf] [-Confirm] [<CommonParameters>]
DESCRIPTION
Creates a new cable connecting two termination points in Netbox. Supports connecting interfaces, console ports, power ports, etc.
EXAMPLES
EXAMPLE 1
$termA = @{ object_type = 'dcim.interface'; object_id = 1 }
$termB = @{ object_type = 'dcim.interface'; object_id = 2 }
New-NBDCIMCable -A_Terminations @($termA) -B_Terminations @($termB)
EXAMPLE 2
# Connect two interfaces by ID using helper
New-NBDCIMCable -A_Terminations @(@{object_type='dcim.interface';object_id=10}) `
-B_Terminations @(@{object_type='dcim.interface';object_id=20}) `
-Type 'cat6' -Status 'connected' -Label 'Patch-001'
PARAMETERS
-A_Terminations
Array of termination objects for the A side. Each object should have: - object_type: The type (e.g., 'dcim.interface', 'dcim.consoleport') - object_id: The ID of the object
Type: Object[]
Parameter Sets: (All)
Aliases:
Required: True
Position: 1
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
-B_Terminations
Array of termination objects for the B side. Same format as A_Terminations.
Type: Object[]
Parameter Sets: (All)
Aliases:
Required: True
Position: 2
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
-Type
Cable type (e.g., 'cat5', 'cat5e', 'cat6', 'cat6a', 'cat7', 'cat7a', 'cat8', 'dac-active', 'dac-passive', 'mrj21-trunk', 'coaxial', 'mmf', 'mmf-om1', 'mmf-om2', 'mmf-om3', 'mmf-om4', 'mmf-om5', 'smf', 'smf-os1', 'smf-os2', 'aoc', 'power')
Type: String
Parameter Sets: (All)
Aliases:
Required: False
Position: 3
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
-Status
Cable status: 'connected', 'planned', 'decommissioning'
Type: String
Parameter Sets: (All)
Aliases:
Required: False
Position: 4
Default value: Connected
Accept pipeline input: False
Accept wildcard characters: False
-Tenant
Tenant ID
Type: UInt64
Parameter Sets: (All)
Aliases:
Required: False
Position: 5
Default value: 0
Accept pipeline input: False
Accept wildcard characters: False
-Label
Cable label
Type: String
Parameter Sets: (All)
Aliases:
Required: False
Position: 6
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
-Color
Cable color (hex code without #)
Type: String
Parameter Sets: (All)
Aliases:
Required: False
Position: 7
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
-Length
Cable length
Type: Decimal
Parameter Sets: (All)
Aliases:
Required: False
Position: 8
Default value: 0
Accept pipeline input: False
Accept wildcard characters: False
-Length_Unit
Length unit: 'm', 'cm', 'ft', 'in'
Type: String
Parameter Sets: (All)
Aliases:
Required: False
Position: 9
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
-Description
Cable description
Type: String
Parameter Sets: (All)
Aliases:
Required: False
Position: 10
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
-Comments
Additional comments
Type: String
Parameter Sets: (All)
Aliases:
Required: False
Position: 11
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
-Tags
Array of tag names or IDs
Type: Object[]
Parameter Sets: (All)
Aliases:
Required: False
Position: 12
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
-Custom_Fields
Hashtable of custom field values
Type: Hashtable
Parameter Sets: (All)
Aliases:
Required: False
Position: 13
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. Available profiles: - Single: 1c1p, 1c2p, 1c4p, 1c6p, 1c8p, 1c12p, 1c16p - Trunk: 2c1p, 2c2p, 2c4p, 2c4p-shuffle, 2c6p, 2c8p, 2c12p, 4c1p, 4c2p, 4c4p, 4c4p-shuffle, 4c6p, 4c8p, 8c4p - Breakout: 1c4p-4c1p, 1c6p-6c1p, 2c4p-8c1p-shuffle
Type: String
Parameter Sets: (All)
Aliases: Profile
Required: False
Position: 14
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
-Raw
Return the raw API response
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