Hide navigation sidebar
Hide table of contents sidebar
Skip to content
Quickstart Official documentation Setuphelpers Changelog FAQ
Back to top
View this page
Toggle table of contents sidebar

This section of the documentation covers the daily use of WAPT.

All WAPT functionalities are explained in detail for the Administrators, the Users and the Package Deployers.

# 1. Deploying the WAPT Agent

## 1.1. Deploying the WAPT Agent on Windows

Note

To install WAPT on a Windows client, the minimal requirements are:

- 512Mo Ram;

- 1 CPU;

- 300Mo Drive space (without package cache).

List of Windows versions available.
Windows Version | WAPT Support
--- | ---
Windows 11 ARM | Tech Preview
Win2h25 |
Windows 11 Professional/Enterprise |
Win2k22 |
Win2k19 |
Win2k16 |
Windows 10 32/64bit Intel |
Win2012r2 |
Windows 7 32/64bit |

Note

Win11 ARM is currently in Tech Preview. Not all WAPT functionalities are available, such as Windows Update Agent (WUA). Some duplicates in software or hardware inventory have been observed.

Attention

If you install the WAPT Agent on Windows Server 2012r2, it needs these features need to be activated before installing the WAPT Agent:

- `KB2919442`.

- `KB2919355`.

- `vcredist2015`

Two methods are available to deploy the waptagent.exe.

- The first method is manual and the procedure MUST be applied on each host.

- The second one is automated and relies on a GPO.

The waptagent.exe installer is available at WAPT serveur web home page. The direct download link is for example: https://srvwapt.mydomain.lan/wapt/waptagent.exe.

### 1.1.1. Manually

Manually installing the WAPT Agent requires Local Administrator rights on the computer.

Manual deployment method is efficient in these cases:

> - Testing WAPT.

> - Using WAPT in an organization with a small number of computers.

> - If you do not have a means of mass deployment.

- Download the WAPT Agent from your WAPT Server then launch the installer from URL https://srvwapt.mydomain.lan/wapt/waptagent.exe.

Note

Since WAPT 2.5, a basic authentification if required to access to your WaptServer website.

The WAPT server authentication window

The WAPT Server interface in a web browser

Manually installing the WAPT Agent requires Local Administrator rights on the computer.

- Download the WAPT Agent from your WAPT Server then launch the installer. The waptagent.exe installer is available at WAPT serveur web home page. The direct download link is for example: https://srvwapt.mydomain.lan/wapt/waptagent.exe.

- Choose the language for the WAPT installer and click on OK to go on to the next step.

- Accept the licence terms and click on Next to go to next step.

- Just click on Next until the Install button.

### 1.1.2. Automatically

Important

Technical pre-requisites

Advanced network and system administration knowledge is required to achieve this procedure. A properly configured network will ensure its success.

Hint

When to deploy the WAPT Agent automatically?

The following method is useful in these cases:

- A large organization with many computers.

- A Samba Active Directory or Microsoft Active Directory for which you have enough administration privileges.

- The security and the traceability of actions are important to you or to your Organization.

#### 1.1.2.1. With the WAPT Deployment utility

waptagent.exe is an InnoSetup installer, it can be executed with these silent argument:

    waptagent.exe /VERYSILENT

- Additional arguments are available for the WAPT Deployment utility.

Description of available options for deploying the WAPT Agent silently
Options | Description
--- | ---
`/dnsdomain` = `mydomain.lan` | Domain in `wapt-get.ini` filled in during installation.
`/wapt_server` = `https://srvwapt.mydomain.lan` | URL of the WAPT Server in `wapt-get.ini` filled in during installation.
`/repo_url` = `https://repo1.mydomain.lan/wapt` | URL of the WAPT repository in `wapt-get.ini` filled in during installation.
`/StartPackages` = `basic-group` | Group of WAPT packages to install by default.
:code:`/verify_cert = ``True` or relative path `ssl\server\srvwapt.mydomain.lan.crt`. | Value of `verify_cert` entered during installation.
`/CopyServersTrustedCA` = path to a bundle to copy to `ssl\server` | Certificate bundle for https connections (to be defined by `verify_cert`).
`/CopypackagesTrustedCA` = path to a certificate bundle to copy into `ssl` | Certificate bundle for verifying package signatures.

