NetBox icon

NetBox

Consume NetBox API

Actions243

Rack Role → Get Many

AI-generated

Overview

This node interacts with the NetBox API to retrieve multiple rack role records from the DCIM domain. It is useful for users who want to fetch a list of rack roles with optional filtering, limiting, and pagination controls. For example, a user can get all rack roles or limit the results to a specific number, and apply filters such as name, slug, color, or creation date to narrow down the results.

Use Case Examples

  1. Fetch all rack roles from the DCIM domain to display in an inventory dashboard.
  2. Retrieve a limited number of rack roles with specific filters for reporting or automation purposes.

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 Boolean flag to determine whether to return all results or limit the number of results.
Limit Maximum number of rack role records to return when 'Return All' is false.
Filters Optional filters to narrow down the rack roles returned, such as by name, slug, color, ID, creation date, or last updated date.

Output

JSON

  • id - Unique identifier of the rack role.
  • name - Name of the rack role.
  • slug - Slug identifier of the rack role.
  • color - Color attribute of the rack role.
  • created - Creation timestamp of the rack role.
  • last_updated - Timestamp of the last update to the rack role.

Dependencies

  • NetBox API with an API key credential for authentication

Troubleshooting

  • Ensure the API key credential is correctly configured and has permissions to access the DCIM domain and rack roles resource.
  • If the node returns an error, check the filter values for correctness and supported formats.
  • If 'Return All' is set to false and no results are returned, try increasing the 'Limit' value.
  • Network connectivity issues to the NetBox API endpoint can cause failures; verify the endpoint URL and network access.

Links

Discussion