Overview

This node interacts with the NetBox API to create a new region within the DCIM domain. It is useful for network administrators or IT professionals who want to automate the management of network infrastructure by programmatically adding regions to their NetBox instance. For example, it can be used to add a new geographical or logical region to organize network assets.

Use Case Examples

1. Creating a new region named 'North America' with a description and tags to categorize network assets geographically.
2. Adding a parent region ID to nest regions hierarchically within the NetBox system.

Properties

Output

JSON

• id - The unique identifier of the created region.
• name - The name of the created region.
• slug - The URL-friendly slug of the region.
• parent - The ID of the parent region, if any.
• description - Description of the region.
• tags - Tags associated with the region.
• custom_fields - Custom fields associated with the region.

Dependencies

• NetBox API
• An API key credential for authenticating with the NetBox API

Troubleshooting

• Common issues include authentication failures due to invalid API credentials, which result in authorization errors. Ensure the API key is valid and has appropriate permissions.
• Validation errors may occur if required fields like 'Name' are missing or if field values do not meet NetBox API requirements. Verify input data before submission.
• Network connectivity issues can prevent the node from reaching the NetBox API endpoint. Check network settings and API URL configuration.

Links

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