Installation

Download

From Sentry Software's Web site, download:

• hws-debian-3.1.02-amd64.deb

Install

Once you have downloaded the Debian package, run the following dpkg command:

/ $ cd /usr/local
/usr/local $ sudo dpkg -i hws-debian-3.1.02-amd64.deb

When complete, the Hardware Sentry's files are deployed in /opt/hws and the Hardware Sentry Agent is started as a service.

Configure

You need to set up 2 configuration files in the installation directory (/opt/hws):

• ./otel/otel-config.yaml: to specify where the OpenTelemetry Collector should send the collected data
• ./config/hws-config.yaml: to specify the hosts to monitor and their credentials

There are two configuration examples in the installation directory (/opt/hws):

• ./otel/otel-config-example.yaml, a configuration example of the OpenTelemetry Collector.
• ./config/hws-config-example.yaml, a configuration example of the Hardware Sentry Agent.

Before starting Hardware Sentry, make sure to configure ./otel/otel-config.yaml, since a restart of the Collector is required to take into account its changes.

Start

To start the Hardware Sentry service, run the command below:

systemctl start hws-agent

This will start Hardware Sentry with:

• The default Hardware Sentry Agent configuration file: ./config/hws-config.yaml.
• The default OpenTelemetry Collector configuration file: ./otel/otel-config.yaml.

You can start Hardware Sentry in an interactive terminal with an alternate Hardware Sentry Agent's configuration file with the command below:

/ $ cd /opt/hws/bin
/opt/hws/bin $ ./agent --config=<PATH>

Example:

/ $ cd /opt/hws/bin
/opt/hws/bin $ ./agent --config=config/my-hws-config.yaml

Stop

To stop the Hardware Sentry service, run the command below:

systemctl stop hws-agent

Uninstall

To uninstall Hardware Sentry, run the command below:

sudo dpkg -r hws

Download

From Sentry Software's Web site, download:

• hws-debian-3.1.02-docker.tar.gz

Install

First, unzip and untar the content of hws-debian-3.1.02-docker.tar.gz into a docker directory, like /docker. There is no need to create a specific subdirectory for hws as the archive already contains an hws directory.

/ $ cd /docker
/docker $ sudo tar xf /tmp/hws-debian-3.1.02-docker.tar.gz

Then, build the docker image using the following command:

/ $ cd /docker/hws
/docker/hws $ sudo docker build -t hws:latest .

Configure

You need to set up 2 configuration files in the docker directory (hws):

• ./lib/otel/otel-config.yaml: to specify where the OpenTelemetry Collector should send the collected data
• ./lib/config/hws-config.yaml: to specify the hosts to monitor and their credentials

There are two configuration examples in the docker directory (hws):

• ./lib/otel/otel-config-example.yaml, a configuration example of the OpenTelemetry Collector.
• ./lib/config/hws-config-example.yaml, a configuration example of the Hardware Sentry Agent.

Before starting Hardware Sentry, make sure to configure ./lib/otel/otel-config.yaml, since a restart of the Collector is required to take into account its changes.

Start

You can start Hardware Sentry with the command below:

/ $ cd /docker/hws
/docker/hws $ sudo docker run --name=hws -p 8888:8888 -p 4317:4317 -p 13133:13133 -v /docker/hws/lib/config:/opt/hws/lib/config -v /docker/hws/lib/otel:/opt/hws/lib/otel hws:latest

This will start Hardware Sentry with:

• The Hardware Sentry Agent configuration file: ./lib/config/hws-config.yaml.
• The OpenTelemetry Collector configuration file: ./lib/otel/otel-config.yaml.

See Ports and Firewalls for port details.

Docker Compose Example

You can start Hardware Sentry with docker-compose:

/docker/hws $ sudo docker-compose up -d --build

Example docker-compose.yaml

