'Failed to establish connection to NetBox API'

[PhilKet]

Ansible NetBox Collection version

3.10

Ansible version

Use the Ansible playbook below.

ansible [core 2.14.2]
  config file = None
  configured module search path = ['/home/xxx/.ansible/plugins/modules', '/usr/share/ansible/plugins/modules']
  ansible python module location = /usr/local/lib/python3.9/dist-packages/ansible
  ansible collection location = /home/xxx/.ansible/collections:/usr/share/ansible/collections
  executable location = /usr/local/bin/ansible
  python version = 3.9.2 (default, Feb 28 2021, 17:03:44) [GCC 10.2.1 20210110] (/usr/bin/python3)
  jinja version = 3.1.2
  libyaml = True

NetBox version

3.4.0

Python version

3.9

Steps to Reproduce

Use the ansible playbook below, taken from module examples. I have also tested multiple other modules and all fail with the same error.

---

- hosts: localhost
  connection: local
  gather_facts: false

  tasks:
    - name: Create IP address within NetBox with only required information
      netbox.netbox.netbox_ip_address:
        netbox_url: http://localhost/api/
        netbox_token: <netboxapitoken>
        data:
          address: 192.168.1.10
        state: present

Expected Behavior

A working connection to the Netbox API

Observed Behavior

The Ansible playbook fails with the error below. It is apparantly unable to connect to the API because it can't return the API version.

