Overview

This node interacts with the NetBox API to retrieve details of a specific Console Port Template within the DCIM domain. It is useful for network administrators or automation workflows that need to fetch configuration templates for console ports in a data center infrastructure management system. For example, it can be used to automate inventory management or configuration auditing by fetching template details based on a given Console Port Template ID.

Use Case Examples

1. Retrieve a Console Port Template by its ID to verify its configuration before applying it to devices.
2. Fetch Console Port Template details as part of an automated network documentation process.

Properties

Output

JSON

• id - The unique identifier of the console port template.
• name - The name of the console port template.
• description - Description of the console port template.
• type - Type of the console port template.
• status - Current status of the console port template.
• created - Timestamp when the console port template was created.
• last_updated - Timestamp of the last update to the console port template.

Dependencies

• NetBox API access with appropriate credentials

Troubleshooting

• Ensure the Console Port Template ID is correct and exists in the NetBox instance to avoid 'not found' errors.
• Verify that the API credentials have sufficient permissions to read console port templates.
• If the node throws an error, check network connectivity to the NetBox API endpoint.
• Enable 'Continue on Fail' option to handle errors gracefully and receive error details in the output.

Links

• NetBox API Documentation for Console Port Templates - Official documentation for the Console Port Templates endpoint in the NetBox API.