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 Type Profile → Update
AI-generatedOverview
This node updates a Module Type Profile in the NetBox API under the DCIM domain. It is useful for users who want to modify existing module type profiles by changing attributes such as name, description, tags, or custom fields. For example, a network administrator can update the description or tags of a module type profile to keep the inventory information current.
Use Case Examples
- Updating the name and description of a module type profile to reflect new hardware specifications.
- Adding or modifying tags to categorize module type profiles for easier filtering and management.
- Updating custom fields with JSON data to store additional metadata about the module type profile.
Properties
| Name | Meaning |
|---|---|
| Domain | Specifies the domain of the NetBox API to interact with, here it is set to 'dcim' for device and component management. |
| Module Type Profile ID | The unique identifier of the module type profile to update. |
| Update Fields | A collection of fields to update on the module type profile, including name, description, tags, and custom fields (JSON object). |
Output
JSON
id- The unique identifier of the updated module type profile.name- The name of the updated module type profile.description- The description of the updated module type profile.tags- Tags associated with the updated module type profile.custom_fields- Custom fields data of the updated module type profile.
Dependencies
- NetBox API
- An API key credential for authentication
Troubleshooting
- Ensure the Module Type Profile ID is correct and exists in the NetBox instance to avoid 'not found' errors.
- Validate JSON format for custom fields to prevent parsing errors.
- Check API credentials and permissions if authentication errors occur.
- If the update fails, verify that the fields being updated are allowed and correctly formatted according to NetBox API specifications.
Links
- NetBox API Documentation for Module Type Profiles - Official documentation for the Module Type Profiles endpoint in the NetBox API.