[UNFIMP] UNFIMP_port is ignored when UNFIMP_version is set to UDMP-unifiOS

[meeowgler]

What installation are you running?

Production (netalertx) 📦

Is there an existing issue for this?

• I have searched the existing open and closed issues and I checked the docs https://docs.netalertx.com/

The issue occurs in the following browsers. Select at least 2.

• Firefox
• Chrome
• Edge
• Safari (unsupported) - PRs welcome
• N/A - This is an issue with the backend

Current Behavior

With the Unifi Import plugin, [UNFIMP] UNFIMP_port is ignored when UNFIMP_version is set to UDMP-unifiOS.

You might wonder why UDMP-unifiOS would have a port other than 443. The new self-hosted Unifi OS Server (https://ui.com/download/software/unifi-os-server) presents itself as a UDMP-unifiOS compatible device, but hosts the UI/API on an alternate port.

Expected Behavior

When UNFIMP_port is configured, use this value even when UNFIMP_version is set to UDMP-unifiOS.

Steps To Reproduce

No response

Relevant app.conf settings

docker-compose.yml

Debug or Trace enabled

• I have read and followed the steps in the wiki link above and provided the required debug logs and the log section covers the time when the issue occurs.

Relevant app.log section

14:25:44 [Plugin utils] ---------------------------------------------
14:25:44 [Plugin utils]  display_name :  UniFi import
14:25:44 [Plugins] CMD: python3 /app/front/plugins/unifi_import/script.py username={username} password={password}  host={host} sites={sites} port={port} verifyssl={verifyssl} version={version} fullimport={fullimport}
14:25:44 [Plugins] Resolving param: {'name': 'port', 'type': 'setting', 'value': 'UNFIMP_port'}
14:25:44 [Plugins] setTyp: {'dataType': 'string', 'elements': [{'elementType': 'input', 'elementOptions': [], 'transformers': []}]}
14:25:44 [Plugins] setTypJSN: {'dataType': 'string', 'elements': [{'elementType': 'input', 'elementOptions': [], 'transformers': []}]}
14:25:44 [Plugins] dType: string
14:25:44 [Plugins] Resolved value: 11443

14:25:45 [UNFIMP] In script
14:25:45 [UNFIMP] Full import needs to be done: config_value: once and lock_file_value: False
14:25:45 [UNFIMP] sites: ['default']
14:25:45 [UNFIMP] site: default
Traceback (most recent call last):
  File "/opt/venv/lib/python3.12/site-packages/urllib3/connection.py", line 204, in _new_conn
    sock = connection.create_connection(
           ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
  File "/opt/venv/lib/python3.12/site-packages/urllib3/util/connection.py", line 85, in create_connection
    raise err
  File "/opt/venv/lib/python3.12/site-packages/urllib3/util/connection.py", line 73, in create_connection
    sock.connect(sa)
TimeoutError: [Errno 110] Operation timed out

The above exception was the direct cause of the following exception:

Traceback (most recent call last):
  File "/opt/venv/lib/python3.12/site-packages/urllib3/connectionpool.py", line 787, in urlopen
    response = self._make_request(
               ^^^^^^^^^^^^^^^^^^^
  File "/opt/venv/lib/python3.12/site-packages/urllib3/connectionpool.py", line 488, in _make_request
    raise new_e
  File "/opt/venv/lib/python3.12/site-packages/urllib3/connectionpool.py", line 464, in _make_request
    self._validate_conn(conn)
  File "/opt/venv/lib/python3.12/site-packages/urllib3/connectionpool.py", line 1093, in _validate_conn
    conn.connect()
  File "/opt/venv/lib/python3.12/site-packages/urllib3/connection.py", line 759, in connect
    self.sock = sock = self._new_conn()
                       ^^^^^^^^^^^^^^^^
  File "/opt/venv/lib/python3.12/site-packages/urllib3/connection.py", line 213, in _new_conn
    raise ConnectTimeoutError(
urllib3.exceptions.ConnectTimeoutError: (<HTTPSConnection(host='10.1.30.50', port=443) at 0x7f0f016cfd10>, 'Connection to 10.1.30.50 timed out. (connect timeout=None)')

The above exception was the direct cause of the following exception:

Traceback (most recent call last):
  File "/opt/venv/lib/python3.12/site-packages/requests/adapters.py", line 644, in send
    resp = conn.urlopen(
           ^^^^^^^^^^^^^
  File "/opt/venv/lib/python3.12/site-packages/urllib3/connectionpool.py", line 841, in urlopen
    retries = retries.increment(
              ^^^^^^^^^^^^^^^^^^
  File "/opt/venv/lib/python3.12/site-packages/urllib3/util/retry.py", line 535, in increment
    raise MaxRetryError(_pool, url, reason) from reason  # type: ignore[arg-type]
    ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
urllib3.exceptions.MaxRetryError: HTTPSConnectionPool(host='10.1.30.50', port=443): Max retries exceeded with url: /api/auth/login (Caused by ConnectTimeoutError(<HTTPSConnection(host='10.1.30.50', port=443) at 0x7f0f016cfd10>, 'Connection to 10.1.30.50 timed out. (connect timeout=None)'))

Docker Logs

 _   _      _    ___  _           _  __   __

| \ | |    | |  / _ \| |         | | \ \ / /

|  \| | ___| |_/ /_\ \ | ___ _ __| |_ \ V /

| .   |/ _ \ __|  _  | |/ _ \  __| __|/   \

| |\  |  __/ |_| | | | |  __/ |  | |_/ /^\ \

\_| \_/\___|\__\_| |_/_|\___|_|   \__\/   \/

   Network intruder and presence detector.

   https://netalertx.com

Startup pre-checks

--> data migration.sh 

--> capabilities audit.sh 

--> mounts.py 

 Path                     | R | W | Mount | RAMDisk | Performance | DataLoss 

--------------------------+---+---+-------+---------+-------------+----------

 /data                    | ✅| ✅|   ✅  |    ➖   |      ➖     |    ✅     

 /data/db                 | ✅| ✅|   ✅  |    ➖   |      ➖     |    ✅     

 /data/config             | ✅| ✅|   ✅  |    ➖   |      ➖     |    ✅     

 /tmp/run/tmp             | ✅| ✅|   ✅  |    ✅   |      ✅     |    ✅     

 /tmp/api                 | ✅| ✅|   ✅  |    ✅   |      ✅     |    ✅     

 /tmp/log                 | ✅| ✅|   ✅  |    ✅   |      ✅     |    ✅     

 /tmp/run                 | ✅| ✅|   ✅  |    ✅   |      ✅     |    ✅     

 /tmp/nginx/active-config | ✅| ✅|   ✅  |    ✅   |      ✅     |    ✅     

--> first run config.sh 

--> first run db.sh 

--> mandatory folders.sh 

    * Creating NetAlertX log directory.

    * Creating NetAlertX API cache.

    * Creating System services runtime directory.

    * Creating nginx active configuration directory.

    * Creating Plugins log.

    * Creating System services run log.

    * Creating System services run tmp.

    * Creating DB locked log.

    * Creating Execution queue log.

--> apply conf override.sh 

--> writable config.sh 

--> nginx config.sh 

--> expected user id match.sh 

--> host mode network.sh 

--> excessive capabilities.sh 

--> appliance integrity.sh 

══════════════════════════════════════════════════════════════════════════════

⚠️  Warning: Container is running as read-write, not in read-only mode.

    Please mount the root filesystem as --read-only or use read_only: true

    https://docs.netalertx.com/docker-troubleshooting/read-only-filesystem

══════════════════════════════════════════════════════════════════════════════

--> ports available.sh 

APP_CONF_OVERRIDE detected (set from GRAPHQL_PORT)

Starting /usr/sbin/php-fpm83 -y "/services/config/php/php-fpm.conf" -F (tee stderr to app.php_errors.log)

Starting supercronic --quiet "/services/config/cron/crontab" >>"/tmp/log/cron.log" 2>&1 &

Starting python3  -m server > /tmp/log/stdout.log 2> >(tee /tmp/log/stderr.log >&2)

Starting /usr/sbin/nginx -p "/tmp/run/" -c "/tmp/nginx/active-config/nginx.conf" -g "error_log stderr; error_log /tmp/log/nginx-error.log; daemon off;" &

Successfully updated IEEE OUI database (113040 entries)

[jokob-sk]

Thanks for the report — I’ve investigated this further and can confirm this is not an issue in the NetAlertX plugin itself, but comes from how pyunifi handles UniFi OS connections.

The plugin correctly reads and passes the configured port:

[Plugins] Resolved value: 11443

However, the actual connection attempt is made to port 443:

HTTPSConnection(host='10.1.30.50', port=443)

So the configured port is being ignored downstream.

Looking into the pyunifi source, the URL construction for UniFi OS appears to override or ignore the provided port. For example:

https://github.com/finish06/pyunifi/blob/78174d580633edc5d164648167f37bb3f04e1416/pyunifi/controller.py#L98

In this code path, requests are built assuming the default UniFi OS setup (HTTPS on port 443), which works for physical UniFi OS devices (UDM, CloudKey), but breaks for setups where:

• UniFi OS is self-hosted
• The controller is exposed on a non-standard port (e.g. 11443)

Expected behaviour:
If a port is explicitly configured, it should be respected regardless of the selected version.

At the moment, this limitation is coming from pyunifi itself, so fixing it would require a change upstream.

As a workaround, you can try using a non-UDMP version mode (if compatible), or exposing the controller on port 443.

In short - I can't do anything unless the maintainer of pyunifi fixes this, which is highly unlikely as there was no activity on the repo for 5 years. Feel free to try to submit a bug report on the upstream repo. An alternative is to switch to a different port or me maintaining the code, but I don't have time with the current workload keeping NAX welll maintained.

Partially because of this I created a separate UNIFIAPI plugin which you can try instead: https://github.com/netalertx/NetAlertX/tree/main/front/plugins/unifi_api_import

[jokob-sk]

Updated the README to mention this limitation: https://github.com/netalertx/NetAlertX/tree/main/front/plugins/unifi_import

LMK if you have any other suggestions

[meeowgler]

Thanks for looking into that! UNIFIAPI does work, but it limits imported Unifi devices and clients to 25 max. Is there a way to configure this limit?

18:47:14 [UNIFIAPI] Site: Default unifi devices: {
  "offset": 0,
  "limit": 25,
  "count": 25,
  "totalCount": 29,
  "data": [...]
18:47:14 [UNIFIAPI] Site: Default clients: {
  "offset": 0,
  "limit": 25,
  "count": 25,
  "totalCount": 285,
  "data": [...]

[jokob-sk]

Thanks... that might be a bug. I tried to fix it.

Once this action finishes, can you try the dev image? https://github.com/netalertx/NetAlertX/actions/runs/22167207329/job/64097075377

To test it switch to the ghcr.io/netalertx/netalertx-dev Docker image in ~15 minutes (or once the latest GitHub Action finishes).

⚠️ Please back up everything first, or ideally spin up a separate container with its own DB and config (a copy of your current setup), as database changes may occur.

After updating:

• Click the 🔄 refresh button in the blue header at the top
• Hard refresh your browser cache (shift + reload) to force js and css files reload

Disclaimer: Running the dev container long-term may lead to data loss, as upgrade paths are not guaranteed.

Thanks in advance,
j

[meeowgler]

Running the new dev image, it logs this now:

08:45:21 [UNIFIAPI] Site: Default (88f7af54-98f8-306a-a1c7-c9349722b1f6)
/opt/venv/lib/python3.12/site-packages/urllib3/connectionpool.py:1097: InsecureRequestWarning: Unverified HTTPS request is being made to host '10.1.30.50'. Adding certificate verification is strongly advised. See: https://urllib3.readthedocs.io/en/latest/advanced-usage.html#tls-warnings
  warnings.warn(
Traceback (most recent call last):
  File "/app/front/plugins/unifi_api_import/unifi_api_import.py", line 183, in <module>
    main()
  File "/app/front/plugins/unifi_api_import/unifi_api_import.py", line 64, in main
    device_data = get_device_data(site, api)
                  ^^^^^^^^^^^^^^^^^^^^^^^^^^
  File "/app/front/plugins/unifi_api_import/unifi_api_import.py", line 102, in get_device_data
    unifi_devices = unifi_devices_resp.get("data", [])
                    ^^^^^^^^^^^^^^^^^^^^^^
AttributeError: 'list' object has no attribute 'get'

[jokob-sk]

Thanks - hopefully fixed now. Can you re-download the image and try again - it's a bit troublesome to test as I have exactly 25 devices, which is also the default page size 🙄 double check you have the latest build as images can be cached. If unsure, and still experiencing errors, you can ssh into the container and the version should show 0.2.3:

pip index versions unifi-sm-api
unifi-sm-api (0.2.3)
Available versions: 0.2.3, 0.2.2, 0.2.1, 0.1.0
  INSTALLED: 0.2.3
  LATEST:    0.2.3

[meeowgler]

Thanks - hopefully fixed now. Can you re-download the image and try again - it's a bit troublesome to test as I have exactly 25 devices, which is also the default page size 🙄 double check you have the latest build as images can be cached. If unsure, and still experiencing errors, you can ssh into the container and the version should show 0.2.3:

pip index versions unifi-sm-api
unifi-sm-api (0.2.3)
Available versions: 0.2.3, 0.2.2, 0.2.1, 0.1.0
INSTALLED: 0.2.3
LATEST: 0.2.3

It works! Thank you!!!