NetBox icon

NetBox

Consume NetBox API

Actions243

Power Port → Delete

AI-generated

Overview

This node interacts with the NetBox API to delete a specific Power Port resource within the selected domain. It is useful for automating the removal of power port records in network infrastructure management, ensuring that outdated or incorrect power port entries are efficiently cleaned up. For example, a network administrator can use this node to delete a power port by specifying its ID, streamlining maintenance tasks in large data center environments.

Use Case Examples

  1. Deleting a power port by its ID in the DCIM domain to remove obsolete hardware connections.
  2. Automating cleanup of power port records during device decommissioning processes.

Properties

Name Meaning
Domain Specifies the domain of the NetBox API to target, such as DCIM, IPAM, Tenancy, etc. This determines the API segment to interact with.
ID The unique identifier of the power port record to delete. This is required to specify which power port to remove.

Output

JSON

  • success - Indicates whether the deletion operation was successful.
  • id - The ID of the deleted power port record.

Dependencies

  • NetBox API with appropriate authentication credentials

Troubleshooting

  • Ensure the provided power port ID exists and is correct; otherwise, the API will return an error indicating the resource was not found.
  • Verify that the API credentials have sufficient permissions to delete power port records in the specified domain.
  • Common error messages include authorization failures, resource not found, or network connectivity issues. Resolving these involves checking credentials, verifying the ID, and ensuring network access to the NetBox API endpoint.

Links

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

Discussion