Actions243
- Cable Actions
- Cable Termination Actions
- Connected Device Actions
- Console Port Actions
- Console Port Template Actions
- Console Server Port Actions
- Console Server Port Template Actions
- Device Actions
- Device Bay Actions
- Device Bay Template Actions
- Device Role Actions
- Device Type Actions
- Front Port Actions
- Front Port Template Actions
- Interface Actions
- Interface Template Actions
- Inventory Item Actions
- Inventory Item Role Actions
- Inventory Item Template Actions
- Location Actions
- MAC Address Actions
- Manufacturer Actions
- Module Actions
- Module Bay Actions
- Module Bay Template Actions
- Module Type Actions
- Module Type Profile Actions
- Platform Actions
- Power Feed Actions
- Power Outlet Actions
- Power Outlet Template Actions
- Power Panel Actions
- Power Port Actions
- Power Port Template Actions
- Rack Actions
- Rack Reservation Actions
- Rack Role Actions
- Rack Type Actions
- Rear Port Actions
- Rear Port Template Actions
- Region Actions
- Site Actions
- Site Group Actions
- Virtual Chassis Actions
- Virtual Device Context Actions
- Virtual Link Actions
Interface → Update
AI-generatedOverview
This node updates an existing interface record in the NetBox API under the DCIM domain. It is useful for network administrators who need to modify interface details such as device association, interface name, type, status, VLAN settings, and custom fields. For example, updating the MAC address or enabling/disabling an interface on a device.
Use Case Examples
- Updating the MAC address of a specific interface on a device.
- Changing the interface type from virtual to a physical type like 1000BASE-T.
- Enabling or disabling an interface.
- Modifying VLAN tagging and mode settings for an interface.
Properties
| Name | Meaning |
|---|---|
| Domain | Specifies the domain of the NetBox API to interact with, here it is 'dcim' for device and infrastructure management. |
| Interface ID | The unique identifier of the interface to update. |
| Update Fields | Collection of fields to update on the interface, including device ID, name, type, enabled status, LAG interface ID, MTU, MAC address, management-only flag, description, mode, VLAN settings, connection marking, tags, and custom fields. |
| ID | ID of the record, used in tenancy domain operations but not relevant for this interface update operation. |
Output
JSON
id- Unique identifier of the updated interface record.name- Name of the updated interface.type- Type of the updated interface.enabled- Whether the interface is enabled.device- ID of the device the interface belongs to.mac_address- MAC address of the interface.description- Description of the interface.mode- Mode of the interface for Layer 2 interfaces.untagged_vlan- ID of the untagged VLAN.tagged_vlans- List or string of tagged VLAN IDs.custom_fields- Custom fields associated with the interface.
Dependencies
- NetBox API
- An API key credential for authentication
Troubleshooting
- Common issues include invalid interface ID, insufficient permissions, or malformed update fields.
- Error messages may indicate missing required fields or invalid data types; ensure all required fields are correctly provided and formatted.
- Network connectivity issues to the NetBox API endpoint can cause failures; verify API endpoint accessibility and credentials.
Links
- NetBox API Documentation - Official documentation for the NetBox API, useful for understanding available resources and operations.