nb_lookup: Added flag to return raw api output (#136)

Author: richard-olson

plugins/lookup/nb_lookup.py

@@ -52,6 +52,10 @@
             description:
                 - The location of the private key tied to user account.
             required: False
+        raw_data:
+            description:
+                - Whether to return raw API data with the lookup/query or whether to return a key/value dict
+            required: False
     requirements:
         - pynetbox
 """
@@ -187,6 +191,7 @@ def run(self, terms, variables=None, **kwargs):
         netbox_api_endpoint = kwargs.get("api_endpoint")
         netbox_private_key_file = kwargs.get("key_file")
         netbox_api_filter = kwargs.get("api_filter")
+        netbox_raw_return = kwargs.get("raw_data")
 
         if not isinstance(terms, list):
             terms = [terms]
@@ -225,19 +230,25 @@ def run(self, terms, variables=None, **kwargs):
 
                     Display().vvvvv(pformat(dict(res)))
 
-                    key = dict(res)["id"]
-                    result = {key: dict(res)}
+                    if netbox_raw_return:
+                        results.append(dict(res))
 
-                    results.extend(self._flatten_hash_to_list(result))
+                    else:
+                        key = dict(res)["id"]
+                        result = {key: dict(res)}
+                        results.extend(self._flatten_hash_to_list(result))
 
             else:
                 for res in endpoint.all():
 
                     Display().vvvvv(pformat(dict(res)))
 
-                    key = dict(res)["id"]
-                    result = {key: dict(res)}
+                    if netbox_raw_return:
+                        results.append(dict(res))
 
-                    results.extend(self._flatten_hash_to_list(result))
+                    else:
+                        key = dict(res)["id"]
+                        result = {key: dict(res)}
+                        results.extend(self._flatten_hash_to_list(result))
 
         return results

tests/integration/integration-tests.yml

@@ -4451,3 +4451,9 @@
         that: "{{ query_result|json_query('[?value.display_name==`L2`]')|count }} == 1"
       vars:
         query_result: "{{ query('netbox.netbox.nb_lookup', 'devices', api_filter='role=core-switch tag=lookup', api_endpoint='http://localhost:32768', token='0123456789abcdef0123456789abcdef01234567') }}"
+
+    - name: "NETBOX_LOOKUP 8: Device query specifying raw data returns payload without key/value dict"
+      assert:
+        that: "{{ query_result|json_query('[?display_name==`L2`]')|count }} == 1"
+      vars:
+        query_result: "{{ query('netbox.netbox.nb_lookup', 'devices', api_filter='role=core-switch tag=lookup', api_endpoint='http://localhost:32768', token='0123456789abcdef0123456789abcdef01234567', raw_data=True) }}"