NetBox icon

NetBox

Consume NetBox API

Actions243

Rack Reservation → Get Many

AI-generated

Overview

This node interacts with the NetBox API to retrieve multiple rack reservation records within the DCIM domain. It is useful for scenarios where users need to fetch a list of rack reservations, optionally filtered by various criteria such as rack ID, site ID, user ID, tenant ID, and more. For example, a data center manager could use this node to get all rack reservations for a specific site or user to manage space allocation efficiently.

Use Case Examples

  1. Retrieve all rack reservations in the DCIM domain.
  2. Fetch rack reservations filtered by a specific rack ID or site ID.
  3. Limit the number of rack reservations returned to a specified count for pagination or performance reasons.

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.
Return All Determines whether to return all rack reservation results or limit the number of results.
Limit Maximum number of rack reservation results to return when 'Return All' is false.
Filters Optional filters to narrow down the rack reservations returned, such as by rack ID, site ID, location ID, user ID, tenant ID, search query, ID, ordering, creation date, or last updated date.

Output

JSON

  • id - Unique identifier of the rack reservation.
  • rack - Details of the rack associated with the reservation.
  • site - Site information where the rack reservation is located.
  • location - Location details related to the rack reservation.
  • user - User who made the rack reservation.
  • tenant - Tenant associated with the rack reservation.
  • created - Timestamp when the rack reservation was created.
  • last_updated - Timestamp of the last update to the rack reservation.

Dependencies

  • NetBox API
  • An API key credential for authentication

Troubleshooting

  • Common issues include authentication failures due to invalid or missing API credentials. Ensure the API key credential is correctly configured.
  • Incorrect filter parameters may result in no data returned or errors. Verify filter values are valid and correspond to existing entities in NetBox.
  • If the 'Return All' option is false and the limit is set too low, the returned data may be incomplete. Adjust the limit or enable 'Return All' as needed.
  • Network connectivity issues to the NetBox API endpoint can cause request failures. Check network settings and API availability.

Links

Discussion