The WAPT Deployment utility is a small binary that:

- Checks the version of the WAPT Agent.

- Downloads via https the waptagent.exe installer.

- Launches the silent installer with arguments (checked options defined during the compilation of the WAPT Agent).

    /VERYSILENT /MERGETASKS= ""useWaptServer""

- Updates the WAPT Server with the WAPT Agent status (WAPT version, package status).

Warning

The WAPT Deployment utility MUST be started as Local Administrator, that is why a GPO is a good method to deploy the WAPT Agent.

Download `waptdeploy.exe` from your WAPT Server homepage, or on https://srvwapt.domain.lan/wapt/waptagent/waptdeploy.exe.

The WAPT Server interface in a web browser

#### 1.1.2.2. With a GPO

- Create a new group strategy on the Active Directory server (Microsoft Active Directory or Samba-AD).

- Add a new strategy with Computer configuration ‣ Policies ‣ Windows Settings ‣ Scripts ‣ Startup ‣ Properties ‣ Add.

Creating a group strategy to deploy the WAPT Agent

- Click on Browse to select the `waptdeploy.exe`.

Finding the WAPT Deployment utility file on your computer

- Copy `waptdeploy.exe` in the destination folder.

Selecting the the WAPT Deployment utility script

- Click on Open to import the `waptdeploy.exe`.

Selecting the the WAPT Deployment utility script

- Click on Open to confirm the importation of the the WAPT Deployment utility binary.

Hint

> It is necessary to provide the checksum of the `waptagent.exe` as an argument to the the WAPT Deployment utility GPO. This will prevent the remote host from executing an erroneous / corrupted waptagent binary.

>     --hash=checksum WaptAgent --minversion=|wapt_last_release| --wait=15 --waptsetupurl=http://srvwapt.mydomain.lan/api/v3/get_waptagent_exe/{{ip}}/waptagent.exe

Parameters and waptagent.exe checksum to use for the the WAPT Deployment utility GPO are available on the WAPT Server by visiting https://srvwapt.mydomain.lan. When waptdeploy.exe queries the WAPT Server to obtain the WAPT Agent URL, the download repository is chosen according to the rules defined for remote repositories. The benefit of this method is that you only need one GPO to deploy WAPT onto your entire fleet of computers!

> Web console of the WAPT Server

> Warning

> This method does not work in CSPN mode, as the homepage is intentionally disabled by design.

> It is technically possible to re-enable the homepage using the homepage_enable parameter; however, this is not recommended.

> Alternatively, when the agent is generated, it is automatically stored on the administrator’s workstation that performed the generation. The SHA-256 hash can then be computed locally using any standard tool available on the system (such as 7-Zip or equivalent utilities).

- Copy the required parameters into the GPO.

Adding the the WAPT Deployment utility script to the startup GPO

- Click on OK to go on to the next step.

The WAPT Deployment utility GPO to be deployed on next startup

- Click on OK to go on to the next step.

- Apply resulting GPO strategy to the Organization’s Computers OU.

Note

We recommend adding `waptdeploy.exe` to the startup and shutdown scripts on the GPO.

Hint

More arguments are available for the WAPT Deployment utility

Description of available options for the WAPT Deployment utility
Options | Description
--- | ---
`--force` | Forces the installation of waptagent.exe even if alread installed.
`--hash` = `<sha256hash>` | Check that the downloaded waptagent.exe setup sha256 hash matches the hash.
`--help` | Displays the options
`--minversion` = `<version>` | Install waptagent.exe if installed version is less than minversion.
`--tasks` = autorunTray,installService,installredist2008,autoUpgradePolicy | If given, it passes the arguments to the /TASKS options of the waptagent installer (default `installService, installredist2008, autoUpgradePolicy`).
`--repo_url` = `<repo_url>` | Location of the repository to get waptagent.exe (default <repo_url>/wapt)
`--setupargs` = `<setupargs>` | Adds arguments to the command line of waptagent.exe. For logs –setupargs=”C:/windows/systemtemp/myfile.log”
`--wait` = `<minutes>` | Defines the delay for running and pending tasks to complete if waptservice is running before installing.
`--waptsetupurl` = `<waptsetupurl>` | Explicit location to download setup executable. It can be a local path (default `<repo_url>/waptagent.exe`).

