lookup: added api_filter

Author: ThomasADavis

plugins/lookup/netbox.py

@@ -15,6 +15,7 @@
 
 from ansible.errors import AnsibleError
 from ansible.plugins.lookup import LookupBase
+from ansible.parsing.splitter import parse_kv
 from ansible.utils.display import Display
 
 import pynetbox
@@ -40,6 +41,10 @@
             description:
                 - The URL to the Netbox instance to query
             required: True
+        api_filter:
+            description:
+                - The api_filter to use.
+            required: False
         token:
             description:
                 - The API token created through Netbox
@@ -59,6 +64,20 @@
     loop: "{{ query('netbox', 'devices',
                     api_endpoint='http://localhost/',
                     token='<redacted>') }}"
+
+This example uses an API Filter
+
+tasks:
+  # query a list of devices
+  - name: Obtain list of devices from Netbox
+    debug:
+      msg: >
+        "Device {{ item.value.display_name }} (ID: {{ item.key }}) was
+         manufactured by {{ item.value.device_type.manufacturer.name }}"
+    loop: "{{ query('netbox', 'devices',
+                    api_endpoint='http://localhost/',
+                    api_filter='role=management tag=Dell'),
+                    token='<redacted>') }}"
 """
 
 RETURN = """
@@ -161,6 +180,7 @@ def run(self, terms, variables=None, **kwargs):
         netbox_api_token = kwargs.get("token")
         netbox_api_endpoint = kwargs.get("api_endpoint")
         netbox_private_key_file = kwargs.get("key_file")
+        netbox_api_filter = kwargs.get("api_filter")
 
         if not isinstance(terms, list):
             terms = [terms]
@@ -180,16 +200,32 @@ def run(self, terms, variables=None, **kwargs):
                 raise AnsibleError("Unrecognised term %s. Check documentation" % term)
 
             Display().vvvv(
-                u"Netbox lookup for %s to %s using token %s"
-                % (term, netbox_api_endpoint, netbox_api_token)
+                u"Netbox lookup for %s to %s using token %s filter %s"
+                % (term, netbox_api_endpoint, netbox_api_token, netbox_api_filter)
             )
-            for res in endpoint.all():
 
-                Display().vvvvv(pformat(dict(res)))
+            if netbox_api_filter:
+                filter = parse_kv(netbox_api_filter)
+
+                Display().vvvv("filter is %s" % filter)
+
+                for res in endpoint.filter(**filter):
+
+                    Display().vvvvv(pformat(dict(res)))
+
+                    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)}
+                    key = dict(res)["id"]
+                    result = {key: dict(res)}
 
-                results.extend(self._flatten_hash_to_list(result))
+                    results.extend(self._flatten_hash_to_list(result))
 
         return results

tests/integration/integration-tests.yml

@@ -3045,3 +3045,39 @@
         that: "{{ (query_result|json_query('[?value.vid==`400`].value.name'))[0] == 'Test VLAN' }}"
       vars:
         query_result: "{{ query('fragmentedpacket.netbox_modules.netbox', 'vlans', api_endpoint='http://localhost:32768', token='0123456789abcdef0123456789abcdef01234567') }}"
+
+    - name: "NETBOX_LOOKUP 5: Add one of two devices for lookup filter test."
+      netbox_device:
+        netbox_url: "http://localhost:32768"
+        netbox_token: "0123456789abcdef0123456789abcdef01234567"
+        data:
+          name: "L1"
+          device_type: "Cisco Test"
+          device_role: "Core Switch"
+          site: "Test Site"
+          status: "Staged"
+          tags: 
+            - "nolookup"
+        state: present
+
+    - name: "NETBOX_LOOKUP 6: Add two of two devices for lookup filter test."
+      netbox_device:
+        netbox_url: "http://localhost:32768"
+        netbox_token: "0123456789abcdef0123456789abcdef01234567"
+        data:
+          name: "L2"
+          device_type: "Cisco Test"
+          device_role: "Core Switch"
+          site: "Test Site"
+          status: "Staged"
+          tags: 
+            - "lookup"
+        state: present
+
+    - name: "NETBOX_LOOKUP 7: Device query returns exactly the L2 device"
+      assert:
+        that: "{{ query_result|json_query('[?value.display_name==`L2`]')|count }} == 1"
+      vars:
+          query_result: "{{ query('fragmentedpacket.netbox_modules.netbox', 'devices', api_filter='role=core-switch tag=lookup', api_endpoint='http://localhost:32768', token='0123456789abcdef0123456789abcdef01234567') }}"
+
+