NetBox icon

NetBox

Consume NetBox API

Actions243

Module → Delete

AI-generated

Overview

This node interacts with the NetBox API to delete a specific module record within the selected domain. It is useful for automating the removal of module entries in NetBox, such as when cleaning up or managing infrastructure data programmatically. For example, a user can delete a module by specifying its ID and the domain it belongs to, streamlining maintenance tasks in network management.

Use Case Examples

  1. Deleting a module from the DCIM domain by providing the module ID to remove outdated or incorrect module data.
  2. Automating cleanup of modules in bulk by iterating over module IDs and deleting them via this node.

Properties

Name Meaning
Domain Specifies the domain of the NetBox API to target, such as DCIM, IPAM, Tenancy, etc.
Module ID The ID of the module to delete. This is required to identify the specific module record to be removed.

Output

JSON

  • json - The JSON output contains the result of the delete operation, typically confirmation of deletion or error details if the operation fails.

Dependencies

  • Requires an API key credential for authenticating with the NetBox API.

Troubleshooting

  • Common issues include providing an invalid or non-existent Module ID, which will result in an error from the NetBox API indicating the record was not found.
  • Authentication errors due to missing or incorrect API credentials will prevent the node from successfully deleting the module.
  • Network connectivity issues to the NetBox API endpoint can cause timeouts or failures in the delete operation.

Links

  • NetBox API Documentation - Official documentation for the NetBox API, useful for understanding the endpoints and data structures involved in module deletion.

Discussion