Free trial

Customize OneAgent installation on Windows

The Windows Group Policy installer can be used with command line parameters when you can't use the default settings. Note that all parameters listed below except SERVER, TENANT and TENANT_TOKEN are optional.

SERVER—The address of the DESK Server. Use the IP address or a name. Add the port number following a colon, for example http://100.20.10.1:8443.

TENANT—Your DESK environment ID. You received this ID with your activation email. By default, this setting is already set to the correct value. If you're selling DESK-based services, use this option to set your customers' IDs (available from the pool of IDs you purchased from DESK).

TENANT_TOKEN—The internal token that is used for authentication when OneAgent connects to the DESK cluster to send data. You can retrieve the tenant token from the following REST endpoint. In return, you will get a JSON object that will include the TENANT_TOKEN.

https://<ENVIRONMENTID>.live.desk.com/api/v1/deployment/installer/agent/connectioninfo?Api-Token=<API_TOKEN>

Be sure to replace <ENVIRONMENTID> and <API_TOKEN> with the proper values.

HOST_GROUP—The name of a group you want to assign the host to. For details, see Organize your environment using host groups. The host group string can only contain alphanumeric characters, hyphens, underscores, and periods. It must not start with dt. and the maximum length is 100 characters. For example HOST_GROUP=My.HostGroup_123-456 or –-set-host-group=My.HostGroup_123-456. To remove the host from a group, you must uninstall OneAgent or pass an empty value –-set-host-group="" when running a OneAgent update. You can't remove the host from a group using the HOST_GROUP parameter when updating OneAgent. The –-set-host-group parameter is available since version 1.177. For more information, see OneAgent configuration via command-line interface.

PROXY—The address of the proxy server. Use the IP address or a name. Add the port number following a colon, for example PROXY=172.1.1.128:8080. We also support IPv6 addresses. Skip the PROXY parameter to force the installer to automatically detect proxy or ask for proxy details in the GUI installer. If you want the installer to ignore proxy detection or want to skip entering proxy details, use PROXY=0.0.0.0

APP_LOG_CONTENT_ACCESS—When set to true, allows DESK OneAgent to access log files for the purpose of log monitoring. Accepted values are (true, false) or (1, 0). This option can alternatively be enabled/disabled through the Web UI.

INSTALL_PATH—Allows installation to a directory of your choice. Works only with absolute Windows paths, for example INSTALL_PATH="C:\test dir".

INFRA_ONLY—Activates cloud infrastructure monitoring mode, in place of full-stack monitoring mode. With this approach, you receive infrastructure-only health data, with no application or user performance data. For details, see Cloud infrastructure monitoring. Accepted values are 0 (deactivated) and 1 (activated). This option can alternatively be enabled/disabled through the Web UI.

USER—The user used to run the process responsible for DESK OneAgent plugin functionality. This parameter can have one of two values:

  • dtuser The default user account used to run DESK components. Applied automatically when the USER parameter isn't used.
  • no_create Disables user creation when installing DESK OneAgent. Use this for deploying DESK on Windows Server Domain Controller to avoid propagation of dtuser across the domain, which can cause interference with existing dtuser accounts on hosts that have DESK installed. You can also use this to comply with strict security policies that prohibit creation of local user accounts. Note that using USER=no_create disables DESK OneAgent plugins functionality.

Note: Parameter names are case sensitive. Use ALL CAPS for parameter names.

How to perform a silent installation on Windows

With silent installation, the DESK installer is pre-configured with parameter values that you define. This means that dialogs won't be generated during installation and no human interaction is required.

To set up silent command line installation for an MSI installer, add /quiet /qn, as in the example below:

msiexec /i DESK-OneAgent-Windows.msi SERVER="https://someserver.com" TENANT="xxx" TENANT_TOKEN="xxx" HOST_GROUP="myGroup" APP_LOG_CONTENT_ACCESS=1 /quiet /qn

To set up silent command line installation for an EXE installer, add --quiet, as in the example below:

.\DESK-OneAgent-Windows.exe HOST_GROUP="myGroup" APP_LOG_CONTENT_ACCESS=1 --quiet