# Installation & Basic Settings

## Contents

- [Overview](#overview)
- [Prerequisites](#prerequisite-software)
- [Components of Network Configuration Manager](#components-of-network-configuration-manager)
- [Editions & scalability](#editions--scalability)
- [Installing Network Configuration Manager](#installing-network-configuration-manager)
  - [In Windows](#in-windows)
  - [In Linux](#in-linux)
- [Installing Network Configuration Manager on Linux using console mode/silent mode](#installing-network-configuration-manager-on-linux-using-console-modesilent-mode)
- [Installing Network Configuration Manager on Linux with MSSQL database](#installing-network-configuration-manager-on-linux-with-mssql-database)
- [Installing Network Configuration Manager with Kingbase DB](#installing-network-configuration-manager-with-kingbase-db)
- [Starting & Shutting Down Network Configuration Manager](#starting--shutting-down-network-configuration-manager)
- [Moving Network Configuration Manager installation](#moving-network-configuration-manager-installation-to-another-machine-or-moving-to-a-different-location-within-the-same-machine)
- [Licensing](#licensing)

## Overview

Welcome to ManageEngine Network Configuration Manager!

This section provides information on how to install Network Configuration Manager in your system. It also covers system requirements, installation steps, how to start and shut down the product, ports used by Network Configuration Manager, and licensing information.

## Prerequisite Software

No prerequisite software installation is required to use Network Configuration Manager. The standard system (hardware and software) requirements plus an external mail server (SMTP server) are essential for the functioning of the Network Configuration Manager server to send notifications to users.

## Components of Network Configuration Manager

The ManageEngine Network Configuration Manager consists of the following components:

- The Network Configuration Manager server (server and database)
- Built-in TFTP server running on port 69
- Built-in syslog server running on port 514
- JRE 1.8.181 bundled with Network Configuration Manager
- PostgreSQL 10.12 bundled with Network Configuration Manager
- SSH server

## Editions & scalability

Network Configuration Manager comes in two editions:

- Free edition: 2 devices, free forever
- Trial edition: Unlimited devices, free for 30 days
- Professional edition and Enterprise edition: Unlimited devices, paid version

Network Configuration Manager can monitor up to 5000 devices.

## Installing Network Configuration Manager

### In Windows

- Download and execute **ManageEngine_NetworkConfigurationManager.exe**. The installation wizard will guide you through the installation process.
- Choose an installation directory. By default, it will be installed in `C:/ManageEngine/NCM`. This installation directory path will be referred to as **NCM_Home**.
- You have the option to install Network Configuration Manager as a service. Uncheck the checkbox if you do not wish to install it as a service.
- In the final step, you will see two checkboxes—one for viewing the ReadMe file and the other for starting the server immediately after installation. If you choose to start the server immediately, it will start in the background. Since unpacking of JAR files occurs during the first startup, it may take some time to fully start.
- If you choose to start the server later, you can start it from **Start >> Programs >> ManageEngine Network Configuration Manager**.

### In Linux

1. Download **ManageEngine_NetworkConfigurationManager_64bit.bin** for Linux.
2. Log in as the `root` user.
3. Assign executable permission using:

   ```
   chmod a+x <file-name>
   ```

4. Execute the following command with administrator privileges (sudo):

   ```
   ./<file_name>
   ```

5. Follow the instructions displayed on the screen.
6. Network Configuration Manager will be installed in the specified location. This installation directory path will be referred to as **NCM_Home**.

## Installing Network Configuration Manager on Linux using console mode/silent mode

**Step 1:** Execute `ManageEngine_NetworkConfigurationManager_64bit.bin` with administrator privileges (sudo) and the `-i console` option.

![Execute Network Configuration Manager 64bit bin](https://www.manageengine.com/network-configuration-manager/help/images/A1.png)

**Step 2:** Review the license agreement and enter `Y` to proceed.

![License agreement for installation](https://www.manageengine.com/network-configuration-manager/help/images/ncm-linux-installation-2.PNG)

**Step 3:** Register for technical support by providing the required details (Name, E-mail ID, Phone, Company Name).

![Register for technical support](https://www.manageengine.com/network-configuration-manager/help/images/ncm-linux-installation-3.PNG)

**Step 4:** Select your location.

![Location selection](https://www.manageengine.com/network-configuration-manager/help/images/ncm-linux-installation-4.PNG)

**Step 5:** Choose the installation directory.

![Select installation folder](https://www.manageengine.com/network-configuration-manager/help/images/ncm-linux-installation-5.PNG)

**Step 6:** Configure the web server port.

![Enter web server port number](https://www.manageengine.com/network-configuration-manager/help/images/ncm-linux-installation-6.PNG)

**Step 7:** Verify the installation details and press `Enter` to complete the installation.

![Complete the installation](https://www.manageengine.com/network-configuration-manager/help/images/A2.png)

## Installing Network Configuration Manager on Linux with MSSQL database

From version 12.8.330, MSSQL database is supported for Linux setups. MSSQL cannot be configured directly from the installation wizard during Linux installation. Perform a default installation with PostgreSQL and then migrate the database to MSSQL.

**Note:** MSSQL database is not included with the Linux setup.

### Steps to migrate to MSSQL DB

After installation and before starting the product, follow these steps:

1. **Step 1:** In the terminal, go to `<Network Configuration Manager_Home>/bin` and execute `DBConfiguration.sh`.
2. **Step 2:** Provide the SQL Server details and the database name.
3. **Step 3:** Leave the **Migrate data from existing database** option unchecked.

![Migrating data](https://www.manageengine.com/network-monitoring/help/images/migrate-mssql.jpg)

4. **Step 4:** Click **OK** to start migration.

A success message will be displayed after migration completes.

**Note:**

- `DBConfiguration.sh` can be executed directly from a Linux machine or from X11-enabled environments.
- Executing `DBConfiguration.sh` in console mode is not supported.
- For BCP utility details, refer to:  
  [this link](https://www.manageengine.com/network-configuration-manager/help/system-requirements.html#bcp-linux)

## Installing Network Configuration Manager with Kingbase DB

...

## Starting & Shutting Down Network Configuration Manager

**Windows:**

Click **Start > Programs > ManageEngine Network Configuration Manager** to start the server.

**Linux:**

Navigate to `<NCM_Home>/bin` and execute:

```
StartOpManagerServer.sh
```

When the server starts, a command prompt window displays startup information. Once all modules are created, the following message appears:

```
Server started.
Please connect your client at http://localhost:8080
```

Replace `8080` with the configured web server port.

### Starting as Service

**Windows:**

If the **Start as Service** option was selected during installation, Network Configuration Manager runs as a Windows service.

**Linux:**

1. Log in as `root`.
2. Execute `StartOpManagerServer.sh` from `<NCM_Home>/bin`.

To stop Network Configuration Manager on Linux:

```
ShutDownOpManager.sh
```

#### Start as a service on Linux

1. Open Terminal and log in as `root`.
2. Navigate to the installation directory.
3. Execute:

   ```
   sh linkAsService.sh
   ```

   ![Starting OpM Linux 1](https://www.manageengine.com/network-monitoring/help/images/Starting-OpM-Linux-1.png)

4. Start the service:

   ```
   systemctl start OpManager.service
   ```

   or

   ```
   /etc/init.d/OpManager.service start
   ```

   ![Starting OpM Linux 2](https://www.manageengine.com/network-monitoring/help/images/Starting-OpM-Linux-2.png)

5. Check the service status:

   ```
   systemctl status OpManager.service
   ```

   or

   ```
   /etc/init.d/OpManager.service status
   ```

   ![Starting OpM Linux 3](https://www.manageengine.com/network-monitoring/help/images/Starting-OpM-Linux-3.png)

6. Stop the service:

   ```
   systemctl stop OpManager.service
   ```

   or

   ```
   /etc/init.d/OpManager.service stop
   ```

This starts Network Configuration Manager as a service on Linux.

### Checking required ports

The required ports must be free while starting the server. If any port is already in use, the server will not start.

**Windows:**

Use **Start >> Programs >> Network Configuration Manager >> Port Check**, or right-click the tray icon and select **Port Check**.

**Linux:**

Navigate to `<deviceexpert_home>/bin` and execute:

```
sh portcheck.sh
```

## Moving Network Configuration Manager installation to another machine or Moving to a different location within the same machine

### Prerequisite

1. Do not remove the existing installation until the new installation works properly. This ensures backup in case of data corruption or migration issues.

### Procedure

- Stop the Network Configuration Manager server/service.
- If installed as a startup service, remove it as a service before proceeding.
- Zip the entire installation folder and move it to the target machine or location.
- Install it again to run as a service.

### Installing as Startup Service

| Installing as Startup Service in Windows | Installing as Startup Service in Linux |
|---|---|
| **To install as service using batch file**<br><br>- Open a console and navigate to `<NCM_Installation_Folder>/bin`<br>- Execute:<br>`networkconfigurationmanager.bat install`<br><br>**To remove as service using batch file**<br><br>- Open a console and navigate to `<NCM_Installation_Folder>/bin`<br>- Execute:<br>`networkconfigurationmanager.bat remove` | **To Install as Service**<br><br>- Log in as `root`<br>- Open a console and navigate to `<NCM_Installation_Folder>/bin`<br>- Execute:<br>`sh networkconfigurationmanager.sh install`<br><br>**To Remove as Service**<br><br>- Execute:<br>`sh networkconfigurationmanager.sh remove` |

### Note:

- In this option, you cannot uninstall the program through the Windows Add/Remove Programs console. To uninstall, delete the entire installation folder.
- You do not need to reapply the license after moving the installation.

## Licensing

There are three license types:

- **Evaluation download:** Valid for 30 days and supports unlimited devices. After 30 days, management is limited to 2 devices.
- **Free Edition:** Manage up to 2 devices. To get a free license for an additional 2 devices, visit:  
  https://www.manageengine.com/network-configuration-manager/download-free.html
- **Professional Edition and Enterprise Edition:** License must be purchased based on the number of supported devices.
- For more information or to obtain a license, contact: [sales@manageengine.com](mailto:sales@manageengine.com)

Acknowledgement: This product includes software developed by SSHTools ([http://www.sshtools.com/](http://www.sshtools.com/)).