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
Device → Update
AI-generatedOverview
This node updates a device record in the NetBox API under the DCIM domain. It is useful for scenarios where you need to modify existing device information such as name, device type, site, status, role, tenant, platform, serial number, asset tag, location, rack, position, face, IP addresses, cluster, virtual chassis, comments, tags, and custom fields. For example, updating the status of a device to 'active' or changing its rack position.
Use Case Examples
- Updating the status of a device to 'active' after maintenance.
- Changing the rack position and face of a device in a data center.
- Adding custom fields or tags to a device for better categorization.
Properties
| Name | Meaning |
|---|---|
| Domain | Specifies the domain of the NetBox API to use, here it is 'dcim' for device management. |
| Device ID | The unique identifier of the device to update. |
| Update Fields | Collection of fields to update on the device, including name, device type ID, site ID, status, role ID, tenant ID, platform ID, serial number, asset tag, location ID, rack ID, position, face, primary IPv4 and IPv6 IDs, cluster ID, virtual chassis ID, virtual chassis position and priority, comments, tags, and custom fields. |
Output
JSON
id- The unique identifier of the updated device.name- The name of the updated device.status- The status of the updated device.device_type- The device type ID of the updated device.site- The site ID of the updated device.role- The role ID of the updated device.tenant- The tenant ID of the updated device.platform- The platform ID of the updated device.serial- The serial number of the updated device.asset_tag- The asset tag of the updated device.location- The location ID of the updated device.rack- The rack ID of the updated device.position- The position in the rack of the updated device.face- The mounting face of the updated device.primary_ip4- The primary IPv4 address ID of the updated device.primary_ip6- The primary IPv6 address ID of the updated device.cluster- The cluster ID of the updated device.virtual_chassis- The virtual chassis ID of the updated device.vc_position- The position in the virtual chassis of the updated device.vc_priority- The priority in the virtual chassis of the updated device.comments- Comments associated with the updated device.tags- Tags associated with the updated device.custom_fields- Custom fields associated with the updated device.
Dependencies
- NetBox API with appropriate credentials
Troubleshooting
- Common issues include invalid device ID, missing required fields, or incorrect domain/resource selection.
- Error messages may indicate authentication failures, invalid input data, or network connectivity problems.
- Ensure the device ID exists and the API credentials are valid.
- Verify that the update fields conform to the expected data types and constraints.
Links
- NetBox API Documentation - Official documentation for the NetBox API endpoints and usage.