Customize OneAgent installation on Windows

OneAgent installer for Windows is provided and used as a self-extracting EXE file. The installer can also be extracted and used directly—as an MSI package. This later approach is mostly used in Group Policy deployment.

You can customize the installation by specifying command-line parameters for selected settings, or you can rely on default settings. However, note that parameters marked below as environment-specific—that is, parameters that set the communication endpoint, environment ID, and token—are:

Passing installation parameters

Command line

To pass the parameters, append them to the installer command and separate them with spaces.

For example, for the EXE version of the installer:

.\Dynatrace-OneAgent-Windows.exe --set-host-group=my_host_group --set-monitoring-mode=infra-only INSTALL_PATH="C:\installdir"

When using the installer as an MSI package, you can directly append only the INSTALL_PATH, LOG_PATH, DATA_STORAGE, PCAP_DRIVER, and USER parameters. This type of installation is usually run in silent mode, as part of Group Policy deployment. The --set-param=<value> has to be placed inside of ADDITIONAL_CONFIGURATION (ADDITIONAL_CONFIGURATION="--set-param=<value>").
For more information on command-line syntax, see Silent installation.

Installer UI

You can also add the --set-param=<value> parameters in the Configure OneAgent settings installation screen.

Removed installation parameters

Starting with version 1.213, the following parameters are only accepted if specified using the --set-param=<value> syntax. For these specific parameters, the equivalent PARAM=<value> syntax is no longer supported:

MSI installation parameters

INSTALL_PATH, LOG_PATH, DATA_STORAGE, PCAP_DRIVER and USER are a special kind of parameter adhering to MSI public property syntax. They won't be replaced by equivalent --set-param=<value> parameters. You can use them only on the installer command line, not in the installer UI.

Installation path

Default value: %PROGRAMFILES%\dynatrace\oneagent

The INSTALL_PATH parameter allows OneAgent installation to a directory of your choice.

For example:
.\Dynatrace-OneAgent-Windows.exe INSTALL_PATH="C:\test dir".

Custom directory requirements

Your custom installation directory must meet the following requirements:

Log path

Default value: %PROGRAMDATA%\dynatrace\oneagent\log

The LOG_PATH parameter allows you to customize your OneAgent log directory.

For example:

.\Dynatrace-OneAgent-Windows.exe LOG_PATH=C:\dynatrace\logs

Custom directory requirements

Your custom installation directory must meet the following requirements:

Changing location

If you use the parameter to change the location for an already installed OneAgent:

Data storage

OneAgent version 1.199

Default value: %PROGRAMDATA%\dynatrace\oneagent\datastorage

The DATA_STORAGE parameter allows you to define a directory dedicated to storing large runtime data produced by OneAgent in full-stack monitoring mode, such as crash reports or memory dumps.

For example:

.\Dynatrace-OneAgent-Windows.exe DATA_STORAGE=D:\data\dynatrace\runtime

Custom directory requirements

Changing location

If you use the parameter to change the location for an already installed OneAgent:

Communication endpoint

Default value: environment specific

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 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

OneAgent and Dynatrace Cluster automatically maintain a working connection. If an endpoint detail changes, the cluster notifies OneAgent of the change and OneAgent automatically updates the endpoint you set using the --set-server to the new working value.

To change the endpoint after installation, use --set-server in the OneAgent command-line interface.

Environment ID

Default value: environment specific

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=mySampleEnv

To change the tenant after installation, use --set-tenant in the OneAgent command-line interface.

Token

Default value: environment specific

The tenant 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.

To set a token, pass it as a parameter value:

--set-tenant-token=abcdefghij123456

See Access tokens to learn how to obtain a token.

To change the tenant token after installation, use --set-tenant-token in the OneAgent command-line interface.

Network zones

Default value: unset

To learn about network zone naming rules and other reference information, see Network zones.

Use the --set-network-zone parameter to instruct OneAgent to communicate via the specified network zone:

--set-network-zone=your.network.zone

To change or clear the network zone assignment after installation, use Remote configuration management (select the modify network zone action).

Alternatively, you can use --set-network-zone on the OneAgent command-line interface.

Proxy

Default value: unset

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

Dynatrace also supports IPv6 addresses.

To change or clear the proxy address after installation, use --set-proxy in the OneAgent command-line interface.

Port range

deprecated

Default value: 50000:50100

Watchdog is a binary used for starting and monitoring OneAgent monitoring processes:

Use the --set-watchdog-portrange=<arg> parameter to change the watchdog listening port range to <arg>. The <arg> must contain two port numbers separated by a colon (:). For example 50000:50100. The maximum supported port range is from 1024 to 65535. The port range must cover at least 4 ports. The port number starting the range must be lower. For example:

--set-watchdog-portrange=50000:50100

To change port range after installation, use --set-watchdog-portrange in the OneAgent command-line interface.

Auto-update

Use the --set-auto-update-enabled=<arg> to enable or disable OneAgent auto-update. For example:

--set-auto-update-enabled=true

After you set the parameter to false, you won't be able to control OneAgent automatic updates using the Dynatrace web UI at Settings > Updates > OneAgent updates.

Host group

Default value: unset

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:

To assign a host to the host group, pass the host group name as a parameter value:

--set-host-group=My.HostGroup_123-456

To remove the host from a group, you need to 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.

