NetBox icon

NetBox

Consume NetBox API

Actions243

Virtual Link → Delete

AI-generated

Overview

This node interacts with the NetBox API to delete a Virtual Link resource within a specified domain. It is useful for automating the removal of virtual link records in network infrastructure management scenarios, such as cleaning up obsolete or incorrect virtual link entries in NetBox.

Use Case Examples

  1. Deleting a virtual link by specifying its ID and domain to maintain accurate network topology data.
  2. Automating network cleanup tasks by removing virtual links that are no longer in use.

Properties

Name Meaning
Domain Specifies the domain of the NetBox API to target for the operation, such as DCIM, IPAM, Tenancy, etc.
ID The unique identifier of the virtual link record to be deleted.

Output

JSON

  • success - Indicates whether the deletion operation was successful.
  • message - Provides additional information or confirmation about the deletion result.

Dependencies

  • NetBox API with appropriate credentials for authentication.

Troubleshooting

  • Ensure the provided ID corresponds to an existing virtual link record; otherwise, the deletion will fail.
  • Verify that the API credentials have sufficient permissions to delete virtual link resources.
  • Check network connectivity to the NetBox API endpoint to avoid request failures.
  • Common error messages include authorization errors, resource not found errors, and validation errors. Resolving these involves checking credentials, verifying the ID, and ensuring the API endpoint is correct.

Links

Discussion