#### 1.1.2.3. With a scheduled task

You may also choose to launch the WAPT Deployment utility using a scheduled task that has been set by GPO.

Hint

This method is particularly effective for deploying WAPT on workstations when the network is neither available on starting up or shutting down.

The method consists of using a GPO to copy locally `waptdeploy.exe` and `waptagent.exe` and create a scheduled task for installing.

- Copy `waptdeploy.exe` and `waptagent.exe` in the netlogon share of your Active Directory Server (`\mydomain.lan\netlogon\waptagent.exe`).

- Create a new group strategy on the Active Directory server (Microsoft Active Directory or Samba-AD).

- Add a new strategy with Computer configuration ‣ Preferences ‣ Windows Settings ‣ Files.

- Create a new file and copy the WAPT Deployment utility.

- Set parameters.

Description of options for copy
Options | Value
--- | ---
Action dropdown menu list | Replace
Source file(s) field | `\\mydomain.lan\netlogon\waptdeploy.exe`
Destination File field | `C:\windows\systemtemp\waptdeploy.exe`
Suppress errors on individual file actions checkbox | not checked
Read-only checkbox | checked
Hidden checkbox | not checked
Archive checkbox | checked

Note

The C:\Windows\SystemTemp directory has been available since Windows 10, version 20H2.

If your system is running an earlier version of Windows, you can use the following directories as alternative destinations for temporary files:

- C:\Windows\Temp (less secure)

- C:\Temp (less secure)

WAPT Agent installation progress

- Create a new file and copy the the waptagent.exe file.

- Set parameters.

Description of options for update
Options | Value
--- | ---
Action dropdown menu list | Update
Source file(s) field | `\\mydomain.lan\netlogon\waptagent.exe`
Destination File field | `C:\windows\systemtemp\waptagent.exe`
Suppress errors on individual file actions checkbox | not checked
Read-only checkbox | checked
Hidden checkbox | not checked
Archive checkbox | checked

Note

The C:\Windows\SystemTemp directory has been available since Windows 10, version 20H2.

If your system is running an earlier version of Windows, you can use the following directories as alternative destinations for temporary files:

- C:\Windows\Temp (less secure)

- C:\Temp (less secure)

Preparing the WAPT update GPO

- Then go to the Scheduled Task menu with Computer configuration ‣ Preferences ‣ Control Panel Settings ‣ Scheduled Tasks.

- Create a new Scheduled Task with Right-click ‣ New ‣ Scheduled Task (At least Windows 7).

Create the scheduled task for the WAPT Deployment utility Properties window in RSAT

General tab in the Properties window in RSAT

- Set Action to `Replace`.

- For When running the task, use the following user account paste S-1-5-18 (system account). You can visit for more information.

- Check Run whether user is logged on or not.

- Check Run with highest privileges, then go on to the Triggers tab.

Trigger tab in the Properties window in RSAT

- Create a new trigger.

- Check Daily, select today’s date.

- Check Repeat Task every and select 1 hour and for a duration of select 1 day.

- Check Stop task if it runs longer than and select 2 hours.

- Check that Enabled is checked, and then go to the Actions tab.

Actions tab in the Properties window in RSAT

- Create a new action Start a program for `waptdeploy.exe`.

Description of options to copy
Options | Value
--- | ---
Action | Start a program
Program / script | C:\Temp\waptagent.exe
Add arguments (optional) | See the next point
Start in (optional) | empty

Actions tab in the Properties window in RSAT

Hint

It is necessary to provide the checksum of the `waptagent.exe` as argument to the WAPT Deployment utility. This will prevent the remote host from executing an erroneous / corrupted waptagent binary.

    --hash=checksum WaptAgent --minversion=|wapt_last_release| --wait=15 --waptsetupurl=http://srvwapt.mydomain.lan/wapt/waptagent.exe

Parameters and the waptagent.exe checksum to use for the the WAPT Deployment utility GPO are available on the WAPT Server by visiting https://srvwapt.mydomain.lan.

Web console of the WAPT Server

