Actions88
- Module Actions
- Platform Actions
- Device Actions
- Device Bay Actions
- Device Bay Template Actions
- Device Role Actions
- Device Type Actions
- Interface Actions
- Manufacturer Actions
- Module Bay Actions
- Module Bay Template Actions
- Module Type Actions
- Region Actions
- Site Actions
- Virtual Chassis Actions
- Virtual Device Context Actions
Overview
This node integrates with the NetBox API, specifically targeting the "Device" resource to retrieve console port information. It is designed to fetch console port details associated with devices managed in NetBox, a popular infrastructure resource modeling tool. This node is useful in scenarios where network engineers or IT administrators want to automate the retrieval of console port data for inventory, auditing, or configuration management purposes.
Practical examples include:
- Automatically gathering console port details for all devices in a specific site or rack.
- Integrating console port information into a CMDB or network documentation system.
- Triggering workflows based on console port status or availability.
Properties
| Name | Meaning |
|---|---|
| Domain | The domain of the NetBox API to interact with. Options: DCIM, IPAM, Tenancy, Extras, Virtualization, Circuits, Core, Users, Plugins, VPN, Wireless, Status. For this operation, "DCIM" is relevant. |
| Return All | Boolean flag indicating whether to return all results or limit the number of returned items. |
| Limit | Maximum number of results to return when "Return All" is false. Minimum value is 1. |
Output
The node outputs JSON data representing the console ports retrieved from NetBox for the specified device(s). Each item in the output corresponds to a console port object as defined by the NetBox API, typically including fields such as port name, type, status, and associated device information.
If binary data were involved (not indicated here), it would represent attachments or files related to the console ports, but this node focuses on JSON data only.
Dependencies
- Requires an API key credential for authenticating with the NetBox API.
- Needs the NetBox instance URL configured within the credential or node settings.
- The node depends on the internal helper function
executeOperationto perform the API call; this abstracts the HTTP request logic.
Troubleshooting
Common Issues:
- Authentication failures due to invalid or missing API keys.
- Network connectivity problems reaching the NetBox server.
- Incorrect domain or resource selections causing no data to be returned.
- Exceeding API rate limits if requesting too many records without pagination.
Error Messages:
- Errors thrown during execution are logged and, if "Continue On Fail" is enabled, returned as part of the node output.
- Typical error messages may include authentication errors, HTTP errors (404, 500), or JSON parsing issues.
Resolutions:
- Verify API credentials and permissions.
- Check network access to the NetBox server.
- Adjust "Return All" and "Limit" properties to manage result size.
- Enable "Continue On Fail" to handle errors gracefully in workflows.