add site_group support

Author: ryanmerolle

src/netbox_initializers/initializers/__init__.py

@@ -17,6 +17,7 @@
     "webhooks",
     "tenant_groups",
     "tenants",
+    "site_groups",
     "regions",
     "rirs",
     "asns",
@@ -205,6 +206,7 @@ def register_initializer(name: str, initializer):
 from .route_targets import RouteTargetInitializer
 from .service_templates import ServiceTemplateInitializer
 from .services import ServiceInitializer
+from .site_groups import SiteGroupInitializer
 from .sites import SiteInitializer
 from .tags import TagInitializer
 from .tenant_groups import TenantGroupInitializer

src/netbox_initializers/initializers/site_groups.py

@@ -0,0 +1,36 @@
+from dcim.models import SiteGroup
+
+from . import BaseInitializer, register_initializer
+
+OPTIONAL_ASSOCS = {"parent": (SiteGroup, "name")}
+
+
+class SiteGroupInitializer(BaseInitializer):
+    data_file_name = "site_groups.yml"
+
+    def load_data(self):
+        site_groups = self.load_yaml()
+        if site_groups is None:
+            return
+        for params in site_groups:
+            tags = params.pop("tags", None)
+
+            for assoc, details in OPTIONAL_ASSOCS.items():
+                if assoc in params:
+                    model, field = details
+                    query = {field: params.pop(assoc)}
+
+                    params[assoc] = model.objects.get(**query)
+
+            matching_params, defaults = self.split_params(params)
+            site_group, created = SiteGroup.objects.get_or_create(
+                **matching_params, defaults=defaults
+            )
+
+            if created:
+                print("🌐 Created Site Group", site_group.name)
+
+            self.set_tags(site_group, tags)
+
+
+register_initializer("site_groups", SiteGroupInitializer)

src/netbox_initializers/initializers/sites.py

@@ -1,10 +1,14 @@
-from dcim.models import Region, Site
+from dcim.models import Region, Site, SiteGroup
 from ipam.models import ASN
 from tenancy.models import Tenant
 
 from . import BaseInitializer, register_initializer
 
-OPTIONAL_ASSOCS = {"region": (Region, "name"), "tenant": (Tenant, "name")}
+OPTIONAL_ASSOCS = {
+    "region": (Region, "name"),
+    "group": (SiteGroup, "name"),
+    "tenant": (Tenant, "name"),
+}
 
 
 class SiteInitializer(BaseInitializer):

src/netbox_initializers/initializers/yaml/site_groups.yml

@@ -0,0 +1,7 @@
+# - name: Datacenter
+#   slug: datacenter
+# - name: Office
+#   slug: office
+# - name: Headquaters
+#   slug: headquarters
+#   parent: Office

src/netbox_initializers/initializers/yaml/sites.yml

@@ -3,6 +3,7 @@
 #   region: Downtown
 #   status: active
 #   facility: Amsterdam 1
+#.  group: Office
 #   custom_field_data:
 #     text_field: Description for AMS1
 # - name: AMS 2