Portuguese English Spanish
Portuguese English Spanish
Breadcrumbs

Install the DCA and Cloud Connector agent on Linux (Ubuntu and Ubuntu-based distributions)

To start monitoring your devices, it is essential to install the DCA and Cloud Connector agent.

Warning

If the gateway is used for communication between the agent and the portal, follow these steps before installing the DCA and Cloud Connector agent:

  1. Install the Gateway Connector on Windows

  2. Transfer the gateway certificate from Windows to Linux

The installation is also compatible with Raspberry Pi devices that meet the minimum prerequisites.

Instructions

Information

Currently, the Linux agent only supports monitoring meters, supplies, and events for network printers (NDD - Printer Monitor service) and USB printers (NDD - Printer Monitor USB service).

For USB printers (NDD service - Printer Monitor USB), see the compatible models at Configure the DCA and Cloud Connector agent on Linux.

Note

This step-by-step has been approved for the Ubuntu distribution and the Debian and Mint distributions based on Ubuntu.

Other Ubuntu-based distributions have not been approved, but are likely to work. If you have any questions or incidents, please contact our support team.

  1. Create the customers where the agents will be installed

  2. Check the installation prerequisites

  3. Check that the computer is connected to the internet

  4. Prepare the environment

  5. Open the terminal

Manual installation
Step 1: register in the NDD installer repository

  1. Run the command below in the terminal:

sudo wget -O /usr/share/keyrings/ndd.public packages-orbix.ndd.tech/apt-repo/ndd.public

  1. Run the command below in the terminal:

Bash
echo "deb [arch=amd64 signed-by=/usr/share/keyrings/ndd.public] https://packages-orbix.ndd.tech/apt-repo/  stable main" | sudo tee /etc/apt/sources.list.d/ndd.list

Warning

If the installation is being carried out on a Raspberry Pi device, replace the above command with the following:

Bash
echo "deb [arch=arm64 signed-by=/usr/share/keyrings/ndd.public] https://packages-orbix.ndd.tech/apt-repo/  stable main" | sudo tee /etc/apt/sources.list.d/ndd.list

  1. Run the command below in the terminal:

sudo apt-get update

In newer versions of some distributions, the sudo apt-get update command may return the following error:

image-20260813-140819.png

This occurs because modern versions of apt may not accept files in the ASCII-armored format and require a key in the .gpg format.

To fix the problem, convert the key to the .gpg format and update the repository configuration as instructed below:

  1. Run the command below in the terminal to verify that the key is in the file:

    Bash
    gpg --show-keys /usr/share/keyrings/ndd.public.

  2. If it is, run the command below in the terminal to convert the key to the .gpg format:

    Bash
    sudo gpg --dearmor -o /usr/share/keyrings/ndd.gpg /usr/share/keyrings/ndd.public

  3. Run the command below in the terminal to update the repository configuration:

    Bash
    sudo sed -i 's|signed-by=/usr/share/keyrings/ndd.public|signed-by=/usr/share/keyrings/ndd.gpg|' /etc/apt/sources.list.d/ndd.list 

  4. Run the command below in the terminal:

    Bash
    sudo apt-get update


After running all the commands, the agent package will be available for installation.

Step 2: install the agent

  1. Run the command below in the terminal to install the agent:

sudo apt install ndd-dca-and-cloud-connector

  1. When requested to confirm, type y and press Enter to proceed with the installation

Step 3: configure the agent

During installation, another screen will open for you to enter the agent's settings:

  1. Enter the Tenant name (provider name) and press Enter

Tip

How to find information on the portal:

  • Provider name: in the upper right corner, below your name:

image-20250528-180550.png

  1. Enter the Organization id (customer identification key) and press Enter

Tip

How to find information on the portal:

  • Customer identification key: in the customer properties:

  1. Go to the Administration > Customers menu

  2. Click on the name of the desired customer to open its properties

  3. In the Info tab, copy the Identification key

image-20250528-180703.png

  1. To establish the type of communication between the agent and the portal (by proxy, gateway or direct):

    1. Direct: in Do you want to use a proxy? and Do you want to use the Gateway Connector?, select No

    2. Proxy: in Do you want to use a proxy?, select Yes

      1. Enter the Proxy host (IP address or hostname of the proxy) and press Enter

      2. Enter the Proxy port and press Enter

      3. Enter the Proxy user (proxy authentication user), if any, and press Enter

      4. Enter the Proxy password, if any, and press Enter

    3. Gateway: in Do you want to use a proxy?, select No, and in Do you want to use the Gateway Connector?, select Yes

      1. Enter the Gateway Connector host (IP address or hostname of the computer/server where the Gateway Connector was installed)

      2. Enter the Gateway Connector port
        The default gateway port is 9635, but you can enter another port if you wish.

  2. When requested to confirm, type y and press Enter to proceed with the installation

The agent and service will be installed on the computer.

Silent installation

Environment variables do not configure the .deb. package. The ndd-dca-and-cloud-connector package reads the debconf settings. For a silent installation, record the responses before running apt and use DEBIAN_FRONTEND=noninteractive in the installation command.

The services do not require a tenant or organization_id and depend on the ndd-dca-and-cloud-connector package.

Parameters for silent installation of DCA and Cloud Connector on Linux

Parameter

Description

Required

Default

Usage

orbix/tenant string

Provider name

Yes, on first installation

-

DCA and Cloud Connector

orbix/organization_id string

Customer identification key

Yes, on first installation

-

DCA and Cloud Connector

orbix/configure_proxy select

Enables or disables proxy usage

No

Yes or No

DCA and Cloud Connector

orbix/proxy_host string

Proxy server address

Yes, if orbix/configure_proxy select Yes

-

DCA and Cloud Connector

orbix/proxy_port string

