NetBox icon

NetBox

Consume NetBox API

Actions243

Module Type → Delete

AI-generated

Overview

This node interacts with the NetBox API to delete a specific Module Type record within the DCIM domain. It is useful for automating the removal of module types from NetBox, which is a network infrastructure resource management tool. For example, if a module type is no longer used or was created by mistake, this node can programmatically delete it by specifying its ID.

Use Case Examples

  1. Deleting a module type by providing its ID to keep the NetBox inventory clean and up to date.
  2. Automating cleanup tasks in NetBox by removing obsolete module types.

Properties

Name Meaning
Domain Specifies the domain of the NetBox API to target, here it is 'dcim' for data center infrastructure management.
Module Type ID The unique identifier of the module type to delete within the DCIM domain.

Output

JSON

  • success - Indicates whether the delete operation was successful.
  • message - Optional message or error details related to the delete operation.

Dependencies

  • NetBox API with appropriate authentication credentials

Troubleshooting

  • Ensure the Module Type ID provided exists in the NetBox instance; otherwise, the delete operation will fail.
  • Verify that the API credentials have sufficient permissions to delete module types in the DCIM domain.
  • Common error messages include 'Not Found' if the ID does not exist, or 'Unauthorized' if credentials lack delete permissions. Resolving these involves checking the ID and API permissions respectively.

Links

Discussion