Installing and updating clients

Prev Next

Installing clients

Selecting a client

AppGate ZTNA provides clients for each supported operating system and use case. The following table lists the client types for each platform and links to the article that covers installation:

Platform

Client types

Article

Windows

Full, lite, multi-user, headless, always-on, and SSO (PLAP)

Windows clients

macOS

Full, headless, and always-on

macOS clients

Linux

Full and headless

Linux clients

Mobile and Chrome OS

Mobile apps, including iPadOS and Chrome OS apps, from the app stores

Mobile and Chrome OS clients

Kubernetes (k8s)

k8s service

Kubernetes (k8s) service client

After you deploy a Portal appliance, users can also connect through any popular browser.

Downloading a client

Download all supported client versions from the Downloads page. Get mobile apps, including iPadOS and Chrome OS apps, from the appropriate app stores.

You can automate the initial deployment process. To script or automate client distribution when a new version is released, AppGate posts the latest versions at a static URL.

Requirements for all clients

The following requirements and behaviors apply to every client:

  • All clients use standard native installers for the target operating system.

  • All client except the Windows lite client require administrator rights to install.

  • AppGate maintains forward and backward compatibility across five versions of the client. For any given version of AppGate ZTNA, clients on v-2, v-1, v, v+1, v+2 are compatible.

  • The client detects the system locale and switches languages automatically. AppGate ZTNA currently supports English, French, Spanish, Portuguese, and Japanese.

Device ID

At installation, the system derives or generates a unique device ID. This ID gives the device uniqueness within the AppGate ZTNA Collective. The device ID forms the first part of the system claim ag.distinguishedName, which also includes the username and identity provider. This claim lets the AppGate ZTNA Collective manage every user session individually.

Configuring client profiles

Client profiles and device policies together configure devices and AppGate ZTNA clients. You can tailor the appearance and behavior of the device and client to suit different user communities.

A client needs a client profile before it can connect to the Collective for the first time. You can add the profile during installation, when the client first launches, or while the client runs. Create and export client profiles, then install them on user devices or select them for use in the Portal under User Access Settings.

After you add the profile, set up the account, and configure a policy or entitlement, a user with valid credentials can authenticate to the Collective. The client returns the profileName claim as a device claim. You can optionally use this claim in assignment criteria to select a specific device policy, which can impose specific device and client configurations.

Get help

If a client cannot connect, see Troubleshooting user and device access. The Client Guide is also available.


Updating clients

How each client updates

The following table lists the update method for each client type:

Client

Update method

Details

Windows full, macOS full, macOS always-on

Client Auto-Update

The client installer installs the auto-update function. The client notifies the user when an update is pending. The user can install immediately or defer until restart.

Linux full

Client Auto-Update (partially automated)

Linux updates are not fully automated. The client gives the user instructions to complete the upgrade manually.

Windows headless

Client Auto-Update

Windows headless clients already use system services, so they do not need a separate auto-update function. The client applies the update as soon as it is ready.

Windows always-on

Client Auto-Update

You can trigger the update mechanism through the full or headless client. The system updates both halves of the always-on client at the same time.

Windows lite

Update on launch

The client updates when launched if a newer version exists.

Mobile

App stores

Update through the respective app stores.

Windows multi-user

Manual

Update the client manually.

Windows SSO

Manual

Update the client manually.

Linux headless

Manual

Update the client manually.

macOS headless

Manual

Update the client manually.

k8s service

Manual

Update the client manually.

Configuring Client Auto-Update

The Client Auto-Update feature lets the client download an update file for its platform when the client version is lower than the defined version and the criteria script runs true. The update occurs during the first sign-in or when the entitlement token renews. A criteria script lets you run a pilot by selecting only users tagged as administrators.

The client auto-update service manages updates for the client types marked Client Auto-Update in the preceding table, so you do not need to manage those devices locally.

To configure the auto-update feature, complete the following steps:

  1. Go to the Client Auto-Update page (System > Client Auto-Update).

  2. Under Mode select Enabled.

  3. For Criteria Script, select a script from the drop-down. Auto-update triggers for the device when the criteria script returns true for the user and device. Configure scripts on the Criteria scripts page.

  4. Under Platform settings, set the auto-update configuration for each platform. Use the following criteria script conditions:

    • Windows, macOS and Linux—full and always-on: clientType=full AND (os.family=windows OR macOS OR linux)

    • Windows—headless: (clientType=headless) AND os.family=windows

  5. Complete the following fields for each platform:

    1. Download URL. The client downloads the update file from this URL. The client must have access to the server and trust the HTTPS certificate. The client also verifies the installer signature internally.

    2. If the client version is lower than. Auto-update triggers when the client version is lower than this value.

  1. Select Save.

NOTE

Linux updates are not fully automated. The client gives the user instructions to complete the upgrade manually.

Disabling the auto-update service

The auto-update service upgrades the full client, but it runs as a system service and increases the attack surface of your system. No known vulnerabilities currently relate to this service. If you do not use Client Auto-Update to deploy upgrades across your user base, disable the service with the following commands.

Windows

sc config AppgateUpdateService start= Disabled
sc stop AppgateUpdateService

macOS

sudo launchctl stop com.appgate.sdp.updater
sudo launchctl remove com.appgate.sdp.updater

NOTE

On macOS, you must reinstall the client to reenable this feature.

Checking version adoption

Check adoption of a new version with the client version widget or one of the preconfigured visualizations in the LogServer.

Chart displaying client versions from active sessions with device counts for each version.

A pie chart displaying various operating systems and their versions in a visual format.