NetBox icon

NetBox

Consume NetBox API

Actions243

Console Server Port → Get

AI-generated

Overview

This node interacts with the NetBox API to retrieve information about a specific Console Server Port within the DCIM domain. It is useful for network administrators or IT professionals who need to fetch detailed data about console server ports managed in NetBox, such as for monitoring or configuration purposes.

Use Case Examples

  1. Retrieve details of a Console Server Port by its ID to check its status or configuration.
  2. Use the node to integrate NetBox console server port data into an automation workflow for network management.

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 Server Port ID The unique identifier of the console server port to retrieve from NetBox.

Output

JSON

  • id - The unique identifier of the console server port record.
  • name - The name of the console server port.
  • description - Description or notes about the console server port.
  • status - Current status of the console server port.
  • device - Information about the device to which the console server port belongs.
  • connection_status - The connection status of the console server port.
  • created - Timestamp when the console server port record was created.
  • last_updated - Timestamp of the last update to the console server port record.

Dependencies

  • NetBox API with appropriate authentication credentials

Troubleshooting

  • Ensure the Console Server Port ID is correct 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 console server ports.
  • Check network connectivity to the NetBox API endpoint to prevent request failures.
  • If the node throws an error, enabling 'Continue on Fail' will allow the workflow to proceed and output the error message for debugging.

Links

Discussion