mirror/netbox-sync
1
0
Fork 0
mirror of https://github.com/bb-Ricardo/netbox-sync.git synced 2026-04-27 04:49:16 -05:00
Code Issues Packages Projects Releases Wiki Activity

better mitigates issue with assigning VLAN groups #373

Browse Source
This commit is contained in:
Ricardo Bartels
2025-02-22 10:21:00 +01:00
parent 1117bf1b29
commit e5619c33c9
3 changed files with 22 additions and 6 deletions
Download Patch File Download Diff File Expand all files Collapse all files
module/sources/common/source_base.py
+13 -2
View File
@@ -701,6 +701,7 @@ class SourceBase:
vlan_name = grab(vlan_data, "data.name")
vlan_id = grab(vlan_data, "data.vid")
vlan_current_site = grab(vlan_data, "data.site")
# vlan already has a group attached
if grab(vlan_data, "data.group") is not None:
return vlan_data
@@ -708,6 +709,7 @@ class SourceBase:
elif isinstance(vlan_data, dict):
vlan_name = vlan_data.get("name")
vlan_id = vlan_data.get("vid")
vlan_current_site = vlan_data.get("site")
else:
return vlan_data
@@ -717,6 +719,9 @@ class SourceBase:
if isinstance(vlan_cluster, str):
vlan_cluster = self.inventory.get_by_data(NBCluster, data={"name": vlan_cluster})
if isinstance(vlan_current_site, dict):
vlan_current_site = self.inventory.get_by_data(NBSite, data=vlan_current_site)
log_text = f"Trying to find a matching VLAN Group based on the VLAN name '{vlan_name}'"
if vlan_site is not None:
log_text += f", site '{vlan_site.get_display_name()}'"
@@ -751,13 +756,19 @@ class SourceBase:
if vlan_group is not None:
log.debug2(f"Found matching VLAN group '{vlan_group.get_display_name()}'")
"""
If a VLAN group has been found we also need to check if the vlan site and the scope of the VLAN group are
matching. If the VLAN group has a different scope then site, we need to remove the site from the VLAN.
Mitigation for: https://github.com/netbox-community/netbox/issues/18706
"""
if isinstance(vlan_data, NBVLAN):
vlan_data.update(data={"group": vlan_group})
if vlan_data.data.get("site") is not None:
if vlan_current_site is not vlan_group.data.get("scope_id"):
vlan_data.unset_attribute("site")
elif isinstance(vlan_data, dict):
vlan_data["group"] = vlan_group
if vlan_data.get("site") is not None:
if vlan_current_site is not vlan_group.data.get("scope_id"):
del(vlan_data["site"])
else:
log.debug2("No matching VLAN group found")
module/sources/vmware/config.py
+5 -2
View File
@@ -330,13 +330,16 @@ class VMWareConfig(ConfigBase):
description="""adds a relation to assign VLAN groups to matching VLANs
by name. Same matching rules as the exclude_by_name option uses are applied.
If name and id relations are defined, the name relation takes precedence.
Fist match wins.""",
Fist match wins. Only newly discovered VLANs which are not present in
NetBox will be assigned a VLAN group.
""",
config_example="London/Vlan_.* = VLAN Group 1, Tokio/Vlan_.* = VLAN Group 2"),
ConfigOption("vlan_group_relation_by_id",
str,
description="""adds a relation to assign VLAN groups to matching VLANs by ID.
Same matching rules as the exclude_by_id option uses are applied.
Fist match wins.
Fist match wins. Only newly discovered VLANs which are not present in
NetBox will be assigned a VLAN group.
""",
config_example="1023-1042 = VLAN Group 1, Tokio/2342 = VLAN Group 2")
]),
settings-example.ini
+4 -2
View File
@@ -339,11 +339,13 @@ password = super-secret
; adds a relation to assign VLAN groups to matching VLANs by name. Same matching rules as
; the exclude_by_name option uses are applied. If name and id relations are defined, the
; name relation takes precedence. Fist match wins.
; name relation takes precedence. Fist match wins. Only newly discovered VLANs which are
; not present in NetBox will be assigned a VLAN group.
;vlan_group_relation_by_name = London/Vlan_.* = VLAN Group 1, Tokio/Vlan_.* = VLAN Group 2
; adds a relation to assign VLAN groups to matching VLANs by ID. Same matching rules as
; the exclude_by_id option uses are applied. Fist match wins.
; the exclude_by_id option uses are applied. Fist match wins. Only newly discovered VLANs
; which are not present in NetBox will be assigned a VLAN group.
;vlan_group_relation_by_id = 1023-1042 = VLAN Group 1, Tokio/2342 = VLAN Group 2
; enabling this option will add the ESXi host this VM is running on to the VM details