Customize OneAgent installation on Windows

You can use the EXE installer and extracted MSI package with command-line parameters when you can't use the default settings. Note that when using Windows Group Policy installer, the parameters that set the communication endpoint, environment ID, and token are mandatory.

For example:
Dynatrace-OneAgent-Windows.exe --set-app-log-content-access=true --set-infra-only=false

Improved installation parameters

SERVER, TENANT, TENANT_TOKEN, PROXY, HOST_GROUP, APP_LOG_CONTENT_ACCESS will be removed in future releases. Since OneAgent version 1.185, we recommend use of the new --set-param=<value> parameters, that is --set-server, --set-tenant, --set-tenant-token, --set-proxy, --set-host-group, --set-app-log-content-access respectively.

If you mix PARAM=<value> and --set-param=<value>, the --set-param=<value> setting overrides the PARAM=<value> parameter.

Communication endpoint

The address of the OneAgent communication endpoint, which is a Dynatrace component that OneAgent sends data to. Depending on your deployment, it can be a Dynatrace Server, Dynatrace Managed Cluster, or ActiveGate. If you install OneAgent using the Dynatrace Deploy page, this is already set to the correct value. To change it, use the IP address or a name. Add the port number following a colon.

To set the communication endpoint, pass it as a parameter value:
--set-server=https://100.20.10.1:443 (recommended since OneAgent version 1.185)
or
SERVER=https://100.20.10.1:443

If you need to change the server address after installation, use --set-server in the OneAgent command-line interface.

Environment ID

The Dynatrace environment ID you received with your activation email. If you install OneAgent using the Dynatrace Deploy page, this is already set to the correct value. If you're selling Dynatrace-based services, use this option to set your customers' IDs from the pool of IDs you purchased from Dynatrace.

To set the environment ID, pass it as a parameter value:
--set-tenant=abcdefghij (recommended since OneAgent version 1.185)
or
TENANT=abcdefghij

If you need to change the tenant after installation, use --set-tenant in the OneAgent command-line interface.

Token

The internal token that is used for authentication when OneAgent connects to the communication endpoint to send data. If you install OneAgent using the Dynatrace Deploy page, this is already set to the correct value.

You can retrieve the tenant token from the following REST endpoint. In return, you will get a JSON object that includes the token.

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

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

To set a token, pass is as a parameter value:
--set-tenant-token=abcdefghij123456 (recommended since version 1.185)
or
TENANT_TOKEN=abcdefghij123456

If you need to change the tenant token after installation, use --set-tenant-token in the OneAgent command-line interface.

Proxy

The address of the proxy server. Use the IP address or a name, and add the port number following a colon. For an authenticating proxy you can specify a username and password like this username:password@172.1.1.128:8080 where both username and password need to be URL encoded.

To set a proxy, pass it as a parameter value:
--set-proxy=172.1.1.128:8080 (recommended since version 1.185)
or
PROXY=172.1.1.128:8080

Dynatrace also supports IPv6 addresses.

If you need to change the proxy address after installation, use --set-proxy in the OneAgent command-line interface.

Host group

The name of a group you want to assign the host to. For details, see Organize your environment using host groups. Host group string requirements:

  • Can contain only alphanumeric characters, hyphens, underscores, and periods
  • Must not start with dt.
  • Maximum length is 100 characters

To assign a host to the host group, pass the host group name as a parameter value:
–-set-host-group=My.HostGroup_123-456 (recommended since OneAgent version 1.185)
or
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 OneAgent version 1.177. For more information, see OneAgent configuration via command-line interface.

If you need to change this access after installation, use the OneAgent command-line interface:

Cloud infrastructure monitoring mode

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.

For example:
INFRA_ONLY=1

Installation path

Allows installation to a directory of your choice. Works only with absolute Windows paths.

For example: INSTALL_PATH="C:\test dir".

Log Monitoring

When set to true, allows 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.

For example: --set-app-log-content-access=true (recommended since version 1.185)
or
APP_LOG_CONTENT_ACCESS=true

Access to system logs

OneAgent can download system logs for the purpose of diagnosing issues that may be caused by conditions in your environment. OneAgent doesn't currently download any Windows system logs, but this can change in future releases.

--set-system-logs-access-enabled=false disables access to logs --set-system-logs-access-enabled=true enables access to logs

If you need to change this access after installation, use the OneAgent command-line interface:

Note that this is a self-diagnostics setting that is not related to Log Monitoring.

OneAgent plugin user

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

  • dtuser is the default user account used to run Dynatrace components. Applied automatically when the USER parameter isn't used.
  • no_create disables user creation when installing OneAgent. Use this for deploying Dynatrace 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 Dynatrace 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 OneAgent plugins functionality.

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

Silent installation

With silent installation, the Dynatrace 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.

MSI installer silent installation

To set up silent command line installation for an MSI installer, add /quiet /qn as in this examples:

msiexec /i Dynatrace-OneAgent-Windows.msi ADDITIONAL_CONFIGURATION="--set-server=https://someserver.com --set-tenant=xxx --set-token=xxx --set-host-group=myGroup ---set-app-log-content-access=true" /quiet /qn

EXE installer silent installation

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

.\Dynatrace-OneAgent-Windows.exe --set-host-group="myGroup" --set-app-log-content-access=true --quiet