NetBox icon

NetBox

Consume NetBox API

Actions243

Rear Port → Get Many

AI-generated

Overview

This node interacts with the NetBox API to retrieve multiple rear port records within the DCIM domain. It is useful for scenarios where users need to fetch a list of rear ports from their network infrastructure managed in NetBox, such as for inventory management, auditing, or integration with other systems.

Use Case Examples

  1. Fetching all rear ports for a specific device to analyze port usage.
  2. Retrieving a limited number of rear ports with specific filters like device ID or type for reporting purposes.

Properties

Name Meaning
Domain Specifies the domain of the NetBox API to interact with, here it is set to 'dcim' for data center infrastructure management.
Return All Determines whether to return all rear port results or limit the number of results.
Limit Maximum number of rear port results to return when 'Return All' is false.
Filters Collection of optional filters to narrow down the rear ports retrieved, such as device ID, module ID, name, label, type, positions, mark connected status, search query, ID, ordering, creation date, and last updated date.

Output

JSON

  • id - Unique identifier of the rear port.
  • name - Name of the rear port.
  • label - Label of the rear port.
  • type - Type of the rear port.
  • device_id - Identifier of the device associated with the rear port.
  • module_id - Identifier of the module associated with the rear port.
  • positions - Number of positions of the rear port.
  • mark_connected - Connection status of the rear port.
  • created - Creation timestamp of the rear port record.
  • last_updated - Last updated timestamp of the rear port record.

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.
  • Incorrect domain or resource selection may lead to no data returned or errors. Verify the domain is set to 'dcim' and resource to 'rear-ports' for this operation.
  • Filters with incorrect data types or invalid values may cause the API to reject the request. Validate filter inputs before execution.
  • If the node throws errors, enabling 'Continue on Fail' allows the workflow to proceed and outputs the error message for debugging.

Links

Discussion