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 → List
AI-generatedOverview
This node interacts with the NetBox API to list network interfaces within the DCIM domain. It allows users to retrieve interface data with optional filtering and pagination controls. This is useful for network administrators who want to automate the retrieval of interface details such as interface ID, name, device association, type, status, and other attributes from their NetBox instance.
Use Case Examples
- Retrieve all interfaces for a specific device to audit network connections.
- List interfaces filtered by type or enabled status to monitor network hardware.
- Fetch a limited number of interfaces for quick overview or reporting purposes.
Properties
| Name | Meaning |
|---|---|
| Domain | Specifies the domain of the NetBox API to use, here it is set to 'dcim' for data center infrastructure management. |
| Resource | Specifies the resource to consume from the NetBox API, here it is 'interfaces'. |
| Operation | The operation to perform on the resource, here it is 'list' to retrieve multiple interface records. |
| Return All | Boolean flag to determine whether to return all results or limit the number of results. |
| Limit | Maximum number of interface records to return when 'Return All' is false. |
| Filters | Collection of optional filters to narrow down the list of interfaces based on various attributes such as interface ID, name, device name or ID, type, enabled status, MAC address, VLAN, connection status, kind, and tags. |
Output
JSON
id- Unique identifier of the interface.name- Name of the interface.device- Device associated with the interface.type- Type of the interface.enabled- Whether the interface is enabled.mac_address- MAC address of the interface.vlan_id- ID of the VLAN assigned to the interface.connected- Connection status of the interface.kind- Kind of interface (physical, virtual, wireless).tag- Tags associated with the interface.
Dependencies
- NetBox API
- An API key credential for authentication
Troubleshooting
- Common issues include authentication failures due to invalid or missing API credentials. Ensure the API key credential is correctly configured.
- Filters may not return expected results if filter values are incorrect or do not match existing data in NetBox.
- If 'Return All' is set to false and the limit is too low, not all desired interfaces may be retrieved. Adjust the limit accordingly.
- Network or API endpoint connectivity issues can cause request failures. Verify network access to the NetBox API endpoint.
Links
- NetBox API Documentation - Official documentation for the NetBox API, useful for understanding available endpoints and data structures.