Overview

This node updates a Site Group resource in the NetBox API within the DCIM domain. It is useful for modifying existing site group records by changing attributes such as name, slug, parent ID, description, tags, and custom fields. Practical examples include updating the description of a site group, changing its parent group, or adding tags to better organize site groups in NetBox.

Use Case Examples

1. Update the name and description of a site group by specifying its ID and the new values.
2. Modify the parent ID of a site group to reorganize the site group hierarchy.
3. Add or update tags and custom fields for a site group to enhance metadata management.

Properties

Output

JSON

• id - The unique identifier of the updated site group.
• name - The name of the updated site group.
• slug - The slug of the updated site group.
• parent - The parent ID of the updated site group.
• description - The description of the updated site group.
• tags - Tags associated with the updated site group.
• custom_fields - Custom fields associated with the updated site group.

Dependencies

• NetBox API
• an API key credential for authentication

Troubleshooting

• Ensure the siteGroupId is valid and exists in NetBox to avoid 'not found' errors.
• Verify that the API key credential is correctly configured and has permissions to update site groups.
• Check the JSON format of custom_fields 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 for Site Groups - Official documentation for the Site Group resource in the NetBox API, including update operations.