Overview

This node updates a Virtual Link resource in the NetBox API within the DCIM domain. It is useful for network administrators or automation engineers who need to programmatically modify virtual link details such as interface IDs, status, tenant association, description, tags, and custom fields. For example, it can be used to update the status of a virtual link from 'planned' to 'active' or to assign a tenant ID to a virtual link.

Use Case Examples

1. Updating the status and description of a virtual link identified by its ID.
2. Assigning a tenant ID and adding tags to a virtual link.

Properties

Output

JSON

• id - The unique identifier of the updated virtual link.
• interface_a - ID of the first interface in the updated virtual link.
• interface_b - ID of the second interface in the updated virtual link.
• status - The updated status of the virtual link.
• tenant - The tenant ID associated with the updated virtual link.
• description - The updated description of the virtual link.
• tags - Tags associated with the updated virtual link.
• custom_fields - Custom fields data of the updated virtual link.

Dependencies

• NetBox API with appropriate credentials for authentication

Troubleshooting

• Common issues include providing an invalid virtual link ID, which results in a 'not found' error from the API.
• Incorrectly formatted custom fields JSON can cause update failures.
• Lack of proper API credentials or permissions will result in authentication or authorization errors.

Links

• NetBox API Documentation for Virtual Links - Official documentation for managing virtual links via the NetBox API.