NetBox icon

NetBox

Consume NetBox API

Actions243

Rack → Get

AI-generated

Overview

This node interacts with the NetBox API to retrieve information about a specific Rack resource within the DCIM domain. It is useful for scenarios where users need to fetch detailed data about a rack by its ID, such as in data center management, asset tracking, or infrastructure monitoring.

Use Case Examples

  1. Retrieve details of a rack by providing its ID to monitor rack usage and capacity.
  2. Fetch rack information to integrate with other IT management tools or dashboards.

Properties

Name Meaning
Domain Specifies the domain of the NetBox API to use, here it is set to 'dcim' for data center infrastructure management.
ID The unique identifier of the rack to retrieve from the NetBox API.

Output

JSON

  • id - The unique identifier of the rack.
  • name - The name of the rack.
  • site - Information about the site where the rack is located.
  • tenant - Tenant information associated with the rack.
  • status - Current status of the rack.
  • role - Role assigned to the rack.
  • serial - Serial number of the rack.
  • type - Type of the rack.
  • width - Width of the rack.
  • height - Height of the rack.
  • comments - Additional comments or notes about the rack.

Dependencies

  • NetBox API
  • An API key credential for authentication

Troubleshooting

  • Ensure the provided rack ID is correct and exists in the NetBox instance to avoid 'not found' errors.
  • Verify that the API key credential is valid and has sufficient permissions to access the DCIM domain and rack resource.
  • Check network connectivity to the NetBox API endpoint to prevent request failures.
  • If the node throws errors, enabling 'Continue on Fail' can help handle errors gracefully by returning error messages as output.

Links

Discussion