adds config options to skip offline and placeholder VMs

refs: #135
refs: #136

Author: bb-Ricardo

module/sources/vmware/connection.py

@@ -120,6 +120,8 @@ class VMWareHandler(SourceBase):
         "set_primary_ip": "when-undefined",
         "skip_vm_comments": False,
         "skip_vm_templates": True,
+        "skip_offline_vms": False,
+        "skip_srm_placeholder_vms": False,
         "strip_host_domain_name": False,
         "strip_vm_domain_name": False,
         "sync_tags": False,
@@ -450,6 +452,11 @@ def apply(self):
             }
         }
 
+        # skip virtual machines which are reported offline
+        if self.skip_offline_vms is True:
+            log.info("Skipping offline VMs")
+            del object_mapping["offline virtual machine"]
+
         for view_name, view_details in object_mapping.items():
 
             if self.session is None:
@@ -1795,6 +1802,11 @@ def add_virtual_machine(self, obj):
             log.debug2(f"VM '{name}' is a template. Skipping")
             return
 
+        if bool(self.skip_srm_placeholder_vms) is True \
+                and f"{grab(obj, 'config.managedBy.extensionKey')}".startswith("com.vmware.vcDr"):
+            log.debug2(f"VM '{name}' is a SRM placeholder VM. Skipping")
+            return
+
         # ignore offline VMs during first run
         if self.parsing_vms_the_first_time is True and status == "offline":
             log.debug2(f"Ignoring {status} VM '{name}' on first run")

settings-example.ini

@@ -219,6 +219,14 @@ permitted_subnets = 172.16.0.0/12, 10.0.0.0/8, 192.168.0.0/16, fd00::/8
 # Do not sync template VMs
 #skip_vm_templates = True
 
+# Skip virtual machines which are reported as offline.
+# ATTENTION: this option will keep purging stopped VMs if activated!
+#skip_offline_vms = False
+
+# If the VMware Site Recovery Manager is used to can skip syncing
+# placeholder/replicated VMs from fail-over site to NetBox.
+#skip_srm_placeholder_vms = False
+
 # strip domain part from host name before syncing device to NetBox
 #strip_host_domain_name = False