How Can We Help?
You are here:
Print

zMAN Installation Guide

1. zMan Director Components

zMan Director

The zMan Director serves as a centralized management tool for IT administrators to manage, configure, activate, and monitor zTC devices through the Management UI.

zDM (Device Management Server)

zDM is a component of zMan Director that receives management commands from zMan and relays them to zTC devices using the CoAP-based LwM2M protocol.

2. System Requirements

VM Requirements for zMan

  • Storage (SSD): 256GB
  • Memory: 16GB
  • CPU: 4 cores

VM Requirements for zDM

  • Storage (SSD): 32GB
  • Memory: 2GB
  • CPU: 2 cores

Software Requirements

  • Ubuntu Desktop 22.04 OS
  • zMan Director Binaries
  • zDM Binaries

3. Installing zMan Director

Step 1: Prepare the System

  1. Install Ubuntu Desktop OS version 22.04.
  2. Run the following commands:
    $ sudo apt-get install net-tools
    $ sudo apt-get install openssh-server
    $ sudo apt install p7zip-full

Step 2: Extract and Set Up zMan Director

    1. Create a folder named zMan.
    2. Copy the binary zManDirector-x.x.x.7z into the zMan folder.
    3. Extract the package:
      $ 7z x zManDirector-x.x.x.7z
    4. Navigate to /zMan/deployment/setup and run the prerequisite script:
      $ sudo ./pre_req.sh
    5. Edit setup.sh and configure the zMan Director IP and SSH credentials in master.yml:
# Server 1 IP, user, password details
- ip: <zMan Director IP>
  port: 22
  user: <username>
  password: <password>
    1. If using WAN access, enter the WAN IP or FQDN in external_ip.
    2. By default, zDM is installed alongside zMan Director. To skip zDM installation, set:
      install_zdmserver: 0

Step 3: Updating Credentials

For security, change the default credentials either:

  • During installation via prompts.
  • Manually by editing deployment/setup/host-templates/vars_main.yml.

Step 4: Install zMan Director

$ sudo ./setup.sh standalone

The installation takes approximately 1 hour and 15 minutes.

Once completed, access zMan Director:

URL: https://<zMan IP>/zman-tenant
Username: [email protected]
Password: xxxxx

Uninstall zMan Director

$ sudo ./setup.sh standalone cleanup

4. Installing zDM Server

Step 1: Prepare the System

  1. Ensure zMan Director is installed.
  2. Install Ubuntu Desktop OS version 22.04.
  3. Run:
    $ sudo apt install p7zip-full

Step 2: Extract and Install zDM

  1. Create a folder named zDM.
  2. Copy zdm-deployment-x.x.x.7z into zDM.
  3. Extract the package:
    $ 7z x zdm-deployment-x.x.x.7z
  4. Navigate to /zDM/zdm-deployment and execute:
    $ sudo ./zdm-setup.sh

Step 3: Register zDM with zMan Director

    1. Provide:
        • zMan Director URL
        • Access Key
        • zDM IP

    2. Verify registration in zMan Director:
Server Configuration → zDM Management → Pending zDM
    1. Once onboarded, it moves to:
Server Configuration → zDM Management → Onboarded zDM

Uninstall zDM

$ sudo ./zdm-setup.sh

Choose option 5: Uninstall zDM Server. A reboot is required.

5. Registering zTC to zMan Director

    1. Retrieve the zTC ID (MAC address) from:
Start Menu → Applications → Management Server Configurator

    1. Import or manually add zTCs in:
      Server Configuration → Onboarding



    2. Assign zTCs to zDM.
    3. Initiate registration from the zTC side by navigating to:
      Start Menu → Applications → Management Server Configurator

    4. In zMan Director the registered zTC will be listed under:
      Device Management → zTC Clients → LIST

Handle zMan Access Key Regeneration

If required, re-register and onboard zDM:

$ ./zwan/zdmserver/zdmsetup.sh
$ ./zwan/zdmserver/onboard.sh
Was this article helpful?
0 out Of 5 Stars
5 Stars 0%
4 Stars 0%
3 Stars 0%
2 Stars 0%
1 Stars 0%
5
How can we improve this article?
Please submit the reason for your vote so that we can improve the article.
Table of Contents
Top