NetBox icon

NetBox

Consume NetBox API

Actions243

Cable → Delete

AI-generated

Overview

This node interacts with the NetBox API to delete a cable resource within the specified domain. It is useful in scenarios where network administrators need to programmatically remove cable records from their NetBox instance, such as during network reconfiguration or cleanup tasks.

Use Case Examples

  1. Deleting a cable record by specifying its ID in the DCIM domain of NetBox.
  2. Automating the removal of obsolete cable entries in a network management workflow.

Properties

Name Meaning
Domain Specifies the domain of the NetBox API to target, such as DCIM, IPAM, Tenancy, etc.
Cable ID The unique identifier of the cable to be deleted. Required when the domain is DCIM and the resource is cables.

Output

JSON

  • error - Error message if the operation fails.

Dependencies

  • NetBox API with appropriate credentials

Troubleshooting

  • Common issues include providing an incorrect or non-existent Cable ID, which will result in an error from the NetBox API indicating the resource was not found.
  • Authentication errors if the API credentials are invalid or missing.
  • Network connectivity issues preventing access to the NetBox API endpoint.

Links

  • NetBox API Documentation - Official documentation for the NetBox API, useful for understanding resource endpoints and operations.

Discussion