✶Update 09/2020✶ Omada Controller 3.2.10 for Debian, Raspbian and other Linux systems
This thread has been locked for further replies. You can start a new thread to share your ideas or ask questions.
Looking for Omada SDN Controller Linux version? It's here.
Last Update: 2020-09-07
[Update: To allow for version switching between different versions of the controller, V3.2.10 received an upgrade. You can install it over an existing V3.2.10 without losing data.]
I just made a .deb package with Omada Controller 3.2.10 for Debian, Raspbian and any other Linux system providing the dpkg installer. Please find the release notes at the end of this post.
This .deb package is in the tradition of the community version of Omada Controller, meaning it contains the same Java classes and remaining files as the official TP-Link version except for the binaries bundled with it (JRE, mongodb) and the start/stop script control.sh (which is replaced by my own version omadactl).
Prerequisites
You will need netstat (package: net-tools), curl and the native versions of JRE, jsvc and mongod (installed by default in Raspbian based on Stretch, unfortunately not so in Debian). Setting up the Oracle JRE and jsvc is left to you as an exercise; here are some suggestions:
Debian and any other Linux distribution:
Install mongodb from the standard repository and JRE8 from Oracle's website. As for jsvc, don't use the Debian binary package, it requires OpenJDK last time I checked this. Instead, get the source code for jsvc (command apt-get source jsvc), compile it and install jsvc manually. Sorry for this inconvenience, but TP-Link decided to use jsvc for Privilege Separation rather than the much more common standard start-stop-daemon or daemonize programs already present on almost any Linux system. Don't blame me for this – omadactl still can use both methods, but you need to use jsvc for Omada Controller versions V3.x.
Raspbian (see also »Limitations« below):
Oracle JRE8, jsvc and mongodb are pre-installed by default in Raspbian (make sure you did not explicitly choose OpenJDK as an alternative for the Oracle JRE). You can easily check whether the required programs are installed on your Raspbian:
$ java -version
java version "1.8.0_261"
Java(TM) SE Runtime Environment (build 1.8.0_261-b12)
Java HotSpot(TM) 64-Bit Server VM (build 25.261-b12, mixed mode)
$ update-java-alternatives -l
jdk-8-oracle-arm32-vfp-hflt 318 /usr/lib/jvm/jdk-8-oracle-arm32-vfp-hflt
$ mongod -version
db version v2.4.14
Thu Apr 30 12:49:28.060 git version: nogitversion
$
Donwload the all-architectures .deb package
Download https://rent-a-guru.de/ftp/omada-controller_3.2.10-3_all.deb
Compare the checksum of the downloaded .deb file for integrity:
$ md5sum -b omada-controller_3.2.10-3_all.deb
6b986ee67828d4c1e55d8dc6af1e8cbc *omada-controller_3.2.10-3_all.deb
or:
$ sha256sum -b omada-controller_3.2.10-3_all.deb
ef77aa88a3196d7663f35e59357a67833b86fa783923df480f56318ea84e5de2 *omada-controller_3.2.10-3_all.deb
Installation
First, make a backup of your Omada Controller's settings before installing. Either use the web UI or copy the whole content of the subdirectory data in /opt/tplink/OmadaController to a backup directory. You can later move the data directory back into the new controller version.
Install the new version of Omada Controller with:
dpkg -i omada-controller_3.2.10-3_all.deb
After a successful installation the controller will be started automatically.
Notes:
- Ignore the warnings from dpkg about some directories which can't be deleted. dpkg will remove files from older versions of the same package omada-controller, but it won't delete the old database directory (unless you do a manual purge before installing). This means that your database and settings from previous versions of Omada Controller will be retained - you can copy the files in the data subdirectory over to the new version. See »Restoring Omada Controller settings« below.
- Installation directory is /opt/tplink/OmadaController-3.2.10. The symlink /opt/tplink/OmadaController is a short-hand alias to the installation directory.
- Start/stop script has been renamed from tpeap to omadactl (
deprecatedtpeap is still there, it's a symlink to omadactl).
Update: tpeap has been finally removed.
If installing using dpkg, you won't be able to switch between versions of Omada Controller using omadactl's switch command.
Update: The current release of V3.2.10 now allows to switch between this and any newer controller versions.
- Some options of omadactl have no effect with only one version of the controller installed, that is if you install the .deb-Package. dpkg will override the old version before installing the new one. However, since the installation directoy reflects the version (intentionally!), you find all settings in the data subdirectory of the old version's installation directory. See »Restoring Omada Controller settings« below.
- On my RasPi the start of the controller needs ~69 seconds (first time start: ~124 seconds). You might want to increase the standard time-out (70 sec.) for starting the controller if it needs more time on your RasPi (time depends on other active processes during the start). To change the default time-out, use omadactl -S num, where num is the new time-out in seconds. This command will store the new time-out permanently in omadactl's config file and exits immediately (without starting Omada Controller).
Restoring Omada Controller settings
There is an easy way to restore your controller's settings using omadactl. Let's say you want to update Omada Controller 3.2.9 to 3.2.10. The directory OmadaController-3.2.9 will be cleaned by dpkg before it installs the new version in a new directory OmadaController-3.2.10. However, user files will be retained (dpkg prints warnings about which directories are not removed). Now stop the new controller using omadactl and use omadactl with the copydb command:
omadactl -w stop
omadactl copydb OmadaController-3.2.9 OmadaController-3.2.10
This will copy all settings under the data subdirectory from the old version to the new version. Restart the controller and you will see all your EAPs, settings, maps etc. If everything works, you can safely remove the old directory using rm -rf OmadaController-3.2.9.
Limitations
Keep in mind that under Rasbian, which still is a 32-bit OS for compatibility with older Pis, mongodb has a 2GB limit for the size of the database. You could compile a 64-bit kernel / userland programs to get rid of this limit.
If Omada Controller doesn't start automatically on reboot of the RasPi, check with systemctl whether the omadad.service is enabled.
Omada Controller on RasPi is slooooooow, especially if initializing the environment at the first start. Start it with omadactl -W 240, note the time it needs to start (omadactl will print a message) and set the time + a 10 seconds reserve using omadactl -S num, where num is the new time-out in seconds (see the manpage).
More information
For help with omadactl see its manpage attached to this post or use the command: man omadactl2
For customization of omadactl see the config file /etc/default/omada.
Update: has been merged into file CONFIG in /opt/tplink/OmadaController.
For selection of the correct JRE see file CONFIG in /opt/tplink/OmadaController.
For a list of all files installed by the .deb package use the command: dpkg -L omada-controller
If you want to uninstall this .deb package (except the database and other files created at run-time), use the »remove« option of dpkg: dpkg -r omada-controller
If you want to uninstall this .deb package (including the database and other files created at run-time), use the »purge« option of dpkg: dpkg -P omada-controller
Release notes for omadactl version 3.0 in package 3.2.10-3
Bugs fixed:
- Fixed non-working verbose option (-v) in omadactl.
New features:
- Changed version dependencies for mongodb: The controller needs either mongodb v2.4 or mongodb-org v3.2.
Release notes for omadactl version 3.0 in package 3.2.10-2
Bugs fixed:
- Fixed a bug in the DEBIAN/control file.
New features:
- Updated omadactl and omadad to version 3.0. The files are no longer installed in /usr/bin and /etc/init.d, but are included in Omada Controller's home dir. The installer adds symlinks for those commands in /usr/bin and /etc/init.d.
- Enabled support in omadactl for switching between controller versions when more than one Omada Controller is installed.
- Merged /etc/default/omadad and /opt/tplink/OmadaController/CONFIG.
Release notes for Omada controller version 3.2.10-1
Bugs fixed by TP-Link:
- Fixed the bug that Omada Controller allow any user to read the files of controller.
- Fixed the bug that controller will report an error when Top Usage data is empty.
Have fun!
- Copy Link
- Subscribe
- Bookmark
- Report Inappropriate Content
hello, is there a way to have the compatibilty with SDN 4.1.5 and an EAP 245 V1 ?
In my case I have 2 EAP, one V1 and one V3, is it planed a firmware upgrade for the V1 ?
Thank you in advance for your reply.
- Copy Link
- Report Inappropriate Content
TheYort73 wrote
hello, is there a way to have the compatibilty with SDN 4.1.5 and an EAP 245 V1 ?
Unfortunately no. Please see the SDN Controller FAQ, questions #5 and #6.
- Copy Link
- Report Inappropriate Content
/opt/tplink/OmadaController/bin# ./mongod --version
db version v3.6.3
git version: 9586e557d54ef70f9ca4b43c26892cd55257e1a5
OpenSSL version: OpenSSL 1.1.1 11 Sep 2018
allocator: tcmalloc
modules: none
build environment:
distarch: x86_64
target_arch: x86_64
Some notes:
1) you need to remove --nohttpinterfaces from mongodb.properties or it can't start
2) You need to install Java 8, 11 is the default. I went with headless pkg.
3) You need to set the JAVA_HOME in /etc/defaults/omada to JAVA_HOME=/usr/lib/jvm/java-8-openjdk-amd64
4) You need to disable mongodb from startup by the system. systemctl disable mongodb, otherwise it seems to kill the instance (I could be wrong here)
- Copy Link
- Report Inappropriate Content
Hi zinner,
zinner wrote
1) you need to remove --nohttpinterfaces from mongodb.properties or it can't start
2) You need to install Java 8, 11 is the default. I went with headless pkg.
3) You need to set the JAVA_HOME in /etc/defaults/omada to JAVA_HOME=/usr/lib/jvm/java-8-openjdk-amd64
4) You need to disable mongodb from startup by the system. systemctl disable mongodb, otherwise it seems to kill the instance (I could be wrong here)
1) Yes, applies to all system which use mongodb > v2.4.
2) As I wrote. JRE8 is needed.
3) If you manually install a symlink for the java executable in /usr/bin/java or (even better) use update-alternatives to install such a symlink, omadactl computes the value of JAVA_HOME automatically from the real pathname, no need to set it, but doesn't harm either:
$ update-alternatives --list java # Debian, manually installed
/opt/jvm/jre1.8.0_251/bin/java
$
$ update-alternatives --list java # Raspbian, package-provided
/usr/lib/jvm/jdk-8-oracle-arm32-vfp-hflt/jre/bin/java
$
Note that /etc/default/omadad has been merged with /opt/tplink/OmadaController-3.2.10/CONFIG for package version omada-controller_3.2.10-2 (that's package release 2) and it's not used anymore. Reason is that it prevented to install Omada SDN Controller 4.1.5 package at the same time w/o removing the 3.2.10 Omada Controller package. So it had to go into Omada Controller's home.
4) Correct for systems running systemd. That's unfortunately caused by the way Omada Controller starts an own mongod instance instead just connecting to the running one (a typical Windows-ism).
- Copy Link
- Report Inappropriate Content
I just was reading your response and realized something. I forgot you to thank you for your work creating this package and all the surrounding support.
- Copy Link
- Report Inappropriate Content
Hi zinner, you're welcome. Thanks for your nice words!
- Copy Link
- Report Inappropriate Content
Linux noob here...
Is there a way to autostart omadactl upon a Rpi reboot? I'm using Rpi OS (aka Rasbian). I might have missed it in the 16 pages of comments. Thanks in advance!
And thanks for heading up this project.
Salud!
- Copy Link
- Report Inappropriate Content
@Stonewall77 Depends on level os, but with
older os:
update-rc.d omadad defaults
or with the newer systemd:
systemctl enable omadad
That should be enough
- Copy Link
- Report Inappropriate Content
I'm running the systemctl enable command and it keeps throwing off
omadad.service is not a native service, redirecting to systemd-sysv-install
Executing: /lib/systemd/systemd-sysv-install enable
Any hints? I am running the latest rasbian OS.
- Copy Link
- Report Inappropriate Content
Hi @Stonewall77,
just use: update-rc.d omadad enable. This is, btw, executed by the dpkg installer by default when installing the omada-controller package.
Stonewall77 wrote
I'm running the systemctl enable command and it keeps throwing off
omadad.service is not a native service, redirecting to systemd-sysv-install
Executing: /lib/systemd/systemd-sysv-install enable
This is typical verbose garbagge by systemctl informing you that the omada-controller package does not have a native systemd-conforming service file. It therefore will execute a compatibility hook which installs the traditional start/stop script included in the package using the command update-rc.d omadad enable. You can save yourself time and confusion by just running the latter command manually.
When rebooting the RasPi, the Omada Controller will be started automatically, but it needs an eternity or two on a RasPi until it completes the startup. You can check the current status of the controller with the command omadactl status.
If the automatic start at reboot fails, check whether the manual start of the controller also fails. Use omadactl -W 240 start or omadactl -v start to start it manually and omadactl status to find out what happens at start. Please see the manpage of omadactl(8) for details and for tips what to do if the start of the controller needs too much time on a RasPi.
And run sudo -i to switch to the root account permanently before issuing any of the above commands, so you don't have to type sudo before every command.
Hope this helps!
- Copy Link
- Report Inappropriate Content
Information
Helpful: 11
Views: 78482
Replies: 168
Voters 11
