Actions88
- Module Actions
- Platform Actions
- Device Actions
- Device Bay Actions
- Device Bay Template Actions
- Device Role Actions
- Device Type Actions
- Interface Actions
- Manufacturer Actions
- Module Bay Actions
- Module Bay Template Actions
- Module Type Actions
- Region Actions
- Site Actions
- Virtual Chassis Actions
- Virtual Device Context Actions
Overview
This node integrates with the NetBox API, specifically allowing users to update an existing Interface resource within the DCIM domain. It is useful for network administrators and engineers who want to programmatically modify interface details such as device association, interface name, type, status, VLAN settings, and custom metadata.
Typical use cases include:
- Updating interface configurations after hardware changes.
- Automating network inventory updates.
- Managing interface properties in bulk workflows.
- Adjusting VLAN tagging or enabling/disabling interfaces remotely.
For example, you could update the MAC address and description of a specific interface on a device or change its operational mode (access/tagged) via this node.
Properties
| Name | Meaning |
|---|---|
| Domain | The NetBox API domain to target. Options: DCIM, IPAM, Tenancy, Extras, Virtualization, Circuits, Core, Users, Plugins, VPN, Wireless, Status. For this operation, must be "DCIM". |
| Interface ID | The unique identifier of the interface to update. |
| Update Fields | Collection of fields to update on the interface: |
| - Device ID | Numeric ID of the device the interface belongs to. |
| - Name | Name of the interface (string). |
| - Type | Interface type. Options include: Virtual, 1000BASE-T (1GE), 10GBASE-T (10GE), SFP (1GE), SFP+ (10GE), SFP28 (25GE), QSFP+ (40GE), QSFP28 (100GE), IEEE 802.11a/b/g/n/ac/ad/ax, Other. |
| - Enabled | Boolean indicating if the interface is enabled. |
| - LAG Interface ID | Numeric ID of the parent Link Aggregation Group (LAG) interface. |
| - MTU | Maximum Transmission Unit size (number). |
| - MAC Address | MAC address string of the interface. |
| - Management Only | Boolean indicating if the interface is used only for management purposes. |
| - Description | Text description of the interface. |
| - Mode | Interface mode for Layer 2 interfaces. Options: Access, Tagged, Tagged (All). |
| - Untagged VLAN ID | Numeric ID of the untagged VLAN. |
| - Tagged VLANs | Comma-separated list of tagged VLAN IDs. |
| - Mark Connected | Boolean to treat the interface as if a cable is connected. |
| - Tags | Comma-separated list of tags for categorization. |
| - Custom Fields | JSON object containing any custom fields defined for the interface. |
Output
The node outputs the updated interface data as JSON. This typically includes all the interface properties after the update has been applied, reflecting the current state in NetBox.
If an error occurs and "Continue on Fail" is enabled, the output will contain a JSON object with an error field describing the issue.
No binary data output is involved.
Dependencies
- Requires connection to a NetBox instance with appropriate API access.
- Needs an API authentication token configured in n8n credentials for the NetBox API.
- The node depends on internal helper functions to execute the API operation but no external npm packages beyond those bundled.
Troubleshooting
Common issues:
- Invalid or missing Interface ID will cause the update to fail.
- Insufficient permissions or invalid API token can result in authorization errors.
- Providing invalid values for fields like VLAN IDs or MAC address format may cause validation errors from the API.
- Network connectivity issues to the NetBox server will prevent execution.
Error messages:
"error": "Interface not found"indicates the specified Interface ID does not exist."error": "Unauthorized"means the API token is invalid or lacks required permissions.- Validation errors will specify which field is incorrect; ensure all inputs conform to expected formats.
To resolve errors, verify the Interface ID, check API credentials, and confirm input data validity.