To change or clear the host group assignment after installation, use Remote configuration management (select the modify host group action).

Alternatively, you can use --set-host-group in the OneAgent command-line interface.

Monitoring mode

Default value: fullstack

Activates one of the OneAgent monitoring modes:

To enable a specific monitoring mode, set the --set-monitoring-mode parameter to one of the following values:

For example:

--set-monitoring-mode=infra-only

To change the monitoring mode after installation, use --set-monitoring-mode in the OneAgent command-line interface or set it using the Host settings page.

Custom host name

Default value: unset

Use the --set-host-name to override an automatically detected host name. The host name value must not contain the <, >, &, CR (carriage return), and LF (line feed) characters and the maximum length is 256 characters.

To set the host name:

--set-host-name=myhostname

To change the host name after installation, use --set-host-name in the OneAgent command-line interface.

Custom host metadata

Default value: unset

Once configured, custom metadata is displayed as a set of properties at the bottom of the Properties and tags section of the host overview page. The property values must not contain the = (except key-value delimiter) and whitespace characters. The maximum length is 256 characters including the key-value delimiter.

To add or change host properties:

--set-host-property=AppName --set-host-property=Environment=Dev

You can add or change more than one property in the same command.

To change the host metadata after installation, use Remote configuration management (select modify host properties action).

Alternatively, you can use --set-host-property in the OneAgent command-line interface.

Custom host tags

Default value: unset

Once configured, the tags are displayed at the top of the Properties and tags section of the host overview page. The property values must not contain the = (except key-value delimiter) and whitespace characters. The maximum length is 256 characters including the key-value delimiter.

To add or change host tags:

--set-host-tag=TestHost --set-host-tag=role=fallback --set-host-tag=Gdansk

You can add or change more than one tag in the same command. It is allowed to define tags with the same key but different values.

To change the host tags after installation, use Remote configuration management (select the modify host tags action).

Alternatively, you can use --set-host-tag in the OneAgent command-line interface.

Host ID source

Default value: auto

Available on all supported platforms for OneAgent version 1.223+. For OneAgent version 1.221 and earlier, this feature is supported only for Citrix Virtual Apps and Desktops.

It's particularly important to keep your host ID static in dynamic virtual environments where hosts are recreated on a daily basis.

To define the source for host ID generation, use --set-host-id-source and set it to one of the predefined values:

For example, to set the host ID source to ip-addresses and assign it to a namespace called test, run the OneAgent installer with the following parameter:

--set-host-id-source="ip-addresses;namespace=test"

To install OneAgent on a Citrix host, set the host ID source to FQDN:

--set-host-id-source="fqdn;namespace=test"

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.

Log Monitoring

Default value: true

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

If you need to enable or disable Log Monitoring after installation, use -set-app-log-content-access in OneAgent command-line interface.

Automatic injection

Default value: true

You can set the --set-auto-injection-enabled=<arg> parameter to true or false to disable or enable OneAgent auto-injection.

For more information, see Automatic injection.

Local metric ingestion

Default value: 14449

You can use the --set-extensions-ingest-port=<arg> parameter to change the default communication port used for local metric ingestion. The port is used by OneAgent REST API, Scripting integration (dynatrace_ingest), and Telegraf.

For more information, see Metric ingestion.

StatsD metric ingest

Default value: 18125

You can use the --set-extensions-statsd-port=<arg> parameter to change the default DynatraceStatsD UDP listening port.

For more information, see Metric ingestion.

OneAgent extension user

The Default value: LocalSystem (OneAgent version 1.195+)

Use the USER parameter to define the user running the process responsible for Dynatrace OneAgent extensions functionality. For example:

.\Dynatrace-OneAgent-Windows.exe USER=LocalService

If you don't add the USER parameter:

The USER parameter can have one of the following values:

When deploying Dynatrace on Windows Server Domain Controller, make sure the USER parameter is set to LocalSystem, or alternatively LocalService, to avoid propagation of dtuser across the domain, which can cause interference with existing dtuser accounts on hosts that have Dynatrace installed.

Silent installation

When using the silent installation mode, the OneAgent installer should be pre-configured with appropriate parameter values, since interactive dialogs and prompts will not be displayed during installation.

MSI package—silent installation

To set up silent command-line installation when using an MSI package, add /quiet /qn as in these examples:

Command shell

msiexec /i C:\some\path\Dynatrace-OneAgent-Windows.msi ADDITIONAL_CONFIGURATION="--set-server=https://someserver.com --set-tenant=xxx --set-tenant-token=xxx --set-host-group=myGroup" /quiet /qn

PowerShell 3.0+

msiexec /i C:\some\path\Dynatrace-OneAgent-Windows.msi --% ADDITIONAL_CONFIGURATION="--set-server=https://someserver.com --set-tenant=xxx --set-tenant-token=xxx --set-host-group=myGroup" /quiet /qn

Note the --% stop-parsing symbol used in the PowerShell command.

EXE installer—silent installation

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

.\Dynatrace-OneAgent-Windows.exe --set-host-group="myGroup" --quiet

Packet capture driver (pcap)

OneAgent version 1.229+

The PCAP_DRIVER parameter allows you to specify which packet capture driver will be installed and used for network metrics collection.

Example:

.\Dynatrace-OneAgent-Windows.exe PCAP_DRIVER=npcap

Default value: npcap

Possible values:

For more information, see