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 → Get Interfaces
AI-generatedOverview
This node interacts with the NetBox API to retrieve interface information for devices within the specified domain (default is DCIM). It is useful for network administrators or IT professionals who need to programmatically access detailed interface data of devices managed in NetBox. For example, it can be used to fetch all interfaces of a particular device for inventory, monitoring, or configuration purposes.
Use Case Examples
- Fetch all interfaces of a device in the DCIM domain to audit network connections.
- Retrieve interface details to integrate with a network monitoring system.
Properties
| Name | Meaning |
|---|---|
| Domain | Specifies the domain of the NetBox API to target, such as DCIM, IPAM, Tenancy, etc. |
| Return All | Determines whether to return all interface results or limit the number of results. |
| Limit | Maximum number of interface results to return when 'Return All' is false. |
Output
JSON
interfaces- Array of interface objects retrieved from the NetBox API for the specified device.
Dependencies
- NetBox API with appropriate credentials
Troubleshooting
- Common issues include authentication failures due to invalid or missing API credentials. Ensure the API key credential is correctly configured.
- Network connectivity issues to the NetBox server can cause request failures; verify network access and endpoint URL.
- If the node returns an error, check if the specified domain and resource are valid and supported by the NetBox instance.
- Errors related to limits or pagination may occur if 'Return All' is false and the limit is set too low; adjust the limit accordingly.
Links
- NetBox API Documentation - Official documentation for the NetBox API endpoints and usage.