NetBox icon

NetBox

Consume NetBox API

Actions243

Rack → Get Elevation

AI-generated

Overview

This node interacts with the NetBox API to retrieve the elevation details of a specific rack within the DCIM domain. It is useful for scenarios where users need to visualize or analyze the vertical layout of devices within a rack, such as in data center management or equipment planning. For example, a user can fetch the front or rear elevation of a rack to see which devices occupy which units.

Use Case Examples

  1. Retrieve the front elevation of a rack to visualize device placement.
  2. Get the rear elevation of a rack to check cable management or device access.

Properties

Name Meaning
Domain Specifies the domain of the NetBox API to interact with, here it is set to 'dcim' for data center infrastructure management.
ID The unique identifier of the rack for which the elevation data is requested.
Elevation Filters Filters to customize the elevation data retrieval, including face (front or rear), limit, offset, exclude, and render format (JSON or SVG).

Output

JSON

  • elevationData - The elevation details of the rack, including device placement and unit information, returned in the specified render format (JSON or SVG).

Dependencies

  • NetBox API
  • An API key credential for authentication

Troubleshooting

  • Ensure the rack ID provided is valid and exists in the NetBox instance to avoid 'not found' errors.
  • Check API credentials and permissions if authentication errors occur.
  • If the elevation data is not returned as expected, verify the filter parameters such as face, limit, and offset are correctly set.
  • Common error messages include invalid domain or resource errors if the domain is not set to 'dcim' or resource is not 'racks'.
  • Network connectivity issues to the NetBox API endpoint can cause request failures.

Links

Discussion