Overview

This node interacts with the NetBox API to list device roles within the DCIM domain. It is useful for retrieving information about different device roles configured in a NetBox instance, which can help in network management and inventory tasks. For example, a user can fetch all device roles or filter them by name, slug, color, VM role status, or tag to get specific subsets of device roles.

Use Case Examples

1. Retrieve all device roles in the DCIM domain to display in a network management dashboard.
2. Filter device roles by a specific color or tag to organize devices by role characteristics.

Properties

Output

JSON

• id - Unique identifier of the device role.
• name - Name of the device role.
• slug - Slug identifier for the device role.
• color - Color code associated with the device role.
• vm_role - Boolean indicating if the device role is a VM role.
• tag - Tags associated with the device role.

Dependencies

• NetBox API
• An API key credential for authentication

Troubleshooting

• Ensure the API key credential is correctly configured and has permissions to access the DCIM domain and device roles resource.
• If the node returns an error, check the network connectivity to the NetBox API endpoint.
• When using filters, ensure the filter values are valid and correctly formatted.
• If 'Return All' is set to false and the limit is too low, you might not get all expected results; adjust the limit accordingly.

Links

• NetBox API Documentation - Device Roles - Official documentation for the Device Roles endpoint in the NetBox API.