NetBox icon

NetBox

Consume NetBox API

Actions243

Module → Get

AI-generated

Overview

This node interacts with the NetBox API to retrieve information about a specific module within the DCIM domain. It is useful for scenarios where users need to fetch detailed data about a module by its ID, such as in network infrastructure management or data center asset tracking.

Use Case Examples

  1. Retrieve details of a module in the DCIM domain by specifying the module ID to monitor or audit hardware components.
  2. Fetch module information to integrate with other IT management tools or dashboards.

Properties

Name Meaning
Domain Specifies the domain of the NetBox API to interact with, e.g., DCIM, IPAM, Tenancy, etc.
Module ID The unique identifier of the module to retrieve within the DCIM domain.

Output

JSON

  • id - The unique identifier of the retrieved module.
  • name - The name of the module.
  • type - The type or model of the module.
  • status - The current status of the module.
  • device - The device to which the module is attached.
  • serial - The serial number of the module.
  • description - A description or notes about the module.

Dependencies

  • NetBox API
  • An API key credential for authentication

Troubleshooting

  • Ensure the Module ID is valid and exists in the NetBox instance to avoid 'not found' errors.
  • Verify that the API key credential is correctly configured and has sufficient permissions to access module data.
  • If the node throws an error, check the network connectivity to the NetBox API endpoint.
  • Enable 'Continue on Fail' option to handle errors gracefully and receive error details in the output.

Links

Discussion