Skip to content

Set-NBDCIMInterface

Since

v1.0.4

SYNOPSIS

Updates an existing DCIM Interface in Netbox DCIM module.

SYNTAX

Set-NBDCIMInterface [-Id] <UInt64> [[-Device] <UInt64>] [[-Name] <String>] [[-Enabled] <Boolean>] [[-Type] <String>] [[-Label] <String>] [[-Parent] <UInt64>] [[-Bridge] <UInt64>] [[-Speed] <UInt64>] [[-Duplex] <String>] [[-Mark_Connected] <Boolean>] [[-WWN] <String>] [[-VDCS] <UInt64[]>] [[-POE_Mode] <String>] [[-POE_Type] <String>] [[-Vlan_Group] <UInt64>] [[-QinQ_SVLAN] <UInt64>] [[-VRF] <UInt64>] [[-RF_Role] <String>] [[-RF_Channel] <String>] [[-RF_Channel_Frequency] <Int32>] [[-RF_Channel_Width] <Int32>] [[-TX_Power] <Int32>] [[-Primary_MAC_Address] <UInt64>] [[-Owner] <UInt64>] [[-Changelog_Message] <String>] [[-MTU] <UInt16>] [[-MAC_Address] <String>] [[-MGMT_Only] <Boolean>] [[-LAG] <UInt64>] [[-Description] <String>] [[-Mode] <String>] [[-Untagged_VLAN] <UInt64>] [[-Tagged_VLANs] <UInt64[]>] [-Force] [[-Tags] <Object[]>] [-Raw] [-ProgressAction <ActionPreference>] [-WhatIf] [-Confirm] [<CommonParameters>]

DESCRIPTION

Updates an existing DCIM Interface in Netbox DCIM module. Supports pipeline input for Id parameter where applicable.

EXAMPLES

EXAMPLE 1

Set-NBDCIMInterface -Id 42 -Name "eth0-renamed"

Renames an existing interface.

EXAMPLE 2

Set-NBDCIMInterface -Id 42 -Parent $null

Clears the parent interface association (sets parent to null via PATCH).

PARAMETERS

-Id

The database ID of the interface 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 ```

-Device

The database ID of the device this interface belongs to.

```yaml Type: UInt64 Parameter Sets: (All) Aliases:

Required: False Position: 2 Default value: 0 Accept pipeline input: False Accept wildcard characters: False ```

-Name

The name of the interface (e.g., 'eth0', 'GigabitEthernet0/1').

```yaml Type: String Parameter Sets: (All) Aliases:

Required: False Position: 3 Default value: None Accept pipeline input: False Accept wildcard characters: False ```

-Enabled

Whether the interface is enabled.

```yaml Type: Boolean Parameter Sets: (All) Aliases:

Required: False Position: 4 Default value: False Accept pipeline input: False Accept wildcard characters: False ```

-Type

The interface type. Supports physical types (1000base-t, 10gbase-x-sfpp, etc.), virtual types (virtual, bridge, lag), and wireless types (ieee802.11ac, etc.).

```yaml Type: String Parameter Sets: (All) Aliases:

Required: False Position: 5 Default value: None Accept pipeline input: False Accept wildcard characters: False ```

-Label

Physical label assigned to the interface.

```yaml Type: String Parameter Sets: (All) Aliases:

Required: False Position: 6 Default value: None Accept pipeline input: False Accept wildcard characters: False ```

-Parent

Numeric ID of the parent interface (for subinterfaces). Pass $null to clear.

```yaml Type: UInt64 Parameter Sets: (All) Aliases:

Required: False Position: 7 Default value: None Accept pipeline input: False Accept wildcard characters: False ```

-Bridge

Numeric ID of the bridge this interface belongs to. Pass $null to clear.

```yaml Type: UInt64 Parameter Sets: (All) Aliases:

Required: False Position: 8 Default value: None Accept pipeline input: False Accept wildcard characters: False ```

-Speed

Speed of the interface in Kbps (e.g., 1000000 for 1Gbps). Pass $null to clear.

```yaml Type: UInt64 Parameter Sets: (All) Aliases:

Required: False Position: 9 Default value: None Accept pipeline input: False Accept wildcard characters: False ```

-Duplex

Duplex mode. One of: 'full', 'half', 'auto'.

```yaml Type: String Parameter Sets: (All) Aliases:

Required: False Position: 10 Default value: None Accept pipeline input: False Accept wildcard characters: False ```

-Mark_Connected

If $true, the interface is marked as connected independent of cable state.

```yaml Type: Boolean Parameter Sets: (All) Aliases:

Required: False Position: 11 Default value: False Accept pipeline input: False Accept wildcard characters: False ```

-WWN

World Wide Name for Fibre Channel interfaces (8 groups of 2 hex digits, colon-separated, e.g. 'AA:BB:CC:DD:EE:FF:00:11').

```yaml Type: String Parameter Sets: (All) Aliases:

Required: False Position: 12 Default value: None Accept pipeline input: False Accept wildcard characters: False ```

-VDCS

Array of Virtual Device Context numeric IDs.

```yaml Type: UInt64[] Parameter Sets: (All) Aliases:

Required: False Position: 13 Default value: None Accept pipeline input: False Accept wildcard characters: False ```

-POE_Mode

Power-over-Ethernet mode. One of: 'pd', 'pse'.

```yaml Type: String Parameter Sets: (All) Aliases:

Required: False Position: 14 Default value: None Accept pipeline input: False Accept wildcard characters: False ```

-POE_Type

Power-over-Ethernet type. One of: 'type1-ieee802.3af', 'type2-ieee802.3at', 'type3-ieee802.3bt', 'type4-ieee802.3bt', 'passive-24v-2pair', 'passive-24v-4pair', 'passive-48v-2pair', 'passive-48v-4pair'.

```yaml Type: String Parameter Sets: (All) Aliases:

