NetBox icon

NetBox

Consume NetBox API

Actions243

Console Port → Get

AI-generated

Overview

This node interacts with the NetBox API to retrieve information about a specific Console Port within the DCIM domain. It is useful for network administrators or IT professionals who need to fetch detailed data about console ports in their infrastructure for monitoring, auditing, or integration purposes. For example, it can be used to get the status, configuration, or connection details of a console port by providing its unique ID.

Use Case Examples

  1. Retrieve details of a console port by specifying its Console Port ID in the DCIM domain.
  2. Use the node to automate inventory management by fetching console port data from NetBox.

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.
Console Port ID The unique identifier of the console port to retrieve information for. This is required to specify which console port record to get.

Output

JSON

  • id - The unique identifier of the console port record retrieved.
  • name - The name or label of the console port.
  • status - The current status of the console port.
  • device - Information about the device to which the console port is connected.
  • description - Description or notes about the console port.

Dependencies

  • NetBox API
  • An API key credential for authenticating with the NetBox API

Troubleshooting

  • Ensure the Console Port ID is correct and exists in the NetBox instance to avoid 'not found' errors.
  • Verify that the API key credential is valid and has sufficient permissions to access the DCIM domain and console ports.
  • Check network connectivity to the NetBox API endpoint to prevent connection errors.
  • If the node throws an error, enabling 'Continue on Fail' will allow the workflow to proceed and output the error message as JSON.

Discussion