NetBox icon

NetBox

Consume NetBox API

Actions243

Site → Get Racks

AI-generated

Overview

This node interacts with the NetBox API to retrieve rack information associated with a specific site within the DCIM domain. It is useful for network administrators or IT professionals who need to programmatically access rack data for inventory, monitoring, or management purposes. For example, it can be used to fetch all racks in a data center site to automate asset tracking or capacity planning.

Use Case Examples

  1. Retrieve all racks for a given site ID in the DCIM domain to generate an inventory report.
  2. Fetch a limited number of racks from a site to display in a dashboard or UI component.

Properties

Name Meaning
Domain Specifies the domain of the NetBox API to interact with, e.g., DCIM.
Site ID The unique identifier of the site for which racks are to be retrieved.
Return All Determines whether to return all rack results or limit the number of results.
Limit Maximum number of rack results to return if 'Return All' is false.

Output

JSON

  • id - Unique identifier of the rack.
  • name - Name of the rack.
  • site_id - Identifier of the site the rack belongs to.
  • status - Current status of the rack.
  • role - Role or purpose of the rack.
  • units - Number of units (height) of the rack.
  • serial - Serial number of the rack.
  • comments - Additional comments or notes about the rack.

Dependencies

  • NetBox API
  • An API key credential for authentication

Troubleshooting

  • Ensure the Site ID is valid and exists in the NetBox instance to avoid 'not found' errors.
  • Check API credentials and permissions if authentication errors occur.
  • If the node returns fewer racks than expected, verify the 'Return All' and 'Limit' settings.

Links

Discussion