NetBox icon

NetBox

Consume NetBox API

Actions243

Rear Port → Get

AI-generated

Overview

This node interacts with the NetBox API to retrieve information about a specific Rear Port resource within the DCIM domain. It is useful for scenarios where users need to fetch detailed data about rear ports of devices managed in NetBox, such as for inventory management, network documentation, or integration with other systems.

Use Case Examples

  1. Retrieve details of a rear port by its ID to display or process in an automation workflow.
  2. Fetch rear port information to verify device connectivity or configuration in a network management system.

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.
ID The unique identifier of the rear port record to retrieve from NetBox.

Output

JSON

  • id - The unique identifier of the rear port.
  • name - The name of the rear port.
  • device - The device to which the rear port belongs.
  • type - The type of rear port.
  • description - Description of the rear port.
  • status - Current status of the rear port.
  • connected_endpoint - Information about the connected endpoint if any.

Dependencies

  • NetBox API with appropriate credentials

Troubleshooting

  • Ensure the rearPortId is correctly provided and exists in the NetBox instance to avoid 'not found' errors.
  • Verify that the API credentials have sufficient permissions to access the DCIM domain and rear ports resource.
  • Check network connectivity to the NetBox API endpoint to prevent request failures.
  • If the node throws an error, enabling 'Continue on Fail' can help capture the error message in the output for debugging.

Links

Discussion