Windows always-on client

Prev Next

Always-on clients are similar to the full client that a normal user runs. They allow the user's device to connect to the network even when the user is not signed in. The always-on client combines the full client, which behaves in the usual interactive way, with the headless client, which runs in the background without a UI.

Example use cases for the headless half:

Whenever the user is not signed in to the always-on full client, the always-on headless client continuously tries to sign in. At boot, devices that use the always-on client are always signed in through the always-on headless client, which receives its own entitlements based on its policy. This allows secure connections to a limited set of resources protected by AppGate ZTNA, regardless of what the user is doing.

When the user signs in to the always-on full client, they receive their own entitlements and the always-on headless client suspends, retaining its tokens in memory to resume later. When the user suspends the always-on full client or signs out, the always-on headless client takes over immediately. These two modes are independent. Renewing tokens for one does not renew tokens for the other. Auto-update, once initiated from either half, updates both parts together.

NOTE

Write access to TrustedCertificatePath is recommended when using the headless client.


System limitations

The Windows always-on client has the following limitations:

  • Define different users for always-on headless and always-on full mode. Both the always-on headless and always-on full clients must complete onboarding. If the same user has already onboarded in one mode, the other mode fails to onboard. The client consumes two user licenses.

  • Multi-factor authentication (MFA) onboarding is not supported on the always-on headless client. If the always-on full client requires MFA, use a different identity provider (IdP) and two different profile links.

  • Custom on-demand device claims are not supported in always-on headless mode.

  • Define separate policies for always-on headless and always-on full clients, assigned by user/IdP, or use the clientType claim (reports full or headless depending on the active mode).


Standard executables

The Windows always-on client uses the following standard executables:

  • Appgate SDP Service. Appears twice, running as USER and as SYSTEM.

  • Service Configurator. Configures the headless client. Requires the Appgate SDP Service to be running.


Installing the Windows always-on client

Downloading the installer from the command line

To download the client, run CMD or PowerShell as an administrator and run the following command, replacing x.y.z in the filename and x.y in the filepath with the correct version numbers:

CMD

curl -L -o "%TEMP%\AppGate-SDP-client.exe" "https://bin.appgate-sdp.com/x.y/client/Appgate-SDP-x.y.z-Installer.exe"

PowerShell

Invoke-WebRequest -Uri "https://bin.appgate-sdp.com/x.y/client/Appgate-SDP-x.y.z-Installer.exe" -OutFile "$env:TEMP\AppGate-SDP-client.exe"

Installing the client from the command line

Install the client from the command line using the /O (/ALWAYSON) switch. The /S (silent installation) switch is also recommended. Run CMD or PowerShell as an administrator. See Windows clients for a full explanation of all installation switch options.

To install the Windows always-on client in silent mode, run CMD or PowerShell as an administrator and ensure the installer is in your C:\tmp folder. Then run one of the following commands replacing x.y.z with the correct version number and <full profile URL> with the client profile URL (from Identity > Client Profiles):

CMD

start "" /WAIT "%TEMP%\AppGate-SDP-x.y.z-Installer.exe" /ALWAYSON /S /PROFILES="<full profile URL>"

PowerShell

Start-Process "$env:TEMP\AppGate-SDP-x.y.z-Installer.exe" -ArgumentList '/ALWAYSON /S /PROFILES="<full profile URL>"' -Wait

The installer upgrades the full client and adds headless mode.

NOTE

User accounts must be configured in the identity provider (IdP) associated with the always-on client profile before the service will connect. Use a separate client profile for always-on clients, even when the same IdP is used for the full client.

NOTE

You can upgrade an existing full client installation to always-on by running the installer with /O.

Use services.msc to confirm appgateservice and cxdriver exist and are running.


How to set or change the client configuration

After installation, an "Appgate SDP" folder appears in the Windows Start menu. It contains several items, including a shortcut to the headless client's Configurator tool. The installer installs the Service Configurator automatically when you choose the headless or always-on option. Use this tool to configure always-on headless mode.

In the following commands, replace <full profile URL> with the client profile link, and <HEADLESS_USER> and <PASSWORD> with the IdP credentials:

CMD

start "" /WAIT "C:\Program Files\Appgate SDP\Service\Appgate SDP Service.exe" configurator set -o "<full profile URL>" -u <HEADLESS_USER> -p <PASSWORD>

PowerShell

& 'C:\Program Files\Appgate SDP\Service\Appgate SDP Service.exe' configurator set -o "<full profile URL>" -u <HEADLESS_USER> -p <PASSWORD>

The commands run the Configurator tool with the -o option and a profile link to set a profile for always-on headless mode. Get profile links from Client Profiles (Identity > Client Profiles).

NOTE

The installer retains existing profiles. The profile set with /P applies only to always-on full mode. Always provide the /O flag every time the client is installed, upgraded, or reinstalled to continue running it as the always-on client.

Use the Configurator tool at any time to change the profile or credentials that the always-on headless client uses. It can also check the status of the always-on client, such as confirming that it has signed in correctly.


Uninstalling the Windows always-on client

You can uninstall the Windows always-on client in the following ways:

  • Run the uninstaller from the Start menu shortcut.

  • Use Add or Remove Programs in Windows.

NOTE

Uninstalling the always-on client removes only the client binaries—configurations of the always-on headless client are not removed.

To uninstall from the command line, run the installer with uninstall flags and replace x.y.z with the correct version number:

CMD

start "" /WAIT "%TEMP%\Appgate-SDP-x.y.z-Installer.exe" /S /UNINSTALL

PowerShell

Start-Process "$env:TEMP\Appgate-SDP-x.y.z-Installer.exe" -ArgumentList '/S /UNINSTALL' -Wait

Logs

There are two log files for the always-on headless client, both in C:\ProgramData\AppGate\:

  • service.log

  • driver.log