TASK [Create IP address within NetBox with only required information] ***********************************************************************************************************************************************
task path: /home/xxx/ansible/playbooks/netbox-test/playbook.yml:8
<127.0.0.1> ESTABLISH LOCAL CONNECTION FOR USER: xxx
<127.0.0.1> EXEC /bin/sh -c 'echo ~xxx && sleep 0'
<127.0.0.1> EXEC /bin/sh -c '( umask 77 && mkdir -p "` echo /home/xxx/.ansible/tmp `"&& mkdir "` echo /home/xxx/.ansible/tmp/ansible-tmp-1675935210.624016-1699390-203071281737880 `" && echo ansible-tmp-1675935210.624016-1699390-203071281737880="` echo /home/xxx/.ansible/tmp/ansible-tmp-1675935210.624016-1699390-203071281737880 `" ) && sleep 0'
Including module_utils file ansible/__init__.py
Including module_utils file ansible/module_utils/__init__.py
Including module_utils file ansible/module_utils/basic.py
Including module_utils file ansible/module_utils/_text.py
Including module_utils file ansible/module_utils/common/_collections_compat.py
Including module_utils file ansible/module_utils/common/__init__.py
Including module_utils file ansible/module_utils/common/_json_compat.py
Including module_utils file ansible/module_utils/common/_utils.py
Including module_utils file ansible/module_utils/common/arg_spec.py
Including module_utils file ansible/module_utils/common/file.py
Including module_utils file ansible/module_utils/common/locale.py
Including module_utils file ansible/module_utils/common/parameters.py
Including module_utils file ansible/module_utils/common/collections.py
Including module_utils file ansible/module_utils/common/process.py
Including module_utils file ansible/module_utils/common/sys_info.py
Including module_utils file ansible/module_utils/common/text/converters.py
Including module_utils file ansible/module_utils/common/text/__init__.py
Including module_utils file ansible/module_utils/common/text/formatters.py
Including module_utils file ansible/module_utils/common/validation.py
Including module_utils file ansible/module_utils/common/warnings.py
Including module_utils file ansible/module_utils/compat/selectors.py
Including module_utils file ansible/module_utils/compat/__init__.py
Including module_utils file ansible/module_utils/compat/_selectors2.py
Including module_utils file ansible/module_utils/compat/selinux.py
Including module_utils file ansible/module_utils/distro/__init__.py
Including module_utils file ansible/module_utils/distro/_distro.py
Including module_utils file ansible/module_utils/errors.py
Including module_utils file ansible/module_utils/parsing/convert_bool.py
Including module_utils file ansible/module_utils/parsing/__init__.py
Including module_utils file ansible/module_utils/pycompat24.py
Including module_utils file ansible/module_utils/six/__init__.py
Including module_utils file ansible_collections/netbox/netbox/plugins/module_utils/netbox_ipam.py
Including module_utils file ansible_collections/__init__.py
Including module_utils file ansible_collections/netbox/__init__.py
Including module_utils file ansible_collections/netbox/netbox/__init__.py
Including module_utils file ansible_collections/netbox/netbox/plugins/__init__.py
Including module_utils file ansible_collections/netbox/netbox/plugins/module_utils/__init__.py
Including module_utils file ansible_collections/netbox/netbox/plugins/module_utils/netbox_utils.py
Including module_utils file ansible/module_utils/urls.py
Including module_utils file ansible/module_utils/compat/typing.py
Using module file /home/xxx/.ansible/collections/ansible_collections/netbox/netbox/plugins/modules/netbox_ip_address.py
<127.0.0.1> PUT /home/xxx/.ansible/tmp/ansible-local-1699386l49kzzqi/tmpu666hcby TO /home/xxx/.ansible/tmp/ansible-tmp-1675935210.624016-1699390-203071281737880/AnsiballZ_netbox_ip_address.py
<127.0.0.1> EXEC /bin/sh -c 'chmod u+x /home/xxx/.ansible/tmp/ansible-tmp-1675935210.624016-1699390-203071281737880/ /home/xxx/.ansible/tmp/ansible-tmp-1675935210.624016-1699390-203071281737880/AnsiballZ_netbox_ip_address.py && sleep 0'
<127.0.0.1> EXEC /bin/sh -c '/usr/bin/python3 /home/xxx/.ansible/tmp/ansible-tmp-1675935210.624016-1699390-203071281737880/AnsiballZ_netbox_ip_address.py && sleep 0'
<127.0.0.1> EXEC /bin/sh -c 'rm -f -r /home/xxx/.ansible/tmp/ansible-tmp-1675935210.624016-1699390-203071281737880/ > /dev/null 2>&1 && sleep 0'
The full traceback is:
  File "/tmp/ansible_netbox.netbox.netbox_ip_address_payload_mv6pvm2m/ansible_netbox.netbox.netbox_ip_address_payload.zip/ansible_collections/netbox/netbox/plugins/module_utils/netbox_utils.py", line 704, in _connect_netbox_api
    self.version = nb.version
  File "/usr/local/lib/python3.9/dist-packages/pynetbox/core/api.py", line 106, in version
    version = Request(
  File "/usr/local/lib/python3.9/dist-packages/pynetbox/core/query.py", line 187, in get_version
    raise RequestError(req)
fatal: [localhost]: FAILED! => {
    "changed": false,
    "invocation": {
        "module_args": {
            "cert": null,
            "data": {
                "address": "192.168.1.10",
                "assigned_object": null,
                "comments": null,
                "custom_fields": null,
                "description": null,
                "dns_name": null,
                "family": null,
                "interface": null,
                "nat_inside": null,
                "prefix": null,
                "role": null,
                "status": null,
                "tags": null,
                "tenant": null,
                "vrf": null
            },
            "netbox_token": "VALUE_SPECIFIED_IN_NO_LOG_PARAMETER",
            "netbox_url": "http://localhost/api/",
            "query_params": null,
            "state": "present",
            "validate_certs": false
        }
    },
    "msg": "Failed to establish connection to NetBox API"
}

A simple curl on the other hand works fine and also return the API version in the header.

curl -v -H 'Content-Type: application/json' http://localhost/api/
* Uses proxy env variable no_proxy == 'localhost,127.0.0.1,10.20.11.136'
*   Trying 127.0.0.1:80...
* Connected to localhost (127.0.0.1) port 80 (#0)
> GET /api/ HTTP/1.1
> Host: localhost
> User-Agent: curl/7.74.0
> Accept: */*
> Content-Type: application/json
>
* Mark bundle as not supporting multiuse
< HTTP/1.1 200 OK
< Content-Type: application/json
< Vary: Accept, Cookie, Origin
< Allow: GET, HEAD, OPTIONS
< API-Version: 3.4
< X-Content-Type-Options: nosniff
< Referrer-Policy: same-origin
< Cross-Origin-Opener-Policy: same-origin
< X-Frame-Options: SAMEORIGIN
< Content-Length: 419
< Server: Unit/1.27.0
< Date: Thu, 09 Feb 2023 09:55:00 GMT
<
* Connection #0 to host localhost left intact
{"circuits":"http://localhost/api/circuits/","dcim":"http://localhost/api/dcim/","extras":"http://localhost/api/extras/","ipam":"http://localhost/api/ipam/","plugins":"http://localhost/api/plugins/","status":"http://localhost/api/status/","tenancy":"http://localhost/api/tenancy/","users":"http://localhost/api/users/","virtualization":"http://localhost/api/virtualization/","wireless":"http://localhost/api/wireless/"}

Even calling the pynetbox.api function in a simple python script works

import pynetbox

nb = pynetbox.api('http://localhost')
print(nb.version)

# python3 netbox.py
3.4

[sc68cal]

netbox_url normally is just a FQDN, and does not include a path like /api/

Are you using some sort of proxy? The majority of people who have issues connecting to netbox via the plugin have some sort of proxy set up, which is difficult for us to troubleshoot from the outside. I would recommend not using a proxy, unless you absolutely understand what you are doing.

[PhilKet]

Thank you a lot for your help. It was my own fault. I previously had another error and tested around changing the netbox_url and adding /api/. After resolving the error I didn't change it back, expecting it to be right. It is all working fine now.