version: "2.1"
services:
  hws:
    build: .                                        # for image we will use ``image: sentrysoftware/hws:latest``
    container_name: hws
    ports:
      - 8888:8888                                   # OpenTelemetry Collector Exporter
      - 4317:4317                                   # OpenTelemetry Collector gRPC Receiver
      - 13133:13133                                 # OpenTelemetry Collector HealthCheck
    volumes:
      - ./lib/logs:/opt/hws/lib/logs                # Mount the volume ./lib/logs into /opt/hws/lib/logs in the container
      - ./lib/config:/opt/hws/lib/config            # Mount the volume ./lib/config into /opt/hws/lib/config in the container
      - ./lib/otel:/opt/hws/lib/otel                # Mount the volume ./lib/otel into /opt/hws/lib/otel in the container
    restart: unless-stopped

Download

From Sentry Software's Web site, download:

• hws-rhel-3.1.02-1.x86_64.rpm

Install

Once you have downloaded the RPM package, run the following rpm command:

/ $ cd /usr/local
/usr/local $ sudo rpm -i hws-rhel-3.1.02-1.x86_64.rpm

When complete, the Hardware Sentry's files are deployed in /opt/hws and the Hardware Sentry Agent is started as a service.

Configure

You need to set up 2 configuration files in the installation directory (/opt/hws):

• ./otel/otel-config.yaml: to specify where the OpenTelemetry Collector should send the collected data
• ./config/hws-config.yaml: to specify the hosts to monitor and their credentials

There are two configuration examples in the installation directory (/opt/hws):

• ./otel/otel-config-example.yaml, a configuration example of the OpenTelemetry Collector.
• ./config/hws-config-example.yaml, a configuration example of the Hardware Sentry Agent.

Before starting Hardware Sentry, make sure to configure ./otel/otel-config.yaml, since a restart of the Collector is required to take into account its changes.

Start

To start the Hardware Sentry service, run the command below:

systemctl start hws-agent

This will start Hardware Sentry with:

• The default Hardware Sentry Agent configuration file: ./config/hws-config.yaml.
• The default OpenTelemetry Collector configuration file: ./otel/otel-config.yaml.

You can start Hardware Sentry in an interactive terminal with an alternate Hardware Sentry Agent's configuration file with the command below:

/ $ cd /opt/hws/bin
/opt/hws/bin $ ./agent --config=<PATH>

Example:

/ $ cd /opt/hws/bin
/opt/hws/bin $ ./agent --config=config/my-hws-config.yaml

Stop

To stop the Hardware Sentry service, run the command below:

systemctl stop hws-agent

Uninstall

To uninstall Hardware Sentry, run the command below:

sudo rpm -e hws-3.1.02-1.x86_64

Download

From Sentry Software's Web site, download:

• hws-windows-3.1.02.msi

Install

Double-click the .msi file you previously downloaded. The Installation Wizard will automatically start and guide you through the installation process.

When complete, the Hardware Sentry's files are deployed to the destination folder (by default under C:\Program Files\hws) and the Hardware Sentry Agent is started as a service and appears in services.msc.

Hardware Sentry operates using the configuration located in the ProgramData\hws directory (C:\ProgramData\hws).

Configure

You need to set up 2 configuration files in the ProgramData\hws directory (C:\ProgramData\hws):

• ./otel/otel-config.yaml: to specify where the OpenTelemetry Collector should send the collected data.
• ./config/hws-config.yaml: to specify the hosts to monitor and their credentials.

There are two configuration examples in the installation directory (C:\Program Files\hws):

• ./otel/otel-config-example.yaml, a configuration example of the OpenTelemetry Collector.
• ./config/hws-config-example.yaml, a configuration example of the Hardware Sentry Agent.

Before starting Hardware Sentry, make sure to configure ./otel/otel-config.yaml, since a restart of the Collector is required to take into account its changes.

Start

To start the Hardware Sentry service, open services.msc and start the Hardware Sentry Agent service.

This will start Hardware Sentry with:

• The default Hardware Sentry Agent configuration file: ./config/hws-config.yaml.
• The default OpenTelemetry Collector configuration file: ./otel/otel-config.yaml.

You can start Hardware Sentry in an interactive terminal (using CMD.EXE or Windows Terminal with an alternate Hardware Sentry Agent's configuration file using the command below:

c:
cd "Program Files"
cd hws
agent --config="c:\ProgramData\hws\config\my-hws-config.yaml"

Uninstall

To uninstall Hardware Sentry, double-click the hws-windows-3.1.02.msi file and click Remove when prompted.