Actions243
- Cable Actions
- Cable Termination Actions
- Connected Device Actions
- Console Port Actions
- Console Port Template Actions
- Console Server Port Actions
- Console Server Port Template Actions
- Device Actions
- Device Bay Actions
- Device Bay Template Actions
- Device Role Actions
- Device Type Actions
- Front Port Actions
- Front Port Template Actions
- Interface Actions
- Interface Template Actions
- Inventory Item Actions
- Inventory Item Role Actions
- Inventory Item Template Actions
- Location Actions
- MAC Address Actions
- Manufacturer Actions
- Module Actions
- Module Bay Actions
- Module Bay Template Actions
- Module Type Actions
- Module Type Profile Actions
- Platform Actions
- Power Feed Actions
- Power Outlet Actions
- Power Outlet Template Actions
- Power Panel Actions
- Power Port Actions
- Power Port Template Actions
- Rack Actions
- Rack Reservation Actions
- Rack Role Actions
- Rack Type Actions
- Rear Port Actions
- Rear Port Template Actions
- Region Actions
- Site Actions
- Site Group Actions
- Virtual Chassis Actions
- Virtual Device Context Actions
- Virtual Link Actions
Inventory Item Role → List
AI-generatedOverview
This node interacts with the NetBox API to list Inventory Item Roles within the DCIM domain. It is useful for users who want to retrieve and manage inventory item roles from their NetBox instance, such as for asset management or inventory categorization. For example, it can be used to fetch all inventory item roles or filter them based on specific criteria like name, slug, or creation date.
Use Case Examples
- Retrieve all inventory item roles in the DCIM domain.
- Filter inventory item roles by name or color.
- Limit the number of returned inventory item roles to a specific count.
Properties
| Name | Meaning |
|---|---|
| Domain | Specifies the domain of the NetBox API to interact with, here it is set to 'dcim' for inventory-related resources. |
| Return All | Determines whether to return all results or limit the number of results. |
| Limit | Maximum number of inventory item roles to return when 'Return All' is false. |
| Filters | Collection of filters to narrow down the list of inventory item roles based on various fields such as name, slug, color, ID, ordering, and date filters. |
Output
JSON
id- Unique identifier of the inventory item role.name- Name of the inventory item role.slug- Slug (URL-friendly identifier) of the inventory item role.color- Color code associated with the inventory item role.created- Creation date of the inventory item role.last_updated- Last updated date of the inventory item role.
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 domain or resource selection may lead to no data being returned or errors. Verify the domain is set to 'dcim' and resource to 'inventory-item-roles'.
- Filters with invalid values or formats may cause the API to reject the request. Use valid filter values and formats as per NetBox API documentation.
- If the node throws errors during execution, enabling 'Continue on Fail' can help to handle errors gracefully by returning error details in the output.
Links
- NetBox API Documentation - Inventory Item Roles - Official NetBox API documentation for the Inventory Item Roles resource in the DCIM domain.