Overview

This node interacts with the NetBox API to create a Virtual Link resource within the DCIM domain. It is useful for network administrators and engineers who want to automate the creation of virtual links between interfaces in their network infrastructure. For example, it can be used to programmatically link two network interfaces by specifying their IDs and additional optional details such as status, tenant, description, tags, and custom fields.

Use Case Examples

1. Creating a virtual link between two interfaces in a data center to represent a logical connection.
2. Automating network documentation by adding virtual links with metadata like status and tenant information.

Properties

Output

JSON

• id - The unique identifier of the created virtual link.
• interface_a_id - The ID of the first interface in the created virtual link.
• interface_b_id - The ID of the second interface in the created virtual link.
• status - The status of the virtual link.
• tenant - The tenant associated with the virtual link.
• description - Description of the virtual link.
• tags - Tags associated with the virtual link.
• custom_fields - Custom fields metadata of the virtual link.

Dependencies

• NetBox API
• An API key credential for authentication

Troubleshooting

• Ensure the Interface A ID and Interface B ID are valid and exist in the NetBox instance.
• Verify that the API key credential is correctly configured and has permissions to create virtual links.
• Check that the domain is set to 'dcim' as the virtual link resource is under this domain.
• Common error messages may include authentication errors, invalid interface IDs, or missing required fields. Resolving these involves verifying credentials, input values, and required parameters.

Links

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