- Copy the required parameters and change `waptsetupurl` to `C:\Temp\waptagent.exe`.

      --hash=checksum WaptAgent --minversion=|wapt_last_release| --wait=15 --waptsetupurl=C:\Temp\waptagent.exe

Description of available options for the WAPT Deployment utility
Options | Description
--- | ---
`--force` | Installs waptagent.exe even if not needed
`--hash` = <sha256hash> | Checks that the downloaded waptagent.exe setup sha256 hash matches the hash.
`--help` | Displays the options.
`--minversion` = 2.6.0 | Installs waptagent.exe if installed version is less than minversion.
`--tasks` = autorunTray,installService,installredist2008,autoUpgradePolicy | If given, passes this arguments to the /TASKS options of the waptagent installer. Default = installService, installredist2008, autoUpgradePolicy
`--repo_url` = https://srvwapt.mydomain.lan/wapt | Defines the location of the repository to get the `waptagent.exe`.
`--setupargs` = <options> | Adds arguments to the command line of waptagent.exe.
`--wait` = <minutes> | Defines the maximum allowed time for running and pending tasks to complete if the WAPT service is running before installing.
`--waptsetupurl` = https://srvwapt.mydomain.lan/wapt/waptagent.exe | Defines an explicit location to download setup executable. This can be a local path (default=:file:<repo_url>/waptagent.exe).

- Go on to the Settings tab.

  Settings tab in the Properties window in RSAT

- In the Settings tab, only check Run task as soon as possible after a scheduled start is missed.

Hint

To verify that the GPO is working, you can run the gpupdate /force command and verify that the scheduled task is present on the computer by launching Task Scheduler as a Local Administrator.

## 1.2. Deploying the WAPT Agent on Linux and macOS

Note

To install WAPT on a Linux or MacOS client, the minimal requirements are:

- 512Mo Ram;

- 1 CPU;

- 300Mo Drive space (without package cache).

The procedure depends on your operating system:

Hint

The WAPT Agent for Debian has been tested on Debian 9, 10, 11 and 12.

The WAPT Agent for Ubuntu has only been tested on Ubuntu Bionic and Ubuntu Focal.

- Update the underlying distribution and check that apt https transport is installed

    sudo apt update && sudo apt upgrade -y
    sudo apt install apt-transport-https lsb-release gnupg -y

- Retrieve the key .gpg, add it to the Tranquil IT repository and install the WAPT Agent.

    wget -qO- https://wapt.tranquil.it/$(lsb_release -is)/tiswapt-pub.gpg | sudo tee /usr/share/keyrings/tiswapt-pub.gpg > /dev/null
    echo "deb [signed-by=/usr/share/keyrings/tiswapt-pub.gpg] https://wapt.tranquil.it/$(lsb_release -is)/wapt-2.6/ $(lsb_release -cs) main" | sudo tee /etc/apt/sources.list.d/wapt.list > /dev/null

    export DEBIAN_FRONTEND=noninteractive
    sudo apt update
    sudo apt install tis-waptagent -y
    unset DEBIAN_FRONTEND

Hint

The WAPT Agent for RedHat based system has been tested on RedHat 7/8/9 and derivatives on x86_64 platforms.

- Update the underlying distribution.

    yum update

- Retrieve the key `.gpg` and configure the WAPT repository.

    RH_VERSION=$(cat /etc/system-release-cpe | awk -F: '{ print $5}')
    wget -q -O /tmp/tranquil_it.gpg "https://wapt.tranquil.it/redhat${RH_VERSION}/RPM-GPG-KEY-TISWAPT-${RH_VERSION}"; rpm --import /tmp/tranquil_it.gpg

    cat > /etc/yum.repos.d/wapt.repo <<EOF
    [wapt]
    name = WAPT Server Repo
    baseurl = https://wapt.tranquil.it/redhat${RH_VERSION}/wapt-2.6/
    enabled = True
    gpgcheck = True
    EOF

- install the WAPT Agent using yum:

    yum install tis-waptagent

Warning

The WAPT agent for macOS is currently only available in the WAPT Enterprise version.

Hint

The WAPT Agent has only been tested on Intel architecture and Apple Silicon M Series processors:

- Mojave (10.14);

- Catalina (10.15);

- Big Sur (11.x);

- Monterey (12.x).

- Ventura (13.x).