Required: False Position: 15 Default value: None Accept pipeline input: False Accept wildcard characters: False ```

-Vlan_Group

Numeric ID of the VLAN group this interface belongs to.

```yaml Type: UInt64 Parameter Sets: (All) Aliases:

Required: False Position: 16 Default value: 0 Accept pipeline input: False Accept wildcard characters: False ```

-QinQ_SVLAN

Numeric ID of the Service VLAN for QinQ. Pass $null to clear.

```yaml Type: UInt64 Parameter Sets: (All) Aliases:

Required: False Position: 17 Default value: None Accept pipeline input: False Accept wildcard characters: False ```

-VRF

Numeric ID of the VRF this interface belongs to.

```yaml Type: UInt64 Parameter Sets: (All) Aliases:

Required: False Position: 18 Default value: 0 Accept pipeline input: False Accept wildcard characters: False ```

-RF_Role

Wireless RF role. One of: 'ap', 'station'.

```yaml Type: String Parameter Sets: (All) Aliases:

Required: False Position: 19 Default value: None Accept pipeline input: False Accept wildcard characters: False ```

-RF_Channel

Wireless RF channel identifier (e.g. '2.4g-1-2412-22').

```yaml Type: String Parameter Sets: (All) Aliases:

Required: False Position: 20 Default value: None Accept pipeline input: False Accept wildcard characters: False ```

-RF_Channel_Frequency

Wireless RF channel frequency in MHz (1-1000000). Pass $null to clear.

```yaml Type: Int32 Parameter Sets: (All) Aliases:

Required: False Position: 21 Default value: None Accept pipeline input: False Accept wildcard characters: False ```

-RF_Channel_Width

Wireless RF channel width in MHz (1-10000). Pass $null to clear.

```yaml Type: Int32 Parameter Sets: (All) Aliases:

Required: False Position: 22 Default value: None Accept pipeline input: False Accept wildcard characters: False ```

-TX_Power

Wireless transmit power in dBm. Pass $null to clear.

```yaml Type: Int32 Parameter Sets: (All) Aliases:

Required: False Position: 23 Default value: None Accept pipeline input: False Accept wildcard characters: False ```

-Primary_MAC_Address

Numeric ID of the primary MAC address record. Pass $null to clear.

```yaml Type: UInt64 Parameter Sets: (All) Aliases:

Required: False Position: 24 Default value: None Accept pipeline input: False Accept wildcard characters: False ```

-Owner

Numeric ID of the owning user or team. Pass $null to clear.

```yaml Type: UInt64 Parameter Sets: (All) Aliases:

Required: False Position: 25 Default value: None Accept pipeline input: False Accept wildcard characters: False ```

-Changelog_Message

Free-form message recorded in the Netbox changelog entry for this operation.

```yaml Type: String Parameter Sets: (All) Aliases:

Required: False Position: 26 Default value: None Accept pipeline input: False Accept wildcard characters: False ```

-MTU

Maximum Transmission Unit size (typically 1500 for Ethernet).

```yaml Type: UInt16 Parameter Sets: (All) Aliases:

Required: False Position: 27 Default value: 0 Accept pipeline input: False Accept wildcard characters: False ```

-MAC_Address

The MAC address of the interface in format XX:XX:XX:XX:XX:XX.

```yaml Type: String Parameter Sets: (All) Aliases:

Required: False Position: 28 Default value: None Accept pipeline input: False Accept wildcard characters: False ```

-MGMT_Only

If true, this interface is used for management traffic only.

```yaml Type: Boolean Parameter Sets: (All) Aliases:

Required: False Position: 29 Default value: False Accept pipeline input: False Accept wildcard characters: False ```

-LAG

The database ID of the LAG interface this interface belongs to.

```yaml Type: UInt64 Parameter Sets: (All) Aliases:

Required: False Position: 30 Default value: 0 Accept pipeline input: False Accept wildcard characters: False ```

-Description

A description of the interface.

```yaml Type: String Parameter Sets: (All) Aliases:

Required: False Position: 31 Default value: None Accept pipeline input: False Accept wildcard characters: False ```

-Mode

VLAN mode: 'Access' (untagged), 'Tagged' (trunk), or 'Tagged All'.

```yaml Type: String Parameter Sets: (All) Aliases:

Required: False Position: 32 Default value: None Accept pipeline input: False Accept wildcard characters: False ```

-Untagged_VLAN

The database ID of the VLAN object for the untagged/native VLAN.

```yaml Type: UInt64 Parameter Sets: (All) Aliases:

Required: False Position: 33 Default value: 0 Accept pipeline input: False Accept wildcard characters: False ```

-Tagged_VLANs

Array of database IDs of VLAN objects for tagged VLANs.

```yaml Type: UInt64[] Parameter Sets: (All) Aliases:

Required: False Position: 34 Default value: None Accept pipeline input: False Accept wildcard characters: False ```

-Force

{{ Fill Force Description }}

```yaml Type: SwitchParameter Parameter Sets: (All) Aliases:

Required: False Position: Named Default value: False Accept pipeline input: False Accept wildcard characters: False ```

-Tags

Array of tag objects (e.g. PSCustomObject with slug and color properties).

```yaml Type: Object[] Parameter Sets: (All) Aliases:

Required: False Position: 35 Default value: None Accept pipeline input: False Accept wildcard characters: False ```

-Raw

Return the raw API response instead of the results array.

```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: v1.0.4

Common parameters

common request params

https://netbox.readthedocs.io/en/stable/models/dcim/interface/