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
Module → Create
AI-generatedOverview
This node interacts with the NetBox API to create a new module within the DCIM domain. It is useful for network administrators or IT professionals who want to automate the addition of hardware modules to devices in their infrastructure management system. For example, it can be used to add a new module to a device by specifying the device ID, module bay ID, and module type ID, along with optional details like serial number, asset tag, description, comments, tags, and custom fields.
Use Case Examples
- Creating a new module for a device in NetBox by specifying the device ID, module bay ID, and module type ID.
- Adding additional metadata to the module such as serial number and asset tag for better inventory tracking.
Properties
| Name | Meaning |
|---|---|
| Domain | The domain of the NetBox API to interact with, e.g., DCIM. |
| Device ID | The ID of the device to which the module will be added. |
| Module Bay ID | The ID of the module bay where the module will be installed. |
| Module Type ID | The ID of the module type to be created. |
| Additional Fields | Optional additional fields for the module such as serial number, asset tag, description, comments, tags, and custom fields. |
Output
JSON
id- The unique identifier of the created module.device- The device ID to which the module belongs.module_bay- The module bay ID where the module is installed.module_type- The type ID of the module.serial- Serial number of the module, if provided.asset_tag- Asset tag of the module, if provided.description- Description of the module, if provided.comments- Comments about the module, if provided.tags- Tags associated with the module, if provided.custom_fields- Custom fields associated with the module, if provided.
Dependencies
- NetBox API
- An API key credential for authentication
Troubleshooting
- Common issues include invalid or missing device ID, module bay ID, or module type ID, which will cause the API call to fail.
- Errors related to authentication if the API key credential is missing or invalid.
- If 'Continue on Fail' is enabled, errors will be returned as output instead of stopping execution.