The Configurator tool is used to configure the headless, always-on, and SSO clients. The Windows Service AppGate SDP Client Service must be running to use this tool. After a complete configuration is applied, the client tries to sign in and continues to retry on failure. Apply a configuration at any time to force the client to try to connect.
To run the Configurator tool:
Open a command prompt with administrator rights.
Go to the AppGate ZTNA installation location (default
C:\Program Files\Appgate SDP\Service\). This folder contains the AppGate ZTNA Service executable. To list available commands, enter:
"Appgate SDP Service.exe" configurator --help
The Configurator tool uses the following options:
Option | Description |
|---|---|
| Gets information about the running service. |
| Configures the service. |
| Resets the service. |
| Lists help options. |
| Lists version information. |
Using the get command
The get command returns the current configuration and active state of the service.
Enter:
"Appgate SDP Service.exe" configurator get OPTION
The available options are:
Option | Description |
|---|---|
| Provides information about what is configured in the client.
|
| Shows the status with more details about Sites, Gateways, and entitlements.
|
| Indicates whether the service is connected, still trying to sign in, or has encountered an error. If a new configuration is being applied, the following message may appear:
|
The connection status messages for the headless client are:
Status message | Description |
|---|---|
Waiting for configuration | Client is waiting to be configured |
Applying the new configuration | Client is applying the configuration and trying to sign in to AppGate ZTNA. |
Connecting | Client has successfully signed in and is connecting. |
Connected | Client has successfully signed in and is connected to all Sites. |
Partially Connected | Client has successfully signed in but can only connect to some Sites. |
Suspended. Full client is currently connected | Client is suspended because the full client is in operation. |
None connected | Client has successfully signed in but cannot connect to any Site. |
Disconnecting | Client is disconnecting and will soon try to sign in again. |
Using the set command
The set command configures the client. The profile link is required. Use the -o option in combination with additional options to configure credentials and other settings.
Enter:
"Appgate SDP Service.exe" configurator set -o appgate://url.com OPTION OPTION
The available options are:
Option | Description |
|---|---|
| Sets the username for sign-in with credentials. Must be used with |
| Sets the password for sign-in with credentials. Must be used with |
| Specifies the client profile link. Can be copied from Client Profiles (Identity > Client Profiles). |
| Sets the absolute path to the certificate PFX file for certificate authentication. |
| Sets the password for the authentication certificate PFX file. |
| Sets the subject name of the certificate in the local computer certificate store for certificate authentication. Enter any value to list available certificates. Overrides the P12/PFX file. |
| Sets the log level of the client. |
See LDAP Certificate IdP if using certificate authentication.
The Configurator returns the following exit codes:
0— no error1— error on the Configurator, including connection to the service or daemon.78— Configurator completed successfully but the service or daemon returned errors, such assuccess: false127— wrong or missing arguments
Using the reset command
The reset command resets the configuration or active state of the service.
Enter:
"Appgate SDP Service.exe" configurator reset OPTION
The available options are:
Option | Description |
|---|---|
| Clears the current configuration of the client, even if connected. |
| Resets the active state of the service, forcing it to reload the configuration and reconnect. |
All get, set, and reset commands also include the following options:

Option | Description |
|---|---|
| Displays command output in JSON format. Also prevents the process from blocking with "Press any key to continue." |
| Sets the log level of the Configurator itself. |
| Lists help options. |
| Lists version information. |
Log files location
Configurator logs are in C:\user\username\appdata\roaming\appgate\logs\configurator.log.


