Tableau Server on Windows Help

After installing the RMT Agent you need to initialise the Agent. By default the only required flag you must include when running the initialisation script is --accepteula. Other options give you flexibility to customise the installation based on your environment and the security requirements of your enterprise.

RMT Agent initialisation options

--accepteula

Required.

Indicates you have read and accepted the terms of the End User Licence Agreement (EULA).

-a <username>

Optional.

Add the provided username to the appropriate groups, instead of the user running the initialise script. This gives the user access to the resources owned by the groups. This is not the same as the Run As user account.

Default: the user running the initialisation script

-f

Optional.

Bypass warning messages or distribution version check.

-h | -?

Optional.

Displays the script's help text.

-q

Optional.

Quiet, suppress output except for errors and warnings.

--debug

Optional.

Print each command as it is run for debugging purposes. Produces extensive output.

--default-group=<value>

Version: Added in version 2023.1.0.

Optional.

Name of the group that allows authorisation to access Tableau RMT Agent. If specified then --unprivileged-user must also be specified.

---disable-account-creation

Version: Added in version 2023.1.0.

Optional.

Accounts/groups, that do not exist, will not be created. If specified, then you must also specify the --unprivileged-user parameter and a combination of the --default-group and/or other --rmt-<...>-group parameters. The user ID and groups those parameters refer to must already exist.

--rmt-authorised-group=<value>

Version: Added in version 2023.1.0.

Optional.

Name of the group that owns the install base install directory and the install_dir/prerequisites folder. If specified then --unprivileged-user must also be specified.

Default: "rmtagentapp" or --default-group value

--rmt-config-group=<value>

Version: Added in version 2023.1.0.

Optional.

Name of the group that owns the install_dir/agent/config directory. If specified then --unprivileged-user must also be specified.

Default: "rmtagentconfig" or --default-group value

--rmt-logs-group=<value>

Version: Added in version 2023.1.0.

Optional.

Name of the group that owns the install_dir/agent/logs directory. If specified then --unprivileged-user must also be specified.

Default: "rmtagentlogs" or --default-group value

--unprivileged-user=<value>

Version: Added in version 2023.1.0.

Optional.

Name of the unprivileged user account used to run Tableau RMT Agent. You cannot change the account after initialising RMT.

Default: "tabrmt-agent"