NetBox icon

NetBox

Consume NetBox API

Actions243

Inventory Item Role → Delete

AI-generated

Overview

This node interacts with the NetBox API to delete an Inventory Item Role within the DCIM domain. It is useful for automating the removal of specific inventory item roles in network infrastructure management, ensuring that outdated or unnecessary roles are programmatically cleaned up.

Use Case Examples

  1. Deleting an Inventory Item Role by specifying its ID to maintain an up-to-date inventory in NetBox.
  2. Automating cleanup of inventory roles during network reconfiguration or decommissioning.

Properties

Name Meaning
Domain Specifies the domain of the NetBox API to target, here it is set to 'dcim' for data center infrastructure management.
Inventory Item Role ID The unique identifier of the inventory item role to be deleted.

Output

JSON

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

Dependencies

  • NetBox API with appropriate credentials for authentication

Troubleshooting

  • Ensure the Inventory Item Role ID is correct and exists in the NetBox instance to avoid 'not found' errors.
  • Verify that the API credentials have sufficient permissions to delete inventory item roles.
  • Check network connectivity to the NetBox API endpoint.
  • Common error messages include authorization failures, invalid ID format, or resource not found; resolving these involves verifying credentials, input data, and API endpoint configuration.

Links

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

Discussion