How to Configure Omada Controller as a Windows Service(above Controller 4.1.5)

This document is suitable for Omada Controller V4.1.5 or above. For Omada Controller V2.5.4 or above, please refer to FAQ 2273.

Introduction

This document introduces how to configure Omada Controller as a Windows Service by using NSSM.

Prerequisites

1. A computer with the Omada Controller installed already.

2. Download the NSSM – the Non-Sucking Service Manager (https://nssm.cc/download)

Procedures

1. Extract nssm.exe to a convenient location, here I use “C:\User\Administrator\TP-LINK” as an example.

2. Make sure you have run Omada Controller before, or you can just keep Omada Controller running during this operation.

3. Run Windows Command Line as administrator and cd to the path you placed nssm.exe. Here is the C:\User\Administrator\TP-LINK.

4. Type nssm install “Omada Controller” to create a new Service using nssm. 

Set the following parameters as listed below:

Application

Path:

C:\Users\Administrator\Omada Controller\bin\start.bat

Startup directory:

C:\Users\Administrator\Omada Controller\bin\

Note: Here we install Omada controller at C:\Users\Administrator\Omada Controller. You should use the installed path of controller.

Details

Display name:

Omada Controller by default

Description:

Add one if you want

Startup type:

Automatic

Log on

Local System account and select “Allow service to interact with desktop”

5. Click Install service and will show you the successful note.

6. After the Omada Controller service is successfully set up, please restart your computer and the Omada Controller service will startup automatically. Please check on Windows Task Manager to see if the java.exe and mongod.exe are running properly. Then you can type http://127.0.0.1:8088 or https://127.0.0.1:8043 to login to the Omada Controller’s Web management page.

Note:

1. Run Windows Command Line as administrator and and cd to the path you placed nssm.exe. Type in the following commands to manage the service.

(1) nssm edit “Omada Controller”

(2) nssm start “Omada Controller”

(3) nssm stop “Omada Controller”

(4) nssm restart “Omada Controller”

(5) nssm status “Omada Controller”

(6) nssm remove “Omada Controller”

For the above step 4, you can also use another setting.

Path:

C:\Program Files\Java\jre1.8.0_261\bin\java.exe

Arguments:

-server -Xms128m -Xmx1024m -XX:MaxHeapFreeRatio=60 -XX:MinHeapFreeRatio=30 -XX:+HeapDumpOnOutOfMemoryError -cp " C:\Users\Administrator\Omada Controller\lib\*" com.tplink.omada.start.OmadaMain

The startup directory and other settings still keep the same as the above.

And we need to set JAVA_HOME in system variable just like the follows.

Note: Here we install Java at C:\Program Files\Java\jre1.8.0_261. You should use the installed path of Java.