Windows clients

Prev Next

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

Full

Normal enterprise usage, including pre-installation as part of standard builds.

Lite

Third-party usage where users may not have administrator rights on their device.

Multi-user

Installation on terminal servers. Provides each user their own AppGate ZTNA session.

Headless

Installation on unattended machines such as servers.

Always-On

Normal enterprise usage that requires an always-on connection to certain protected hosts.

SSO (PLAP)

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

/help or /?

Lists installer usage and flags.

/S

Runs the installer silently without any popup. A return code other than 0 indicates an error occurred during installation.

/D

Installs the client into an alternative directory (for example, /D=C:\here). You can use this switch with /S. Always give this switch last.

/I or /DISABLESCRIPTS

Prevents device claim scripts from running.

/A or /STARTCLIENT

Runs the client after silent installation is finished.

/W or /AUTOSTARTALL

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.

/Q or /SKIPAUTOSTART

Does not configure auto-start for the user who installed the client. See /W.

/G or /DISABLEUSERACCEPTANCE

Does not show the data usage acceptance screen the first time the client starts. Not relevant for the headless client.

/T or /ATTENTIONMODE

Sets the default attention level: 0 = Low, 1 = Normal, 2 = High.

/P="profile1;profile2" or
/PROFILES="profile1;profile2"

Sets one or more profile links for fresh installations. Separate profiles with a semicolon inside quotes, for example: /P="appgate://url1.com/abc;appgate://url2.com/def".

/E or /HEADLESS

Installs the client as a Windows service with no UI.

/O or /ALWAYSON

Installs the client as both a full client and a headless client so that it always runs in one mode or the other.

/L or /SSO

Installs the client as a Windows SSO (PLAP) service that captures credentials from a customized Windows sign-in screen.

/M or /MULTIUSER

Installs the client as a multi-user client. See Windows multi-user client for details.

/C or /CACHEPIN

Enables PIN caching when using the LDAP certificate identity provider.

/R or /SETSIGNEDIN

Sets Keep me signed in as the default and enables SAML/Certificate auto sign-in as the default.

/N or /DISABLEUSERCHECK

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.

/Z or /UNINSTALL

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.exe

When the uninstaller executable is run from the command line then the following switches may be added (precede each with a space):

Switch

Description

/S

Runs the uninstaller silently without any popup. A return code other than 0 indicates an error occurred during uninstallation.

/K or /KEEPSETTINGS

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

Appgate SDP Service.exe

%programfiles%\appgate sdp\service\appgate sdp service.exe

Runs as USER. Handles business logic.

Appgate SDP.exe

%programfiles%\appgate sdp\ui\appgate sdp.exe

Multiple processes that run as USER. Handles the UI.

appgate-driver.exe

%programfiles%\appgate sdp\driver\appgate-driver.exe

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 ipconfig and look for the AppGate ZTNA adapter

Network configuration details for Appgate SDP VPN Tunnel including IP addresses and DNS servers.

View local firewall rules

Use netsh wfp show filters. When you run it as an administrator, it creates a filters.xml file that contains the filters.

View client settings

The user.config file is in %APPDATA%\Appgate\Appgate_SDP_Service_Url_<text>\<version>\.

Clean all client settings

Delete the user.config file.

Remove client profile links

Go to %APPDATA%\Appgate\ and delete the Profiles and ProfileConfigurations files.

Remove all stored passwords, cookies, and certificates

With administrator rights, run certmgr.msc. Delete certificates under ”AppGate” in the right hand-pane.

Certificate management interface displaying AppGate certificates and their details.

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

  1. Go to HKEY_LOCAL_MACHINE\SOFTWARE\Microsoft\Windows NT\CurrentVersion\NetworkList\Profiles

  2. Locate the profile with the ProfileName of AppgateSDP.

  3. Go to the Category REG_DWORD and set the value to: Public (0), Private (1), or Domain (2).

  4. Reboot.

Set Windows route priority

  1. Go to HKEY_LOCAL_MACHINE\SOFTWARE\Appgate\Driver.

  2. Below "NormalDesktop"="1" add:

"NeedRoutes"="192.168.1.2/32, 192.168.1.3/32"

"NeedRouteTimeout"="90"

"NeedRouteDelay"="3"

  1. Restart the client.

  • NeedRoutes. A comma-separated list of /32 IP addresses in full CIDR notation. Put DNS servers in this section. Because DNS servers are the same on all Sites, this ensures the adapter comes up once the client receives those DNS routes.

  • NeedRouteDelay. Delay in seconds. Start with 3. This optional delay ensures that the client also receives routes from Active Directory (AD) and Kerberos servers, which can differ by Site.

  • NeedRouteTimeout. Timeout in seconds. Start with 90. If the client does not receive the specified routes after this time but other Sites are connected, the network adapter comes up to trigger Site fallback.

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:

  1. Check for a registry entry. If no entry is present, proceed to option 2.

  2. Use wmic csproduct get uuid. If this fails, proceed to option 3.

  3. Use HKLM\\SOFTWARE\\Microsoft\\Cryptography\\MachineGuid.