{"id":263,"date":"2020-07-08T17:07:24","date_gmt":"2020-07-08T16:07:24","guid":{"rendered":"https:\/\/blog.thomarite.uk\/?p=263"},"modified":"2020-07-17T20:21:13","modified_gmt":"2020-07-17T19:21:13","slug":"netbox-api-troubleshooting","status":"publish","type":"post","link":"https:\/\/blog.thomarite.uk\/index.php\/2020\/07\/08\/netbox-api-troubleshooting\/","title":{"rendered":"Netbox – API Troubleshooting"},"content":{"rendered":"\n

Yesterday managed to get netbox and my lab connected. So today followed up with the original article, and found a new issue that took me several hours.<\/p>\n\n\n\n

Initially I was seeing an error that I couldn’t undestand “<\/p>\n\n\n\n

netbox.exceptions.CreateException: This field is required<\/em><\/strong><\/pre>\n\n\n\n
From<\/p>\n\n\n\n
(venv) \/netbox-example\/nornir-napalm-netbox-demo master$ python scripts\/create_interfaces.py\nnb_url = http:\/\/0.0.0.0:8080\nCreating Netbox Interface for device r1, interface Loopback1\nTraceback (most recent call last):\nFile \"scripts\/create_interfaces.py\", line 42, in\ntask=create_netbox_interface,\nFile \"\/home\/tomas\/storage\/technology\/netbox-example\/venv\/lib\/python3.7\/site-packages\/nornir\/core\/init<\/strong>.py\", line 146, in run\nresult = self._run_serial(task, run_on, **kwargs)\nFile \"\/home\/tomas\/storage\/technology\/netbox-example\/venv\/lib\/python3.7\/site-packages\/nornir\/core\/init<\/strong>.py\", line 72, in _run_serial\nresult[host.name] = task.copy().start(host, self)\nFile \"\/home\/tomas\/storage\/technology\/netbox-example\/venv\/lib\/python3.7\/site-packages\/nornir\/core\/task.py\", line 85, in start\nr = self.task(self, **self.params)\nFile \"scripts\/create_interfaces.py\", line 34, in create_netbox_interface\ndevice_id=device_id,\nFile \"\/home\/tomas\/storage\/technology\/netbox-example\/venv\/lib\/python3.7\/site-packages\/netbox\/dcim.py\", line 431, in create_interface\nreturn self.netbox_con.post('\/dcim\/interfaces\/', required_fields, **kwargs)\nFile \"\/home\/tomas\/storage\/technology\/netbox-example\/venv\/lib\/python3.7\/site-packages\/netbox\/connection.py\", line 124, in post\nraise exceptions.CreateException(resp_data)\nnetbox.exceptions.CreateException: This field is required<\/em><\/strong>.<\/pre>\n\n\n\n
So I started to follow the trace, adding “print” and using “ipdb” to see what was going on:<\/p>\n\n\n\n
....\n\/home\/tomas\/storage\/technology\/netbox-example\/venv\/lib\/python3.7\/site-packages\/netbox\/connection.py(71)__request()\n70 finally:\n---> 71 self.close()\n72\nipdb> dir(response)\n['attrs<\/strong>', 'bool<\/strong>', 'class<\/strong>', 'delattr<\/strong>', 'dict<\/strong>', 'dir<\/strong>', 'doc<\/strong>', 'enter<\/strong>', 'eq<\/strong>', 'exit<\/strong>', 'format<\/strong>', 'ge<\/strong>', 'getattribute<\/strong>', 'getstate<\/strong>', 'gt<\/strong>', 'hash<\/strong>', 'init<\/strong>', 'init_subclass<\/strong>', 'iter<\/strong>', 'le<\/strong>', 'lt<\/strong>', 'module<\/strong>', 'ne<\/strong>', 'new<\/strong>', 'nonzero<\/strong>', 'reduce<\/strong>', 'reduce_ex<\/strong>', 'repr<\/strong>', 'setattr<\/strong>', 'setstate<\/strong>', 'sizeof<\/strong>', 'str<\/strong>', 'subclasshook<\/strong>', 'weakref<\/strong>', '_content', '_content_consumed', '_next', 'apparent_encoding', 'close', 'connection', 'content', 'cookies', 'elapsed', 'encoding', 'headers', 'history', 'is_permanent_redirect', 'is_redirect', 'iter_content', 'iter_lines', 'json', 'links', 'next', 'ok', 'raise_for_status', 'raw', 'reason', 'request', 'status_code', 'text', 'url']\nipdb> response.url\n'http:\/\/0.0.0.0:8080\/api\/dcim\/interfaces\/'\nipdb> response.text\n'{\"type\":[\"This field is required.\"]}'\nipdb> response.status_code\n400\nipdb> response.content\nb'{\"type\":[\"This field is required.\"]}'\nipdb> response.reason\n'Bad Request'\nipdb> response.request\n\nipdb> prepared_request\n\nipdb> prepared_request.url\n'http:\/\/0.0.0.0:8080\/api\/dcim\/interfaces\/'\nipdb> dir(prepared_request)\n['class<\/strong>', 'delattr<\/strong>', 'dict<\/strong>', 'dir<\/strong>', 'doc<\/strong>', 'eq<\/strong>', 'format<\/strong>', 'ge<\/strong>', 'getattribute<\/strong>', 'gt<\/strong>', 'hash<\/strong>', 'init<\/strong>', 'init_subclass<\/strong>', 'le<\/strong>', 'lt<\/strong>', 'module<\/strong>', 'ne<\/strong>', 'new<\/strong>', 'reduce<\/strong>', 'reduce_ex<\/strong>', 'repr<\/strong>', 'setattr<\/strong>', 'sizeof<\/strong>', 'str<\/strong>', 'subclasshook<\/strong>', 'weakref<\/strong>', '_body_position', '_cookies', '_encode_files', '_encode_params', '_get_idna_encoded_host', 'body', 'copy', 'deregister_hook', 'headers', 'hooks', 'method', 'path_url', 'prepare', 'prepare_auth', 'prepare_body', 'prepare_content_length', 'prepare_cookies', 'prepare_headers', 'prepare_hooks', 'prepare_method', 'prepare_url', 'register_hook', 'url']\nipdb> prepared_request.path_url\n'\/api\/dcim\/interfaces\/'\nipdb> response.__content\n*** AttributeError: 'Response' object has no attribute '__content'\nipdb> response._content\nb'{\"type\":[\"This field is required.\"]}'\nipdb> response.content\nb'{\"type\":[\"This field is required.\"]}'<\/strong>\nipdb> response.headers\n{'Server': 'nginx', 'Date': 'Wed, 08 Jul 2020 12:36:35 GMT', 'Content-Type': 'application\/json', 'Content-Length': '36', 'Connection': 'keep-alive', 'Vary': 'Accept, Cookie, Origin', 'Allow': 'GET, POST, HEAD, OPTIONS, TRACE', 'API-Version': '2.8', 'X-Content-Type-Options': 'nosniff', 'X-Frame-Options': 'SAMEORIGIN'}\nipdb> response.reason\n'Bad Request'\nipdb> response.request\n\nipdb> response.test\n*** AttributeError: 'Response' object has no attribute 'test'\nipdb> response.text\n'{\"type\":[\"This field is required.\"]}'\nipdb> response.url\n'http:\/\/0.0.0.0:8080\/api\/dcim\/interfaces\/'\nipdb> quit\nCreate Netbox Interfaces\nr1 ** changed : False\nvvvv Create Netbox Interfaces ** changed : False vvvvvvvvvvvvvvvvvvvvvvvvvvvvvvv ERROR\n---- napalm_get ** changed : False --------------------------------------------- INFO\n(venv) go:1.12.5|py:3.7.3|tomas@athens:~\/storage\/technology\/netbox-example\/nornir-napalm-netbox-demo master$ python scripts\/create_interfaces.py\nnb_url = http:\/\/0.0.0.0:8080\nurl3=http:\/\/0.0.0.0:8080\/api\/dcim\/interfaces?limit=0\nCreating Netbox Interface for device r1, interface Loopback1\nurl3=http:\/\/0.0.0.0:8080\/api\/dcim\/devices\/?name=r1&limit=0\ndevice_id = 1\nurl3=http:\/\/0.0.0.0:8080\/api\/dcim\/interfaces\/\nresp_ok=False resp_status=400\nbody_data= {'name': 'Loopback1', 'form_factor': 1200, 'device': 1}\nparams= \/dcim\/interfaces\/\nresp_data= {'type': ['This field is required.']}<\/em><\/strong>\nTraceback (most recent call last):\nFile \"scripts\/create_interfaces.py\", line 43, in\ntask=create_netbox_interface,\nFile \"\/home\/tomas\/storage\/technology\/netbox-example\/venv\/lib\/python3.7\/site-packages\/nornir\/core\/init<\/strong>.py\", line 146, in run\nresult = self._run_serial(task, run_on, **kwargs)\nFile \"\/home\/tomas\/storage\/technology\/netbox-example\/venv\/lib\/python3.7\/site-packages\/nornir\/core\/init<\/strong>.py\", line 72, in _run_serial\nresult[host.name] = task.copy().start(host, self)\nFile \"\/home\/tomas\/storage\/technology\/netbox-example\/venv\/lib\/python3.7\/site-packages\/nornir\/core\/task.py\", line 85, in start\nr = self.task(self, **self.params)\nFile \"scripts\/create_interfaces.py\", line 35, in create_netbox_interface\ndevice_id=device_id,\nFile \"\/home\/tomas\/storage\/technology\/netbox-example\/venv\/lib\/python3.7\/site-packages\/netbox\/dcim.py\", line 431, in create_interface\nreturn self.netbox_con.post('\/dcim\/interfaces\/', required_fields, **kwargs)\nFile \"\/home\/tomas\/storage\/technology\/netbox-example\/venv\/lib\/python3.7\/site-packages\/netbox\/connection.py\", line 130, in post\nraise exceptions.CreateException(resp_data)\nnetbox.exceptions.CreateException: This field is required.<\/pre>\n\n\n\n
So it seems that at the end I realised that I was missing the parameter “type” !!!<\/p>\n\n\n\n
I was checking the documentation from netbox in github but I couldnt see clearly what kind of config I had to provide…<\/p>\n\n\n\n
I checked the “type” value for the only interfaces I already had in netbox: “http:\/\/0.0.0.0:8080\/api\/dcim\/interfaces\/<\/a>“<\/p>\n\n\n\n
\"\"<\/figure>\n\n\n\n
So I tried to pass exactly that but it was still failing…<\/p>\n\n\n\n
(venv) go:1.12.5|py:3.7.3|tomas@athens:~\/storage\/technology\/netbox-example\/nornir-napalm-netbox-demo master$ python scripts\/create_interfaces.py\nnb_url = http:\/\/0.0.0.0:8080\nurl3=http:\/\/0.0.0.0:8080\/api\/dcim\/interfaces?limit=0\nCreating Netbox Interface for device r1, interface Loopback1\nurl3=http:\/\/0.0.0.0:8080\/api\/dcim\/devices\/?name=r1&limit=0\ndevice_id = 1\nurl3=http:\/\/0.0.0.0:8080\/api\/dcim\/interfaces\/\nresp_ok=False resp_status=400\nbody_data= {'name': 'Loopback1', 'form_factor': 1200, 'device': 1, 'type': {'value': '1000base-t', 'label': '1000BASE-T (1GE)', 'id': 1000}}\n<\/strong>params= \/dcim\/interfaces\/\nresp_data= {'type': ['Value must be passed directly (e.g. \"foo\": 123); do not use a dictionary or list.']}\nTraceback (most recent call last):\nFile \"scripts\/create_interfaces.py\", line 50, in\ntask=create_netbox_interface,\nFile \"\/home\/tomas\/storage\/technology\/netbox-example\/venv\/lib\/python3.7\/site-packages\/nornir\/core\/init<\/strong>.py\", line 146, in run\nresult = self._run_serial(task, run_on, **kwargs)\nFile \"\/home\/tomas\/storage\/technology\/netbox-example\/venv\/lib\/python3.7\/site-packages\/nornir\/core\/init<\/strong>.py\", line 72, in _run_serial\nresult[host.name] = task.copy().start(host, self)\nFile \"\/home\/tomas\/storage\/technology\/netbox-example\/venv\/lib\/python3.7\/site-packages\/nornir\/core\/task.py\", line 85, in start\nr = self.task(self, **self.params)\nFile \"scripts\/create_interfaces.py\", line 42, in create_netbox_interface\n**interface_type,\nFile \"\/home\/tomas\/storage\/technology\/netbox-example\/venv\/lib\/python3.7\/site-packages\/netbox\/dcim.py\", line 431, in create_interface\nreturn self.netbox_con.post('\/dcim\/interfaces\/', required_fields, **kwargs)\nFile \"\/home\/tomas\/storage\/technology\/netbox-example\/venv\/lib\/python3.7\/site-packages\/netbox\/connection.py\", line 130, in post\nraise exceptions.CreateException(resp_data)\nnetbox.exceptions.CreateException: Value must be passed directly (e.g. \"foo\": 123); do not use a dictionary or list.\n<\/em><\/strong>(venv) go:1.12.5|py:3.7.3|tomas@athens:~\/storage\/technology\/netbox-example\/nornir-napalm-netbox-demo master$<\/pre>\n\n\n\n
Somehow the API had to be documented… by chance, looking at the bottom of the netbox page, there was an”API” link….<\/p>\n\n\n\n
\"\"<\/figure>\n\n\n\n
So, now I needed to look up the correct API call. Based on the script and logs, it was a “POST” for “\/dcim\/interfaces\/”. Here we go!<\/p>\n\n\n\n
\"\"<\/figure>\n\n\n\n
So finally, I had the info. I confirmed what fields were mandatory and the value they needed!<\/p>\n\n\n\n
interface_type = {}\ninterface_type[\"type\"] = \"1000base-t\"\nfor interface_name in interfaces.keys():\n    if not is_interface_present(nb_interfaces, f\"{task.host}\", interface_name):\n        print(\n            f\"* Creating Netbox Interface for device {task.host}, interface {interface_name}\"\n        )\n        device_id = get_device_id(f\"{task.host}\", netbox)\n        print(\"device_id = %s\" % device_id)\n        netbox.dcim.create_interface(\n           name=f\"{interface_name}\",\n           form_factor=1200,  # default\n           device_id=device_id,\n           **interface_type,\n        )<\/code><\/pre>\n\n\n\n
So the script ran fine for all my devices:<\/p>\n\n\n\n
netbox-example\/nornir-napalm-netbox-demo master$ python scripts\/create_interfaces.py\nnb_url = http:\/\/0.0.0.0:8080\nurl3=http:\/\/0.0.0.0:8080\/api\/dcim\/interfaces?limit=0\nCreate Netbox Interfaces\nr1 ** changed : False\nvvvv Create Netbox Interfaces ** changed : False vvvvvvvvvvvvvvvvvvvvvvvvvvvvvvv INFO\n---- napalm_get ** changed : False --------------------------------------------- INFO\n^^^^ END Create Netbox Interfaces ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^\nr2 ** changed : False\nvvvv Create Netbox Interfaces ** changed : False vvvvvvvvvvvvvvvvvvvvvvvvvvvvvvv INFO\n---- napalm_get ** changed : False --------------------------------------------- INFO\n^^^^ END Create Netbox Interfaces ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^\nr3 ** changed : False\nvvvv Create Netbox Interfaces ** changed : False vvvvvvvvvvvvvvvvvvvvvvvvvvvvvvv INFO\n---- napalm_get ** changed : False --------------------------------------------- INFO\n^^^^ END Create Netbox Interfaces ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^<\/pre>\n\n\n\n
And it is updated in GUI:<\/p>\n\n\n\n
\"\"<\/figure>\n","protected":false},"excerpt":{"rendered":"
Yesterday managed to get netbox and my lab connected. So today followed up with the original article, and found a new issue that took me several hours. Initially I was seeing an error that I couldn’t undestand “ netbox.exceptions.CreateException: This field is required From (venv) \/netbox-example\/nornir-napalm-netbox-demo master$ python scripts\/create_interfaces.py nb_url = http:\/\/0.0.0.0:8080 Creating Netbox Interface … Continue reading “Netbox – API Troubleshooting”<\/span><\/a><\/p>\n","protected":false},"author":1,"featured_media":0,"comment_status":"closed","ping_status":"open","sticky":false,"template":"","format":"standard","meta":{"footnotes":""},"categories":[21,2],"tags":[],"class_list":["post-263","post","type-post","status-publish","format-standard","hentry","category-automation","category-networks"],"_links":{"self":[{"href":"https:\/\/blog.thomarite.uk\/index.php\/wp-json\/wp\/v2\/posts\/263","targetHints":{"allow":["GET"]}}],"collection":[{"href":"https:\/\/blog.thomarite.uk\/index.php\/wp-json\/wp\/v2\/posts"}],"about":[{"href":"https:\/\/blog.thomarite.uk\/index.php\/wp-json\/wp\/v2\/types\/post"}],"author":[{"embeddable":true,"href":"https:\/\/blog.thomarite.uk\/index.php\/wp-json\/wp\/v2\/users\/1"}],"replies":[{"embeddable":true,"href":"https:\/\/blog.thomarite.uk\/index.php\/wp-json\/wp\/v2\/comments?post=263"}],"version-history":[{"count":1,"href":"https:\/\/blog.thomarite.uk\/index.php\/wp-json\/wp\/v2\/posts\/263\/revisions"}],"predecessor-version":[{"id":269,"href":"https:\/\/blog.thomarite.uk\/index.php\/wp-json\/wp\/v2\/posts\/263\/revisions\/269"}],"wp:attachment":[{"href":"https:\/\/blog.thomarite.uk\/index.php\/wp-json\/wp\/v2\/media?parent=263"}],"wp:term":[{"taxonomy":"category","embeddable":true,"href":"https:\/\/blog.thomarite.uk\/index.php\/wp-json\/wp\/v2\/categories?post=263"},{"taxonomy":"post_tag","embeddable":true,"href":"https:\/\/blog.thomarite.uk\/index.php\/wp-json\/wp\/v2\/tags?post=263"}],"curies":[{"name":"wp","href":"https:\/\/api.w.org\/{rel}","templated":true}]}}