NetBox icon

NetBox

Consume NetBox API

Actions243

Module Type Profile → Update

AI-generated

Overview

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

  1. Updating the name and description of a module type profile to reflect new hardware specifications.
  2. Adding or modifying tags to categorize module type profiles for easier filtering and management.
  3. 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

Discussion