Bugfix: Update modules/lookup plugin to work with pynetbox >=5.0.0 (#269)

Author: FragmentedPacket

.travis.yml

@@ -30,7 +30,7 @@ jobs:
         - cd ..
         - pip install -U pip "setuptools>=46.1.3"
         - pip install pytest==4.6.5 pytest-mock pytest-xdist jinja2 PyYAML black==19.10b0 "coverage<5"
-        - pip install pynetbox==4.3.3 cryptography codecov jmespath jsondiff ansible
+        - pip install pynetbox cryptography codecov jmespath jsondiff ansible
 
     # Stick to python 3.7 instead of 3.8, as ansible-test sanity is not compatible with 3.7
     # https://github.com/ansible/ansible/issues/67118
@@ -49,7 +49,7 @@ jobs:
         - cd ..
         - pip install -U pip "setuptools>=46.1.3"
         - pip install pytest==4.6.5 pytest-mock pytest-xdist jinja2 PyYAML black==19.10b0 "coverage<5"
-        - pip install pynetbox==4.3.3 cryptography codecov jmespath jsondiff ansible
+        - pip install pynetbox cryptography codecov jmespath jsondiff ansible
 
     # Latest development versions of Netbox and Ansible, newest Python
     # This may be broken sometimes by changes in the netbox & ansible projects
@@ -67,7 +67,7 @@ jobs:
         - cd ..
         - pip install -U pip "setuptools>=46.1.3"
         - pip install pytest==4.6.5 pytest-mock pytest-xdist jinja2 PyYAML black==19.10b0 "coverage<5"
-        - pip install pynetbox==4.3.3 cryptography jmespath jsondiff
+        - pip install pynetbox cryptography jmespath jsondiff
         - git clone https://github.com/ansible/ansible.git
         - cd ansible
         - source hacking/env-setup

README.md

@@ -11,10 +11,10 @@ To keep the code simple, we only officially support the two latest releases of N
 ## Requirements
 
 - NetBox 2.6+ or the two latest NetBox releases
-- **pynetbox 4.2.5+**
 - Python 3.6+
+- Python modules: **pynetbox 5.0.4+**
 - Ansible 2.9+
-- NetBox write-enabled token
+- NetBox write-enabled token when using modules or read-only token for `nb_lookup/nb_inventory`
 
 ## Existing Modules
 

plugins/lookup/nb_lookup.py

@@ -19,6 +19,7 @@
 from ansible.utils.display import Display
 
 import pynetbox
+import requests
 
 __metaclass__ = type
 
@@ -204,12 +205,15 @@ def run(self, terms, variables=None, **kwargs):
             terms = [terms]
 
         try:
+            session = requests.Session()
+            session.verify = netbox_ssl_verify
+
             netbox = pynetbox.api(
                 netbox_api_endpoint,
                 token=netbox_api_token if netbox_api_token else None,
-                ssl_verify=netbox_ssl_verify,
                 private_key_file=netbox_private_key_file,
             )
+            netbox.http_session = session
         except FileNotFoundError:
             raise AnsibleError(
                 "%s cannot be found. Please make sure file exists."

plugins/module_utils/netbox_ipam.py

@@ -85,6 +85,7 @@ def _get_new_available_ip_address(self, nb_app, data, endpoint_name):
             self.nb_object, diff = self._create_netbox_object(
                 prefix.available_ips, data
             )
+            self.nb_object = self.nb_object.serialize()
             self.result["changed"] = True
             self.result["msg"] = "%s %s created" % (
                 endpoint_name,
@@ -110,6 +111,7 @@ def _get_new_available_prefix(self, data, endpoint_name):
             self.nb_object, diff = self._create_netbox_object(
                 self.nb_object.available_prefixes, data
             )
+            self.nb_object = self.nb_object.serialize()
             self.result["changed"] = True
             self.result["msg"] = "%s %s created" % (
                 endpoint_name,

plugins/module_utils/netbox_utils.py

@@ -26,6 +26,7 @@
 PYNETBOX_IMP_ERR = None
 try:
     import pynetbox
+    import requests
 
     HAS_PYNETBOX = True
 except ImportError:
@@ -459,7 +460,10 @@ def __init__(self, module, endpoint, nb_client=None):
 
     def _connect_netbox_api(self, url, token, ssl_verify):
         try:
-            nb = pynetbox.api(url, token=token, ssl_verify=ssl_verify)
+            session = requests.Session()
+            session.verify = ssl_verify
+            nb = pynetbox.api(url, token=token)
+            nb.http_session = session
             try:
                 self.version = float(nb.version)
             except AttributeError:

tests/integration/targets/latest/tasks/netbox_ip_address.yml

@@ -220,8 +220,8 @@
       - test_ten['diff']['after']['state'] == "present"
       - test_ten['msg'] == "ip_address 10.10.0.1/16 created"
       - test_ten['ip_address']['address'] == "10.10.0.1/16"
-      - test_ten['ip_address']['family']['value'] == 4
-      - test_ten['ip_address']['interface']['id'] == 4
+      - test_ten['ip_address']['family'] == 4
+      - test_ten['ip_address']['interface'] == 4
 
 - name: "11 - Create IP address on GigabitEthernet2 - test100 - State: present"
   netbox.netbox.netbox_ip_address:

tests/integration/targets/latest/tasks/netbox_prefix.yml

@@ -221,8 +221,8 @@
       - test_ten['diff']['after']['state'] == "present"
       - test_ten['msg'] == "prefix 10.157.0.0/24 created"
       - test_ten['prefix']['prefix'] == "10.157.0.0/24"
-      - test_ten['prefix']['site']['id'] == 1
-      - test_ten['prefix']['vrf']['id'] == 1
+      - test_ten['prefix']['site'] == 1
+      - test_ten['prefix']['vrf'] == 1
 
 - name: "11 - Get a new /24 inside 10.156.0.0/19 within Netbox"
   netbox.netbox.netbox_prefix: