adds config option 'vm_exclude_by_tag_filter' #393

Author: bb-Ricardo

module/sources/vmware/config.py

@@ -108,6 +108,15 @@ def __init__(self):
                                              str, description="simply include/exclude VMs"),
                                 ConfigOption("vm_include_filter", str)
                               ]),
+            ConfigOption("vm_exclude_by_tag_filter",
+                         str,
+                         description="""defines a comma separated list of vCenter tags which (if assigned to a VM)
+                         will exclude this VM from being synced to NetBox. The config option 'vm_tag_source'
+                         determines which tags are collected for VMs.
+                         """,
+                         config_example="tag-a, tag-b"
+                         ),
+
             ConfigOptionGroup(title="relations",
                               options=[
                                 ConfigOption("cluster_site_relation",
@@ -439,7 +448,7 @@ def validate_options(self):
             if option.value is None:
                 continue
 
-            if "filter" in option.key:
+            if "filter" in option.key and "vm_exclude_by_tag_filter" not in option.key:
 
                 re_compiled = None
                 try:
@@ -452,6 +461,12 @@ def validate_options(self):
 
                 continue
 
+            if option.key == "vm_exclude_by_tag_filter":
+
+                option.set_value(quoted_split(option.value))
+
+                continue
+
             if "relation" in option.key and "vlan_group_relation" not in option.key:
 
                 relation_data = list()

module/sources/vmware/connection.py

@@ -2187,7 +2187,16 @@ def add_virtual_machine(self, obj):
         vm_tags = self.get_object_relation(name, "vm_tag_relation")
 
         # get vCenter tags
-        vm_tags.extend(self.collect_object_tags(obj))
+        vcenter_tags = self.collect_object_tags(obj)
+
+        # check if VM tag excludes VM from being synced to NetBox
+        for sync_exclude_tag in self.settings.vm_exclude_by_tag_filter or list():
+            if sync_exclude_tag in vcenter_tags:
+                log.debug(f"Virtual machine vCenter tag '{sync_exclude_tag}' in matches 'vm_exclude_by_tag_filter'. "
+                          f"Skipping")
+                return
+
+        vm_tags.extend(vcenter_tags)
 
         # vm memory depending on setting
         vm_memory = grab(obj, "config.hardware.memoryMB", fallback=0)

settings-example.ini

@@ -172,6 +172,11 @@ password = super-secret
 ;vm_exclude_filter =
 ;vm_include_filter =
 
+; defines a comma separated list of vCenter tags which (if assigned to a VM) will exclude
+; this VM from being synced to NetBox. The config option 'vm_tag_source' determines which
+; tags are collected for VMs.
+;vm_exclude_by_tag_filter = tag-a, tag-b
+
 ; relations options
 
 ; This option defines which vCenter cluster is part of a NetBox site.