Overview

This node interacts with the NetBox API to list modules within the DCIM domain. It is useful for retrieving detailed information about hardware modules installed in devices managed by NetBox, such as network equipment or servers. Users can filter the list by various criteria like module ID, device ID, module bay ID, module type ID, serial number, or asset tag. It supports returning all results or limiting the number of results for efficient data handling.

Use Case Examples

1. Retrieve all modules installed in a specific device by filtering with device ID.
2. List up to 50 modules with a specific serial number or asset tag.
3. Fetch all modules without any filters to get a complete inventory of modules in the DCIM domain.

Properties

Output

JSON

• id - Unique identifier of the module.
• device_id - Identifier of the device to which the module is attached.
• module_bay_id - Identifier of the module bay where the module is installed.
• module_type_id - Identifier of the type of the module.
• serial - Serial number of the module.
• asset_tag - Asset tag associated with the module.
• name - Name or label of the module.
• status - Current status of the module.

Dependencies

• NetBox API
• An API key credential for authentication

Troubleshooting

• Common issues include authentication failures due to invalid API credentials, which result in authorization errors. Ensure the API key is valid and has sufficient permissions.
• Incorrect filter values may lead to empty results. Verify filter criteria are correct and correspond to existing data in NetBox.
• Network connectivity issues can prevent the node from reaching the NetBox API endpoint. Check network settings and API URL configuration.

Links

• NetBox API Documentation - Official documentation for the NetBox API, useful for understanding available endpoints and data structures.