Client types
There are several types of Windows client. For a quick overview of the differences, see the Client compatibility matrix. Confirm that the client version is compatible with the associated operating system version. See the Downloads for more information.
Type | Designed for |
|---|---|
Normal enterprise usage, including pre-installation as part of standard builds. | |
Third-party usage where users may not have administrator rights on their device. | |
Installation on terminal servers. Provides each user their own AppGate ZTNA session. | |
Installation on unattended machines such as servers. | |
Normal enterprise usage that requires an always-on connection to certain protected hosts. | |
Works with Windows single sign-on (SSO) to let users perform a domain sign-in while working remotely. |
Installing and running the client
Each type of Windows client has a page with specific installation details. Most types use the same installer with various command-line options. The lite client has its own installer.
NOTE
Uninstall one client type before switching to another. Never partially uninstall the client—for example, do not remove only the AppGate ZTNA driver.
NOTE
Endpoint protection software sometimes interferes with client installation. You may need to grant access to several client components and executables within the endpoint protection software.
Using Windows events to check if AppGate ZTNA is connected
The AppGate ZTNA driver creates Windows log entries. In Event Viewer, the source is shown as <AppGate ZTNA driver>, the Event ID as <256>, and the status as either <Connected> or <Disconnected>. These events are useful for other processes that depend on network connectivity—those processes can monitor these events and wait for <Connected> before sending network traffic.
Pre-installation of the client
You may want to pre-install the client on standard device builds and minimize subsequent user interactions. When a user opens the installer executable, the installer installs the full client.
One way minimize interactions is to pre-install one or more profiles at install time using the /P switch. Client profiles include the CA fingerprint, SPA key, and choice of identity provider (IdP). Obtain the profile from the Client Profiles page (Identity > Client Profiles). To complete pre-installation with a profile link so users are ready to use the client, run:
appgate-sdp-installer.exe /S /P="appgate://controller.myco.com/profilename..."Installer switches
You can add switches when you run the installer from the command line. Precede each switch with a space. See each per-client-type article for the exact command for that type.
The installer accepts the following switches:
Switch | Description |
|---|---|
| Lists installer usage and flags. |
| Runs the installer silently without any popup. A return code other than |
| Installs the client into an alternative directory (for example, |
| Prevents device claim scripts from running. |
| Runs the client after silent installation is finished. |
| After installation, the client auto-starts for all users. Normally it auto-starts only for the user who installed it. This uses Windows Active Setup, which applies settings only once for other users for a given piece of software. Installing version 6.0.2 twice applies auto-start for other users only the first time. This switch does not affect the usual auto-start operation at power-up or during reinstallation or upgrades. You can change that setting in the client’s Settings menu, or an administrator can change from the device policy’s Client Configuration settings. |
| Does not configure auto-start for the user who installed the client. See |
| Does not show the data usage acceptance screen the first time the client starts. Not relevant for the headless client. |
| Sets the default attention level: |
| Sets one or more profile links for fresh installations. Separate profiles with a semicolon inside quotes, for example: |
| Installs the client as a Windows service with no UI. |
| Installs the client as both a full client and a headless client so that it always runs in one mode or the other. |
| Installs the client as a Windows SSO (PLAP) service that captures credentials from a customized Windows sign-in screen. |
| Installs the client as a multi-user client. See Windows multi-user client for details. |
| Enables PIN caching when using the LDAP certificate identity provider. |
| Sets Keep me signed in as the default and enables SAML/Certificate auto sign-in as the default. |
| Allows the full client to pass traffic even when the active Windows session differs from the session used to launch the client. Without this option, the client pauses when there is a session mismatch, which prevents one session from using another user's session. |
| Triggers the installer to run the associated uninstaller. |
NOTE
When scripting the installer in PowerShell, add an extra pair of single quotes around any double quotes, for example,
xxx.exe /P='"myurl"'.
Uninstaller
In addition to triggering the uninstaller from the installer, you can run it independently. Go to the installation folder and run:
%programfiles%\appgate sdp\uninstaller.exeWhen the uninstaller executable is run from the command line then the following switches may be added (precede each with a space):
Switch | Description |
|---|---|
| Runs the uninstaller silently without any popup. A return code other than |
| Retains all client settings. Applies to the full client only. |
Windows client - components/executables
The following table lists the Windows client executables:
Executable | Location | Description |
|---|---|---|
|
| Runs as USER. Handles business logic. |
|
| Multiple processes that run as USER. Handles the UI. |
|
| The virtual network adapter that runs as SYSTEM. Handles connections to the Gateways. |
NOTE
If you use an aggressive antivirus, you may need to grant access to some or all of these executables.
These executables also create the following directories:
%PROGRAMDATA%\appgate\%APPDATA%\appgate\%PROGRAMFILES%\appgate sdp\
Upgraded clients may retain some existing paths even when new paths are used. This list shows only the paths that new installations use.
Configuration settings
The following table lists common configuration tasks:
Task | Details |
|---|---|
View the network adapter | Use
|
View local firewall rules | Use |
View client settings | The |
Clean all client settings | Delete the |
Remove client profile links | Go to |
Remove all stored passwords, cookies, and certificates | With administrator rights, run
In Credential Manager, confirm you are using the correct user account to see the correct generic credentials, then select and delete the required item.. |
Set Windows network category to Private |
|
Set Windows route priority |
|
Find Windows device ID | AppGate ZTNA creates a device ID when a client is first installed. On Windows, the system uses one of three methods, in order:
|

