✶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
Can we please get a new topic for each release?
1) Ensures that the issues reported are specific to that version;
2) Allows someone to download older versions from the desired topic;
3) Communication of a newer version can always be posted on the old version's topic to notify users.
4) It's a good practice and common with other vendors;
5) Also common is to have one sticky topic with all the posted versions, and the link to the latest.
Also, I don't see the release notes from this latest version 3.2.6 on this topic or in the TP-Link download center.
- Copy Link
- Report Inappropriate Content
Hello @LucianoR,
you mean a new thread for every new version? No. This thread is sticky and just the topic changes. If I would open a new thread, it would disappear from this page after only few other new posts and could not be found easily by people not reading on a daily base here.
Please note that I am not from TP-Link and this community version of Omada Controller is not endorsed by TP-Link either.
This packaging of the community version is done voluntarily by me and since just the topic and the download filename changes for each new version, it makes not much sense to repeat the same text over different threads again and again as it was done in the past.
As for the older versions I don't recommend using them except for EAP controller v2.7 if you have older EAP hardware. In threads for the legacy EAP controller version 2.7 and older I already add links to this thread with the latest version.
If you think it would be useful to have links to the older download packages in this thread too, I could append a list of outdated packages at the end of the post if you like. But note that I won't keep every old version on my server since in the past some people did download all and every packages despite they finally used only the latest one.
As for the release notes you are right, they should be included in the post. I have added them. Thanks for the suggestion.
As for issues with the software: Feel free to open a new thread if you found issues with any version of Omada Controller – since the community version contains exactly the same software (except that it avoids the bundled binaries from the TP-Link version and adds improved scripts for the start/stop mechanism), allmost all issues always apply to all versions, not just the community version. The only difference between both versions is omadactl in the community version versus control.sh in the official version for managing the controller and the absence of binaries (jre, monogd) which makes the community version package architecture-independent.
Alternatetively you can add any issue with the software to this thread, but to reach more readers a new thread would be better.
- Copy Link
- Report Inappropriate Content
@R1D2 Okay, I understand your arguments and won't debate that - I have a difference of opinion but I respect your perspective. And the products (EAP225v3 and the Omada controller) are great.
I just upgraded the Omada Controller from 3.2.4 to 3.2.6, after you published the release notes. Thank you for that.
- Copy Link
- Report Inappropriate Content
@LucianoR, you're welcome.
My goal was (and still is) that TP-Link adds some modifications to their official version from my community version (they did already accept some suggestions, but not all), so in the end they could release a single architecture-independent version suitable for UNIX and Linux no matter whether based on x86, x86_64, arm, mips etc. theirself. They then could post separate announcements and make those posts sticky, what I as a plain user can't do.
- Copy Link
- Report Inappropriate Content
- Copy Link
- Report Inappropriate Content
@Ferse, try passive mode in FTP and avoid browser-based FTP clients. The FTP directory intentionally can not be listed, but graphical FTP clients always try to do so. It's best to use the FTP command line utility on your Linux system.
Note that this version of Omada Controller won't install nor run on Windows (just in case you intend to use it there).
- Copy Link
- Report Inappropriate Content
@R1D2 I could not by command line either and the FTP server banned me. Can you help me by downloading the debian package and sending it to the mail
ferse@msn.com
R1D2 wrote
@Ferse, try passive mode in FTP and avoid browser-based FTP clients. The FTP directory intentionally can not be listed, but graphical FTP clients always try to do so. It's best to use the FTP command line utility on your Linux system.
Note that this version of Omada Controller won't install nor run on Windows (just in case you intend to use it there).
- Copy Link
- Report Inappropriate Content
@Ferse I can confirm it worked fine on my freeBSD based FTP client (that's what I had around :))
Try this
ftp ftp.rent-a-guru.de
login: anonymous
password: <your email>
cd private
get omada-controller_3.2.6-1_all.deb
I can confirm, it doesn't work over wget on debian or ftp on windows.
As the file is 44mb, it's unlikely it can be attached to an email.
- Copy Link
- Report Inappropriate Content
@elmado ok thanks for your help. I have win10. What I tried with the windows cmd and with the putty ftp. What ftp client do you recommend for raspbian?
- Copy Link
- Report Inappropriate Content
Thanks, I was able to download the package. For windows it is not possible. It was done with raspbian
thanks
- Copy Link
- Report Inappropriate Content
Information
Helpful: 11
Views: 73616
Replies: 168
Voters 11
