Merge branch 'devel' into datasources

Author: dchiquito

changelogs/fragments/1438-fix-inventory-service-collection.yml

@@ -0,0 +1,2 @@
+bugfixes:
+  - nb_inventory - Fix service collection for version greater than 4.3

changelogs/fragments/1462-fix-pylint-errors.yml

@@ -0,0 +1,2 @@
+minor_changes:
+  - Fix ansible-bad-import-from pylint errors

changelogs/fragments/1464-fix-mac-lookup-by-id.yml

@@ -0,0 +1,2 @@
+bugfixes:
+  - "nb_device_interface: Fix specifying primary_mac_address objects by id for disambiguation"

changelogs/fragments/1469-fix-old-apis.yml

@@ -0,0 +1,2 @@
+minor_changes:
+  - Fix broken code path when using old api path on old netbox systems

docs/getting_started/how-to-use/advanced.rst

@@ -224,7 +224,7 @@ To make this possible, every module accepts the ``query_params`` argument. This
 you want to use to search for the object.
 
 Let's start with another example. We will continue to use :ref:`netbox.netbox.netbox_ip_address<ansible_collections.netbox.netbox.netbox_ip_address_module>`. We created **192.168.100.1/24** as a duplicate IP address within
-the global IP address space within NetBox. This task should fail saying there was more than result returned.
+the global IP address space within NetBox. This task should fail saying there was more than one result returned.
 
 .. code-block:: yaml
 
@@ -304,7 +304,9 @@ Hopefully this shines some light on this useful feature to allow you, as the use
 Using Module defaults groups
 --------------------------------------------
 
