Skip to main content

# Installing the agent on Microsoft Windows

Start the Microsoft installer file `agent-25-setup.exe` and follow the instructions on the screen:

1. On the introduction screen click Next.
2. Read and accept the license agreement and click I Agree.
3. Choose installation location and click Next.
4. The installer will search for a suitable Java Runtime Environment.
   If no suitable Java Virtual Machine is found automatically, click Select Java to choose an installed Java Virtual Machine.
   Click Next to continue if a Java Virtual Machine is defined.
5. To define a custom agent listener port in case the default port (`9051`) does not match, select the Set Agent Port checkbox and enter the custom port. If the port settings are correct proceed by clicking Next.

caution

If you change this value, you must set the AgentListenerPort monitoring parameter for this Server accordingly. See Parameter Sets for more information.

6. On the next page, options for agent self registration can be specified. Please refer to Installation with Avantra Agent Self-Registration
7. Read the Windows Firewall configuration rules which will be added to your system. Click Next to proceed.
8. On the next screen, you can define a different service user. The Avantra Agent service by default runs using the `LocalSystem` user account. This user may not be allowed to access network resources. If some of your SAP Systems profile data are located on remote (shared) resources, the SAP System will most likely not be monitored. In this case, it's necessary to change the service user to an operating system user allowed to read the network resources (e.g. the SAP System's `[sid]adm` user).

note

Using the SAP System's `[sid]adm` as the service user is especially recommended for Java-only SAP System running with a MaxDB.

If you have chosen the user account click Install to proceed.

9. Wait until Avantra Agent installation is completed. Click Next to proceed.
10. Select Start Avantra Agent to start the windows service now. You can also start Avantra Agent later in Windows Services. Click Finish to finish the installation.

note

In case there is any issue with the installation, you can find the log files in `%TEMP%\Avantra Installation Logs\`

## Unattended / silent installation on Microsoft Windows operating systems​

The Avantra Agent can be installed in an unattended (silent) mode. This is useful if the Agent is installed on many servers with scripts.

Following options can be set to configure the installation:

Option | Description
--- | ---
`/S` | Required. Start the Agent in silent mode.
`/JAVA_PATH` | Required. Path to Java installation directory. Do NOT point to `java.exe` or `jvm.dll`, JAVA_PATH must point to the directory where java is installed.
`/PORT` | Required. The port used for the Agent (default is 9051).
`/START_SERVICE` | Optional. Set to 1 if the Agent should be started immediately after the installation.
`/USER` | Optional. Set the service user. If not set the Local System account user is used.
`/PASSWORD` | Optional. Set the password of the service user. Only required if USER is set (see above).
`/D` | Optional. Installation path. This setting must be the last! Spaces are allowed. If you use spaces, do not wrap with `""`. If you do not set the path, the Avantra Agent will be installed to `%ProgramFiles%\syslink\agent`.

Example 1: Install the Agent into the default directory

    agent-{product-release-n}.-setup.exe /S /JAVA_PATH="C:\Program Files\Java\jre-17" /PORT=9051

Example 2: Install the Agent into a different directory and start automatically

    agent-{product-release-n}-setup.exe /S /JAVA_PATH="C:\Program Files\Java\jre-17" /PORT=9051 /START_SERVICE=1 /D=C:\syslink

## Installation with automatic Agent registration​

This feature allows the Avantra Agent to self-register, eliminating the need for administrators to perform these tasks.

There are two options to activate the self-registration mode on Microsoft Windows:

- Enable the Activate Self Registration check box in the installer and fill in the corresponding fields:

- Use the silent command line options below:

`agent-24.0.0-setup.exe /S /SELF_REG=direct /SR_MASTERHOST=masterhost /SR_MASTERPORT=9050 /SR_AGENTADDRESS=the.agent.com /SR_CUSTID=1 /SR_SYSTEMROLE=development`

`agent-24.0.0-setup.exe /S /SELF_REG=routing /SR_MASTERROUTE=masterroute:9050 /SR_AGENTADDRESS=the.agent.com /SR_CUSTID=1 /SR_SYSTEMROLE=development`