NetBox icon

NetBox

Consume NetBox API

Actions243

MAC Address → List

AI-generated

Overview

This node interacts with the NetBox API to list MAC Address resources within the DCIM domain. It allows users to retrieve MAC address data with optional filtering and pagination controls. This is useful for network administrators who want to query and manage MAC address information programmatically from NetBox.

Use Case Examples

  1. Retrieve all MAC addresses in the DCIM domain.
  2. List MAC addresses filtered by a specific MAC address or assigned object type.
  3. Limit the number of MAC addresses returned to a specific count for pagination.

Properties

Name Meaning
Domain Specifies the domain of the NetBox API to use, here it is fixed to 'dcim' for MAC addresses.
Return All Determines whether to return all results or limit the number of results.
Limit Maximum number of MAC address results to return when 'Return All' is false.
Filters Collection of optional filters to narrow down the MAC address results, including search query, MAC address, assigned object type and ID, status, ID, ordering, and date filters.

Output

JSON

  • id - Unique identifier of the MAC address record.
  • mac_address - The MAC address value.
  • assigned_object_type - Type of the object the MAC address is assigned to.
  • assigned_object_id - ID of the assigned object.
  • status - Status of the MAC address (active or inactive).
  • created - Timestamp when the MAC address record was created.
  • last_updated - Timestamp when the MAC address record was last updated.

Dependencies

  • NetBox API with appropriate credentials

Troubleshooting

  • Common issues include authentication failures due to invalid or missing API credentials. Ensure the NetBox API key is correctly configured.
  • Incorrect domain or resource selection can cause the node to fail or return no data. Verify the domain is set to 'dcim' and resource to 'mac-addresses' for this operation.
  • Filters must be correctly formatted; invalid filter values may cause errors or empty results.
  • If 'Return All' is false and limit is set too low, the user might not see all expected results. Adjust the limit or enable 'Return All'.

Links

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

Discussion