NetBox icon

NetBox

Consume NetBox API

Actions243

Inventory Item Role → Get

AI-generated

Overview

This node interacts with the NetBox API to retrieve details of a specific Inventory Item Role within the DCIM domain. It is useful for scenarios where you need to fetch detailed information about an inventory item role by its ID, such as in asset management or network infrastructure automation workflows.

Use Case Examples

  1. Retrieve an inventory item role by its ID to display or process its attributes in an automation pipeline.
  2. Fetch inventory item role details to synchronize with another system or database.

Properties

Name Meaning
Domain Specifies the domain of the NetBox API to use, here it is set to 'dcim' for data center infrastructure management.
Inventory Item Role ID The unique identifier of the inventory item role to retrieve.

Output

JSON

  • id - The unique identifier of the inventory item role.
  • name - The name of the inventory item role.
  • slug - A URL-friendly identifier for the inventory item role.
  • description - A textual description of the inventory item role.
  • created - Timestamp when the inventory item role was created.
  • last_updated - Timestamp when the inventory item role was last updated.

Dependencies

  • NetBox API
  • An API key credential for authentication

Troubleshooting

  • Ensure the Inventory Item Role ID is correct and exists in the NetBox instance to avoid 'not found' errors.
  • Verify that the API key credential is valid and has sufficient permissions to access the inventory item roles resource.
  • Check network connectivity to the NetBox API endpoint.
  • If the node throws an error, enabling 'Continue on Fail' will allow the workflow to proceed and output the error message for debugging.

Discussion