NetBox icon

NetBox

Consume NetBox API

Actions243

Site Group → Create

AI-generated

Overview

This node interacts with the NetBox API to create a new Site Group within the DCIM domain. It is useful for network administrators or IT professionals who want to automate the management of site groups in their NetBox instance. For example, it can be used to programmatically add new site groups with specific names, slugs, and additional metadata such as parent group, description, tags, and custom fields.

Use Case Examples

  1. Creating a new site group named 'Data Center East' with a unique slug and associating it with a parent site group ID.
  2. Adding a site group with descriptive tags and custom JSON fields for enhanced metadata management.

Properties

Name Meaning
Domain Specifies the domain of the NetBox API to interact with, here it is set to 'dcim' for data center infrastructure management.
Name The name of the site group to be created.
Slug A unique slug identifier for the site group.
Additional Fields Optional additional fields for the site group such as parent ID, description, tags, and custom fields in JSON format.

Output

JSON

  • id - Unique identifier of the created site group.
  • name - Name of the created site group.
  • slug - Slug of the created site group.
  • parent - Parent site group ID if assigned.
  • description - Description of the site group.
  • tags - Tags associated with the site group.
  • custom_fields - Custom fields data associated with the site group.

Dependencies

  • NetBox API with appropriate credentials

Troubleshooting

  • Common issues include authentication failures due to invalid API credentials, which result in authorization errors.
  • Validation errors if required fields like 'Name' or 'Slug' are missing or if the slug is not unique.
  • Network connectivity issues preventing access to the NetBox API endpoint.

Links

Discussion