-Ansible-core >= 2.12 provide a useful feature called [Module defaults groups](https://docs.ansible.com/ansible/latest/user_guide/playbooks_module_defaults.html#module-defaults-groups) that lets us specify default parameters for a group of modules in a single place. We can use the action_group ``netbox`` that contains all modules from this collection to avoid setting e.g. ``token`` and ``url`` on each task and thus reduce boilerplate code.
+Ansible-core >= 2.12 provide a useful feature called `Module defaults groups`_ that lets us specify default parameters for a group of modules in a single place. We can use the action_group ``netbox`` that contains all modules from this collection to avoid setting e.g. ``token`` and ``url`` on each task and thus reduce boilerplate code.
+
+.. _Module defaults groups: https://docs.ansible.com/ansible/latest/user_guide/playbooks_module_defaults.html#module-defaults-groups
 
 .. code-block:: yaml
 

plugins/inventory/nb_inventory.py

@@ -408,7 +408,6 @@
 from ansible.module_utils.six.moves.urllib.parse import urlencode
 from ansible.module_utils.six.moves.urllib.parse import urlparse
 
-from ansible.module_utils.six import raise_from
 
 try:
     from packaging import specifiers, version
@@ -1328,6 +1327,15 @@ def refresh_services(self):
 
         if self.fetch_all:
             services = self.get_resource_list(url)
+        elif self.api_version >= version.parse("4.3.0"):
+            services = self.get_resource_list_chunked(
+                api_url=url,
+                query_key="parent_object_id",
+                # Query only affected devices and vms and sanitize the list to only contain every ID once
+                query_values=set(
+                    chain(self.vms_lookup.keys(), self.devices_lookup.keys())
+                ),
+            )
         else:
             device_services = self.get_resource_list_chunked(
                 api_url=url,
@@ -1349,15 +1357,26 @@ def refresh_services(self):
         for service in services:
             service_id = service["id"]
 
-            if service.get("device"):
-                self.device_services_lookup[service["device"]["id"]][
-                    service_id
-                ] = service
+            if self.api_version >= version.parse("4.3.0"):
+                if service.get("parent_object_type") == "dcim.device":
+                    self.device_services_lookup[service["parent_object_id"]][
+                        service_id
+                    ] = service
 
-            if service.get("virtual_machine"):
-                self.vm_services_lookup[service["virtual_machine"]["id"]][
-                    service_id
-                ] = service
+                if service.get("parent_object_type") == "virtualization.virtualmachine":
+                    self.vm_services_lookup[service["parent_object_id"]][
+                        service_id
+                    ] = service
+            else:
+                if service.get("device"):
+                    self.device_services_lookup[service["device"]["id"]][
+                        service_id
+                    ] = service
+
+                if service.get("virtual_machine"):
+                    self.vm_services_lookup[service["virtual_machine"]["id"]][
+                        service_id
+                    ] = service
 
     def refresh_virtual_disks(self):
         url_vm_virtual_disks = (
@@ -1629,10 +1648,10 @@ def fetch_api_docs(self):
                 pass
 
         self.api_version = version.parse(netbox_api_version)
+        parsed_endpoint_url = urlparse(self.api_endpoint)
+        base_path = parsed_endpoint_url.path
 
         if self.api_version >= version.parse("3.5.0"):
-            parsed_endpoint_url = urlparse(self.api_endpoint)
-            base_path = parsed_endpoint_url.path
             self.allowed_device_query_parameters = [
                 p["name"]
                 for p in openapi["paths"][base_path + "/api/dcim/devices/"]["get"][
@@ -2024,10 +2043,9 @@ def _get_host_virtual_chassis_master(self, host):
     def main(self):
         # Check if pytz lib is install, and give error if not
         if PYTZ_IMPORT_ERROR:
-            raise_from(
-                AnsibleError("pytz must be installed to use this plugin"),
-                PYTZ_IMPORT_ERROR,
-            )
+            raise AnsibleError(
+                "pytz must be installed to use this plugin"
+            ) from PYTZ_IMPORT_ERROR
 
         # Get info about the API - version, allowed query parameters
         self.fetch_api_docs()

plugins/lookup/nb_lookup.py

@@ -134,7 +134,6 @@
 from ansible.plugins.lookup import LookupBase
 from ansible.parsing.splitter import parse_kv, split_args
 from ansible.utils.display import Display
-from ansible.module_utils.six import raise_from
 from importlib.metadata import version
 
 try:
@@ -413,16 +412,14 @@ class LookupModule(LookupBase):
 
     def run(self, terms, variables=None, **kwargs):
         if PYNETBOX_LIBRARY_IMPORT_ERROR:
-            raise_from(
-                AnsibleError("pynetbox must be installed to use this plugin"),
-                PYNETBOX_LIBRARY_IMPORT_ERROR,
-            )
+            raise AnsibleError(
+                "pynetbox must be installed to use this plugin"
+            ) from PYNETBOX_LIBRARY_IMPORT_ERROR
 
         if REQUESTS_LIBRARY_IMPORT_ERROR:
-            raise_from(
-                AnsibleError("requests must be installed to use this plugin"),
-                REQUESTS_LIBRARY_IMPORT_ERROR,
-            )
+            raise AnsibleError(
+                "requests must be installed to use this plugin"
+            ) from REQUESTS_LIBRARY_IMPORT_ERROR
 
         netbox_api_token = (
             kwargs.get("token")

plugins/modules/netbox_device_interface.py

@@ -90,7 +90,7 @@
         description:
           - The primary MAC address of the interface (NetBox 4.2 and later)
         required: false
-        type: str
+        type: raw
       wwn:
         description:
           - The WWN of the interface
@@ -340,7 +340,7 @@ def main():
                     bridge=dict(required=False, type="raw"),
                     mtu=dict(required=False, type="int"),
                     mac_address=dict(required=False, type="str"),
-                    primary_mac_address=dict(required=False, type="str"),
+                    primary_mac_address=dict(required=False, type="raw"),
                     wwn=dict(required=False, type="str"),
                     mgmt_only=dict(required=False, type="bool"),
                     poe_type=dict(required=False, type="raw"),

poetry.lock

@@ -387,6 +387,11 @@ def make_netbox_calls(endpoint, payload):
             "assigned_object_id": test100_gi2.id,
             "assigned_object_type": "dcim.interface",
         },
+        {
+            "mac_address": "AA:BB:CC:DD:EE:FF",  # Identical to id 1
+            "assigned_object_id": test100_gi2.id,
+            "assigned_object_type": "dcim.interface",
+        },
     ]
     created_mac_addresses = make_netbox_calls(nb.dcim.mac_addresses, mac_addresses)