How to Configure Omada Controller Self-start as a Windows Service

Introduction

This document introduces how to configure Omada Controller as a Windows Service by using NSSM. At the same time, you can launch automatically when you turn on your PC for Omada Controller by way of Windows Service.

Prerequisites

1. A computer with the Omada Controller installed already.

2. Windows recommend version: Windows10 x64/Windows11 x64/Windows Server 2016 x64/Windows Server 2019 x64/Windows Server 2022 x64.

3. Controller Version Required: Omada Controller above 4.1.5, Omada Pro Controller above 1.0.

4. Download the NSSM – the Non-Sucking Service Manager (https://nssm.cc/download). We recommend to use the latest release. Use the file(nssm.exe) in the folder of win64.

Procedures

1. Extract nssm.exe to a convenient location, here I use “C:\NSSM” 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:\NSSM”.

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

Set the following parameters as listed below:

Application

Path:

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

Startup directory:

C:\Users\tplink\Omada Controller\bin\

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

Details

Display name:

Omada Controller Service

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 and the service of omada Controller is running. Then you can type http://127.0.0.1:8088 or https://127.0.0.1:8043 in web browser to login to the Omada Controller’s Web management page.

Note:

If you want to modify the above configuration, you can run Windows Command Line as administrator and cd to the path you placed nssm.exe (Refer to step 3). 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”

Get to know more details of each function and configuration please go to Download Center to download the manual of your product.