nb_inventory: Add an option bypass querying racks (#701)

Author: bvergnaud

plugins/inventory/nb_inventory.py

@@ -133,7 +133,7 @@
             version_added: "0.2.1"
         group_by:
             description:
-                - Keys used to create groups. The I(plurals) option controls which of these are valid.
+                - Keys used to create groups. The I(plurals) and I(racks) options control which of these are valid.
                 - I(rack_group) is supported on NetBox versions 2.10 or lower only
                 - I(location) is supported on NetBox versions 2.11 or higher only
             type: list
@@ -214,6 +214,12 @@
             description: List of custom ansible host vars to create from the device object fetched from NetBox
             default: {}
             type: dict
+        racks:
+            description:
+                - If False, skip querying the racks for information, which can be slow with great amounts of racks.
+                - The choices of I(group_by) will be changed by this option.
+            type: boolean
+            default: True
 """
 
 EXAMPLES = """
@@ -466,29 +472,35 @@ def group_extractors(self):
             "is_virtual": self.extract_is_virtual,
             self._pluralize_group_by("site"): self.extract_site,
             self._pluralize_group_by("tenant"): self.extract_tenant,
-            self._pluralize_group_by("rack"): self.extract_rack,
-            "rack_role": self.extract_rack_role,
             self._pluralize_group_by("tag"): self.extract_tags,
             self._pluralize_group_by("role"): self.extract_device_role,
             self._pluralize_group_by("platform"): self.extract_platform,
             self._pluralize_group_by("device_type"): self.extract_device_type,
             self._pluralize_group_by("manufacturer"): self.extract_manufacturer,
         }
 
-        # Locations were added in 2.11 replacing rack-groups.
-        if self.api_version >= version.parse("2.11"):
+        if self.racks:
             extractors.update(
                 {
-                    "location": self.extract_location,
-                }
-            )
-        else:
-            extractors.update(
-                {
-                    "rack_group": self.extract_rack_group,
+                    self._pluralize_group_by("rack"): self.extract_rack,
+                    "rack_role": self.extract_rack_role,
                 }
             )
 
+            # Locations were added in 2.11 replacing rack-groups.
+            if self.api_version >= version.parse("2.11"):
+                extractors.update(
+                    {
+                        "location": self.extract_location,
+                    }
+                )
+            else:
+                extractors.update(
+                    {
+                        "rack_group": self.extract_rack_group,
+                    }
+                )
+
         if self.services:
             extractors.update(
                 {
@@ -1226,8 +1238,6 @@ def lookup_processes(self):
             self.refresh_regions_lookup,
             self.refresh_locations_lookup,
             self.refresh_tenants_lookup,
-            self.refresh_racks_lookup,
-            self.refresh_rack_groups_lookup,
             self.refresh_device_roles_lookup,
             self.refresh_platforms_lookup,
             self.refresh_device_types_lookup,
@@ -1244,6 +1254,14 @@ def lookup_processes(self):
         if self.services:
             lookups.append(self.refresh_services)
 
+        if self.racks:
+            lookups.extend(
+                [
+                    self.refresh_racks_lookup,
+                    self.refresh_rack_groups_lookup,
+                ]
+            )
+
         return lookups
 
     @property
@@ -1494,7 +1512,11 @@ def add_host_to_groups(self, host, hostname):
 
             if grouping not in self.group_extractors:
                 raise AnsibleError(
-                    'group_by option "%s" is not valid. Check group_by documentation or check the plurals option. It can determine what group_by options are valid.'
+                    (
+                        'group_by option "%s" is not valid.'
+                        " Check group_by documentation or check the plurals option, as well as the racks options."
+                        " It can determine what group_by options are valid."
+                    )
                     % grouping
                 )
 
@@ -1782,5 +1804,6 @@ def parse(self, inventory, loader, path, cache=True):
         self.virtual_chassis_name = self.get_option("virtual_chassis_name")
         self.dns_name = self.get_option("dns_name")
         self.ansible_host_dns_name = self.get_option("ansible_host_dns_name")
+        self.racks = self.get_option("racks")
 
         self.main()