Overview

This node interacts with the NetBox API to retrieve multiple virtual link records from the DCIM domain. It is useful for users who want to fetch a list of virtual links with optional filtering, pagination, and limit controls. For example, a network administrator can use this node to get all virtual links or a subset based on specific criteria such as interface IDs, status, tenant ID, or creation date.

Use Case Examples

1. Retrieve all virtual links in the DCIM domain without limit.
2. Fetch up to 50 virtual links filtered by a specific interface ID and status.

Properties

Output

JSON

• id - Unique identifier of the virtual link.
• interface_a_id - Identifier of the first interface in the virtual link.
• interface_b_id - Identifier of the second interface in the virtual link.
• status - Current status of the virtual link.
• tenant_id - Identifier of the tenant associated with the virtual link.
• created - Timestamp when the virtual link was created.
• last_updated - Timestamp when the virtual link was last updated.

Dependencies

• NetBox API with an API key credential

Troubleshooting

• Common issues include authentication failures due to invalid or missing API credentials. Ensure the API key credential is correctly configured.
• Incorrect domain or resource selection can lead to no data being returned or errors. Verify that the domain is set to 'dcim' and resource to 'virtual-links' for this operation.
• Filters must be correctly formatted; invalid filter values may cause the API to reject the request.
• If 'Return All' is false and the limit is set too low, the user might not get all desired results. Adjust the limit or enable 'Return All' as needed.

Links

• NetBox API Documentation - Official documentation for the NetBox API, useful for understanding available endpoints and parameters.