NetBox icon

NetBox

Consume NetBox API

Actions243

Console Port → Delete

AI-generated

Overview

This node interacts with the NetBox API to delete a Console Port resource within the specified domain. It is useful in scenarios where you need to programmatically remove console port records from NetBox, such as during network equipment decommissioning or cleanup tasks.

Use Case Examples

  1. Deleting a console port by specifying its ID in the DCIM domain of NetBox.
  2. Automating the removal of console ports as part of a network device lifecycle management workflow.

Properties

Name Meaning
Domain Specifies the domain of the NetBox API to target, e.g., DCIM, IPAM, Tenancy, etc.
Console Port ID The unique identifier of the console port 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 credentials

Troubleshooting

  • Ensure the Console Port ID is correct and exists in the specified domain; otherwise, the delete operation will fail.
  • Verify that the API credentials have sufficient permissions to delete console ports.
  • Common error messages include authorization errors, resource not found, or network connectivity issues. Resolving these involves checking credentials, verifying resource existence, and network access.

Links

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

Discussion