Overview

This node interacts with the NetBox API to retrieve details of a specific Cable Termination within the DCIM domain. It is useful for network administrators or engineers who need to fetch detailed information about cable terminations in their network infrastructure managed by NetBox. For example, it can be used to get the status, connection details, or metadata of a cable termination by providing its unique ID.

Use Case Examples

1. Retrieve cable termination details by specifying the Cable Termination ID in the DCIM domain.
2. Use the node to automate network documentation by fetching cable termination data from NetBox.

Properties

Output

JSON

• id - The unique identifier of the cable termination record.
• name - The name or label of the cable termination.
• status - The current status of the cable termination.
• connected_endpoint - Details about the connected device or interface at the cable termination.
• cable - Information about the cable associated with the termination.
• position - Physical or logical position of the cable termination.
• description - Additional descriptive information about the cable termination.

Dependencies

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

Troubleshooting

• Ensure the Cable Termination ID is correct and exists in the NetBox instance to avoid 'not found' errors.
• Verify that the API key credential has sufficient permissions to read cable termination data.
• Check network connectivity to the NetBox API endpoint to prevent request failures.
• Common error messages include authentication failures, resource not found, or permission denied, which can be resolved by verifying credentials, IDs, and user permissions.

Links

• NetBox API Documentation - Cable Terminations - Official documentation for the Cable Terminations endpoint in the NetBox API.