NetBox icon

NetBox

Consume NetBox API

Actions243

MAC Address → Update

AI-generated

Overview

This node interacts with the NetBox API to update a MAC Address record within the specified domain (default is DCIM). It allows users to modify details of an existing MAC Address by providing the MAC Address ID and the fields to update. This is useful in network management scenarios where MAC Address information needs to be kept current, such as updating the assigned object, status, description, or tags of a MAC Address.

Use Case Examples

  1. Updating the status of a MAC Address to 'Inactive' when a device is decommissioned.
  2. Changing the assigned object of a MAC Address to reflect a new device assignment.
  3. Adding or modifying tags and descriptions for better MAC Address identification and management.

Properties

Name Meaning
Domain Specifies the domain of the NetBox API to interact with, such as DCIM, IPAM, Tenancy, etc.
MAC Address ID The unique identifier of the MAC Address record to update.
Update Fields Collection of fields to update on the MAC Address record, including MAC Address, assigned object type and ID, status, description, tags, and custom fields.

Output

JSON

  • id - The unique identifier of the updated MAC Address record.
  • mac_address - The MAC address in the updated record.
  • assigned_object_type - The content type of the assigned object in the updated record.
  • assigned_object_id - The ID of the assigned object in the updated record.
  • status - The status of the MAC address (active or inactive) in the updated record.
  • description - Description of the MAC address in the updated record.
  • tags - Tags associated with the MAC address in the updated record.
  • custom_fields - Custom fields data in JSON format in the updated record.

Dependencies

  • NetBox API
  • An API key credential for authentication

Troubleshooting

  • Ensure the MAC Address ID provided is correct and exists in the NetBox instance to avoid 'record not found' errors.
  • Verify that the API key credential is valid and has sufficient permissions to update MAC Address records.
  • Check the format of the MAC Address field to ensure it follows the XX:XX:XX:XX:XX:XX format to prevent validation errors.
  • If the node throws an error, enabling 'Continue on Fail' will allow the workflow to proceed and output the error message for debugging.

Links

  • NetBox API Documentation - Official documentation for the NetBox API, useful for understanding available endpoints and data structures.

Discussion