Proxy server port

Yes, if orbix/configure_proxy select Yes

-

DCA and Cloud Connector

orbix/proxy_user string

Proxy authentication user

No

-

DCA and Cloud Connector

orbix/proxy_pass password

Proxy authentication password

No

-

DCA and Cloud Connector

orbix/configure_gateway select

Enables or disables the use of the Gateway Connector

No

Yes or No

DCA and Cloud Connector

orbix/gateway_host string

IP address or hostname of the computer/server where the Gateway Connector is installed

Yes, if orbix/configure_gateway select Yes

127.0.0.1

DCA and Cloud Connector

orbix/gateway_port string

Gateway Connector port

Yes, if orbix/configure_gateway select Yes

9635

DCA and Cloud Connector

Choose one of the options below to install the DCA and Cloud Connector agent:

Install the DCA and Cloud Connector agent with direct communication

  1. Copy the command below:

    Bash
    sudo debconf-set-selections <<'EOF'
ndd-dca-and-cloud-connector orbix/tenant string TENANT-NAME
ndd-dca-and-cloud-connector orbix/organization_id string CLIENT-ID
ndd-dca-and-cloud-connector orbix/configure_proxy select No
ndd-dca-and-cloud-connector orbix/configure_gateway select No
EOF

sudo DEBIAN_FRONTEND=noninteractive apt-get install -y ndd-dca-and-cloud-connector

  2. Paste it into the terminal

  3. Replace TENANT-NAME with the provider’s name

Tip

How to find information on the portal:

  • Provider name: in the upper right corner, below your name:

image-20250528-180550.png

  1. Replace CLIENT-ID with the client identification key

Tip

How to find information on the portal:

  • Customer identification key: in the customer properties:

image-20250528-180703.png

  1. Go to the Administration > Customers menu

  2. Click on the name of the desired customer to open its properties

  3. In the Info tab, copy the Identification key

  1. Run the adjusted command to install the agent

Install the DCA and Cloud Connector agent with proxy communication

  1. Copy the command below:

    Bash
    sudo debconf-set-selections <<'EOF'
ndd-dca-and-cloud-connector orbix/tenant string TENANT-NAME
ndd-dca-and-cloud-connector orbix/organization_id string CLIENT-ID
ndd-dca-and-cloud-connector orbix/configure_proxy select Yes
ndd-dca-and-cloud-connector orbix/proxy_host string 127.0.0.1
ndd-dca-and-cloud-connector orbix/proxy_port string 1234
ndd-dca-and-cloud-connector orbix/proxy_user string USER
ndd-dca-and-cloud-connector orbix/proxy_pass password PASSWORD
EOF

sudo DEBIAN_FRONTEND=noninteractive apt-get install -y ndd-dca-and-cloud-connector

  2. Paste it into the terminal

  3. Replace TENANT-NAME with the provider’s name

Tip

How to find information on the portal:

  • Provider name: in the upper right corner, below your name:

image-20250528-180550.png

  1. Replace CLIENT-ID with the client identification key

Tip

How to find information on the portal:

  • Customer identification key: in the customer properties:

image-20250528-180703.png

  1. Go to the Administration > Customers menu

  2. Click on the name of the desired customer to open its properties

  3. In the Info tab, copy the Identification key

  1. Replace 127.0.0.1 with the IP address of the proxy server

  2. Replace 1234 with the proxy server’s port

  3. If authentication is required, replace USER and PASSWORD with the proxy’s user name and password

  4. If no authentication is required, remove these two lines from the command:
    ndd-dca-and-cloud-connector orbix/proxy_user string USER
    ndd-dca-and-cloud-connector orbix/proxy_pass password PASSWORD

  5. Run the adjusted command to install the agent

Install the DCA and Cloud Connector agent with gateway communication

  1. Copy the command below:

    Bash
    sudo debconf-set-selections <<'EOF'
ndd-dca-and-cloud-connector orbix/tenant string TENANT-NAME
ndd-dca-and-cloud-connector orbix/organization_id string CLIENT-ID
ndd-dca-and-cloud-connector orbix/configure_proxy select No
ndd-dca-and-cloud-connector orbix/configure_gateway select Yes
ndd-dca-and-cloud-connector orbix/gateway_host string 127.0.0.1
ndd-dca-and-cloud-connector orbix/gateway_port string 9635
EOF

sudo DEBIAN_FRONTEND=noninteractive apt-get install -y ndd-dca-and-cloud-connector

  2. Paste it into the terminal

  3. Replace TENANT-NAME with the provider’s name

Tip

How to find information on the portal:

  • Provider name: in the upper right corner, below your name:

image-20250528-180550.png

  1. Replace CLIENT-ID with the client identification key

Tip

How to find information on the portal:

  • Customer identification key: in the customer properties:

image-20250528-180703.png

  1. Go to the Administration > Customers menu

  2. Click on the name of the desired customer to open its properties

  3. In the Info tab, copy the Identification key

  1. If you want, replace 127.0.0.1 with the IP address or hostname of the computer/server where the Gateway Connector was installed

  2. If you want, replace 9635 with the Gateway Connector port

  3. Run the adjusted command to install the agent

Install the network printer and/or USB printer monitoring service:

Install the network printer monitoring service

Follow the steps below to install the NDD - Printer Monitor service:

  1. Run the command below in the terminal to install the service:

    Bash
    sudo DEBIAN_FRONTEND=noninteractive apt-get install -y ndd-dca-printer-network-agent
Install the USB printer monitoring service

Follow the steps below to install the NDD - Printer Monitor USB service:

  1. Run the command below in the terminal to install the service:

    Bash
    sudo DEBIAN_FRONTEND=noninteractive apt-get install -y ndd-dca-printer-monitor-usb-agent

Last updated: