Overview

This node interacts with the NetBox API to retrieve information about a specific Virtual Link resource. It is useful in scenarios where users need to fetch detailed data about virtual links within their network infrastructure managed by NetBox, such as for network monitoring, auditing, or integration with other systems.

Use Case Examples

1. Retrieve details of a virtual link by its ID to display its configuration in a network management dashboard.
2. Fetch virtual link information to automate network documentation or reporting processes.

Properties

Output

JSON

• id - The unique identifier of the virtual link.
• name - The name of the virtual link.
• status - The current status of the virtual link.
• type - The type/category of the virtual link.
• description - A textual description of the virtual link.
• connected_devices - Details about devices connected by the virtual link.
• created_at - Timestamp when the virtual link was created.
• updated_at - Timestamp when the virtual link was last updated.

Dependencies

• NetBox API
• An API key credential for authentication

Troubleshooting

• Ensure the provided Virtual Link ID is correct and exists in the NetBox instance to avoid 'not found' errors.
• Verify that the API key credential has sufficient permissions to access the Virtual Link resource.
• Check network connectivity to the NetBox API endpoint to prevent request failures.
• If the node throws authentication errors, confirm that the API key is valid and not expired.

Links

• NetBox Virtual Link API Documentation - Official documentation for the Virtual Link resource in the NetBox API.