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
Device Role → Get
AI-generatedOverview
This node interacts with the NetBox API to retrieve information about a specific Device Role within the DCIM domain. It is useful for scenarios where you need to fetch detailed data about a device role by its ID, such as in network management or inventory automation workflows.
Use Case Examples
- Fetching details of a device role by its ID to display or process in an automation workflow.
- Integrating with NetBox to dynamically retrieve device role information for reporting or configuration purposes.
Properties
| Name | Meaning |
|---|---|
| Domain | Specifies the domain of the NetBox API to use, here it is set to 'dcim' for device-related resources. |
| Device Role ID | The unique identifier of the device role to retrieve. This is required to specify which device role to get. |
Output
JSON
id- The unique identifier of the device role.name- The name of the device role.slug- A URL-friendly identifier for the device role.color- The color associated with the device role for UI representation.vmRole- Indicates if the device role is for virtual machines.description- A textual description of the device role.tags- Tags associated with the device role for categorization.
Dependencies
- NetBox API with appropriate authentication credentials
Troubleshooting
- Ensure the Device Role ID is correctly provided and exists in the NetBox instance.
- Verify that the API credentials have sufficient permissions to access device roles in the DCIM domain.
- Check network connectivity to the NetBox API endpoint.
- Common error messages include authentication failures, resource not found (404), and permission denied (403). Resolving these involves verifying credentials, IDs, and user permissions.
Links
- NetBox API Documentation - Device Roles - Official documentation for the Device Roles endpoint in the NetBox API.