Overview

This node interacts with the NetBox API to update a region resource within the DCIM domain. It allows users to modify details of a specific region by providing the region's ID and the fields to update, such as name, slug, parent region ID, description, tags, and custom fields. This is useful for managing and maintaining accurate geographical or organizational region data in network infrastructure management.

Use Case Examples

1. Updating the name and description of a region to reflect organizational changes.
2. Adding tags to a region for better categorization and searchability within NetBox.
3. Changing the parent region ID to reorganize the hierarchy of regions.

Properties

Output

JSON

• id - The unique identifier of the updated region.
• name - The updated name of the region.
• slug - The updated URL-friendly slug of the region.
• parent - The updated parent region ID.
• description - The updated description of the region.
• tags - The updated tags associated with the region.
• custom_fields - The updated custom fields of the region.

Dependencies

• NetBox API
• An API key credential for authentication

Troubleshooting

• Ensure the Region ID provided is correct and exists in NetBox to avoid 'not found' errors.
• Verify that the API key credential has sufficient permissions to update region resources.
• Check the format of custom fields JSON to avoid parsing errors.
• If the node throws an error, enabling 'Continue on Fail' will output the error message as JSON instead of stopping execution.

Links

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