- Sonoma (14.x).

- Sequoia (15.x).

- Download and install the WAPT Agent (note: the hash string may change, to get the latest, point your browser on the url https://wapt.tranquil.it/wapt/releases/wapt-2.6/). Choose the version depending on your processor architecture (intel or m1):

    # for mac m1
    curl -OL http://wapt.tranquil.it/wapt/releases/wapt-2.6.1.17654-db56dcce/tis-waptagent-2.6.1.17654-db56dcce-macos-all-arm64.pkg
    # for mac intel
    curl -OL http://wapt.tranquil.it/wapt/releases/wapt-2.6.1.17654-db56dcce/tis-waptagent-2.6.1.17654-db56dcce-macos-all-x86_64.pkg

    sudo installer -target / -pkg tis-waptagent*.pkg

### 1.2.1. Installing the WAPT Agent configuration file

Before installing the WAPT Agent configuration file, you have to create a initial config for you agent in your WAPT Console.

Warning

The WAPT Agent configuration wizard is only available on WAPT Entreprise Edition. To configure Linux WAPT Agent, please refer to the manual WAPT Agent configuration method.

When done, copy the command with the Copy installation command.

Menu list showing the Copy installation command

Then use this copied command prompt on the Linux / macOS agent.

    wapt-get reset-config-from-url https://srvwapt.mydomain.lan/wapt/conf.d/default_f0288df2131b8dce667b8c34b9999959bdc2d253b3934fcb3be2eabad8a50021.json f0288cf2131b9dce667b8c34b9999959bdc2d253b3934fcb3be2eabad8a50020

Finally, execute the following command to register the Linux / macOS host with the WAPT Server:

    sudo wapt-get register

When you have modified the configuration of the WAPT Agent, you should restart the WAPT Agent using the following command:

    sudo wapt-get restart-waptservice

#### 1.2.1.1. Feature matrix

There are some features that are not currently available on Linux and macOS:

- Installing updates on shutdown (WAPT Exit);

- Any Windows specific feature.

#### 1.2.1.2. Particularities with domain functionality

On Linux:

- Testing was carried out with sssd with an Active Directory domain and kerberos authentication.

- To integrate a host in the Active Directory domain, you can choose to follow this documentation.

- In order for Active Directory groups to function properly, you MUST verify that the id hostname$ command returns the list of groups the host is a member of.

Attention

We have noticed that the kerberos LDAP query does not work if the reverse DNS record is not configured correctly for the domain controllers. These records MUST therefore be created if they do not exist.

### 1.2.2. Manual method to configure the WAPT Agent running on Linux / macOS

Attention

Please, see the new method to deploy configuration file instead if you are using WAPT Entreprise Edition.

#### 1.2.2.1. Creating the WAPT Agent configuration file

Use the WAPT Server FQDN address for the `repo_url` and the `wapt_server` arguments.

    sudo cat > /opt/wapt/wapt-get.ini <<EOF
    [global]
    repo_url = https://srvwapt.mydomain.lan/wapt
    wapt_server = https://srvwapt.mydomain.lan
    use_hostpackages = True
    use_kerberos = False
    verify_cert = False
    EOF

#### 1.2.2.2. Copying the package-signing certificate

You need to copy manually, or by script, the public certificate of your package signing Certificate Authority.

The certificate should be located on your Windows host in `C:\Program Files (x86)\wapt\ssl\`.

Copy your certificate(s) in `/opt/wapt/ssl` using WinSCP or rsync if you are deploying on Linux or macOS.

#### 1.2.2.3. Copying the SSL/TLS certificate

If you already have configured your WAPT Server to use correct Nginx SSL/TLS certificates, you MUST copy the certificate in your WAPT Linux or macOS Agent.

The certificate should be located on your Windows host in `C:\Program Files (x86)\wapt\ssl\server\`.

- Copy your certificate(s) in `/opt/wapt/ssl/server/` using WinSCP or rsync if you are deploying on Linux or macOS.

- Then, modify in the `/opt/wapt/wapt-get.ini` configuration file the path to your certificate.

- And give the absolute path of your certificate.

    verify_cert = /opt/wapt/ssl/server/YOURCERT.crt

Hint

Change the .crt file with your certificate name.