Agent installation parameters

info

macOS only supports the following parameters from the list provided below: RTPrimary, RTSecondary, ClientID, DefaultDomain, AuthMode, LogLevel.

Parameters marked with * are required only in specific scenarios. See the parameter description for the conditions.

When to use quotes

Quoting depends on the value, not on the parameter. You need double quotes in two cases:

• Values with spaces: Without quotes, msiexec returns error 1639 and the installation never starts.
• Empty values: Without quotes, msiexec takes the next argument as the value and stores an incorrect value without warning you. For example, DEFAULTDOMAIN= can end up storing CURRENTDIRECTORY="C:\Users\username" as the domain.

In the following command, the MSI path is quoted because it contains spaces, and DEFAULTDOMAIN is quoted because it's left blank, which is common when you reinstall an agent that previously used SAML2 or OAUTH2. Replace VERSION-SUFFIX with your package version, PRIMARY_SERVER with your server address, and YOUR_CLIENT_ID with the client ID of your installation.

msiexec /i "C:\Deployment\Redtrust Agents\rt-agent-x64-VERSION-SUFFIX.msi" RTPRIMARY=PRIMARY_SERVER CLIENTID=YOUR_CLIENT_ID DEFAULTDOMAIN="" /qn

All other values work the same with and without quotes, such as IP addresses, host names, language codes, numbers, keywords like SERVER, and the base64 keys in ClientID.

Parameter	Optional	Default Value	Description
RTPrimary	No		IP address or hostname of the primary Redtrust server.
RTSecondary	No		IP address or hostname of the secondary Redtrust server. If no secondary server is available, use the hostname of the primary server.
ClientID	No		Shared key with the server. It is unique for each client and can be found in the administration console at: System > Unit > Information.
DEFAULTDOMAIN	No*		Default domain presented to the user for login. Not effective for logins through Entra ID. *Required when AuthMode is SAML2 or OAUTH2.
AuthMode	Yes	ActiveDirectory	Specifies the authentication mode of the agent. Possible values: * LocalUsers * LDAP * ActiveDirectory * ActivationCode * SAML2 (Note: Must be accompanied by the DEFAULTDOMAIN parameter) * OAUTH2 (Note: Must be accompanied by the DEFAULTDOMAIN parameter)
Language	Yes	es-ES	Agent language. Possible values are Spanish (es-ES), English (en-US), and Brazilian Portuguese (pt-BR).
TIMEOUT_SECONDS	Yes	31	Timeout in seconds after which the agent considers the server unavailable.
START_DELAYED	Yes	0	Specifies the startup mode of the installed service: 0 - Automatic start 1 - Delayed start
PIN_EXPIRATION	Yes	0	Number of seconds after which the PIN must be re-entered when using a certificate.
NO_REDIST	Yes	0	0 - Installs C++ redistributables 1 - Does not install C++ redistributables.
NO_UPDATER	Yes	0	0 - Installs the Redtrust RTUpdater update program 1 - Does not install the Redtrust RTUpdater update program.
NO_FIREFOX	Yes	0	0 - Installs the Firefox extension 1 - Does not install the Firefox extension.
NO_CHROME	Yes	0	0 - Installs the Chrome extension 1 - Does not install the Chrome extension.
NO_EDGE	Yes	0	0 - Installs the MS Edge extension 1 - Does not install the MS Edge extension.
UNATTENDED_BROWSERS	Yes	0	0 - Standard installation with the browser extension. 1 - Installs the agent in unattended browsers mode, without any browser-extension component (registry keys, native messaging host, Firefox XPI, and so on). The agent skips URL tracking, so browser signing then requires a policy with the Unattended browsers flag turned on. See Unattended browsers. Available from version 4.42.3 onwards.
WEBPROXY_URI	Yes	Empty	Proxy URL. The proxy must be transparent and authentication-free.
AGENTMODE	Yes	USER	`USER
ONLY_KSP	Yes	0	0 - Normal mode. CSP+KSP 1 - KSP mode
EXT_V3	Yes	1	0 - Uses extensions with manifest V2. 1 - Uses the new version of webextensions.
REQUEST_LOGIN_AT_STARTUP	Yes	0	0 - Does not log in automatically on startup. 1 - Enables automatic login on startup.
AUTO_SET_INCOGNITO_MODE	Yes	0	0 - Redtrust asks permission to close the browser before enabling incognito mode for the extension. 1 - Redtrust closes and reopens the browser automatically to enable it, without asking. *
STARTUPBOOST	Yes	0	0 - Disables and locks the Microsoft Edge fast startup option. 1 - Does not disable fast startup and leaves the option unlocked for the client.

About the AUTO_SET_INCOGNITO_MODE parameter (*)

Automatic mode (1) can't be guaranteed: by design, browsers require the user to turn on the extension in incognito themselves, so the installer can't set it dependably. See The extension in incognito and InPrivate mode for why, and for the supported alternatives.