Installing an Open Single Management Platform agent on Windows assets

Prior to installing an Open Single Management Platform agent to a Windows asset, the server administrator must create a user account with the EventLogReaders and Log on as a service permissions on the Windows asset. This user account must be used to start the agent.
If you want to run the agent under a local account, you will need administrator rights and Log on as a service. If you want to perform the collection remotely and only read logs under a domain account, EventLogReaders rights are sufficient.

To install an Open Single Management Platform agent to a Windows asset:

1. Copy the kuma.exe file to a folder on the Windows asset. C:\Users\<User name>\Desktop\Open Single Management Platform folder is recommended for installation.

   The kuma.exe file is located inside the installer in the /kuma-ansible-installer/roles/kuma/files/ folder.

2. Start the Command Prompt on the Windows asset with Administrator privileges and locate the folder containing the kuma.exe file.
3. Execute the following command:

   kuma agent --core https://<fully qualified domain name of the Open Single Management Platform Core server>:<port used by the Open Single Management Platform Core server for internal communications (port 7210 by default)> --id <ID of the agent service that was created in Open Single Management Platform> --user <name of the user account used to run the agent, including the domain> --install [--accept-eula]

   To run the agent, you need to accept the End User License Agreement. You can add the --accept-eula option to the command to automatically accept the End User License Agreement during agent installation. This lets you perform the installation non-interactively. If you do not specify this option, you will need to accept or reject the License Agreement manually during the installation of the Open Single Management Platform agent.

   Examples:

   • Installing the Open Single Management Platform agent without automatically accepting the End User License Agreement:

     kuma agent --core https://kuma.example.com:7210 --id XXXXX --user domain\username --install

   • Installing the Open Single Management Platform agent with automatic acceptance of the End User License Agreement:

     kuma agent --core https://kuma.example.com:7210 --id XXXXX --user domain\username --install --accept-eula

   By using the --accept-eula option during the installation of the KUMA agent, you confirm that you agree with and accept the terms and conditions of the End User License Agreement.

   You can get help information by executing the kuma help agent command.

4. If you started the installation of the agent without automatically accepting the End User License Agreement, during the installation process, you will be prompted to read the text of the End User License Agreement and you will have the opportunity to accept or reject the agreement.
5. If you chose installation with the automatic acceptance of the End User License Agreement and want to read the text of the End User License Agreement, or if the text of the End User License Agreement was not automatically provided to you during the installation process, run the following command:

   kuma.exe license --show

   If you want to accept the End User License Agreement, run the following command and press y:

   kuma.exe license

6. Specify the password for the agent's user in one the following ways:
   • Manually.
   • From a file when installing the agent.

     To avoid entering the password manually, you can add the password to a .TXT file and place the file in the same directory as the executable file of the agent.

     Specify the file containing the password in the command. For example:

     kuma agent --core https://kuma.example.com:7210 --id XXXXX --user domain\username --install < <name of the file with the password>.txt

     All data from the password file (for example, password.txt) is redirected to the command as the password, excluding end-of-line characters (\n\r, \n).

     Path for storing the agent folder after installation: C:\ProgramData\Kaspersky Lab\Open Single Management Platform\agent\${agent_id}.

   If you did not accept the End User License Agreement (EULA) before installing the agent with the < <password file name>.txt flag, an error message is displayed saying that the agreement was not accepted.

   You can accept the EULA in the following ways:

   1. In the password file, you can specify the EULA acceptance flag. To achieve this, the file with the password must contain two lines: the first line containing "y", which serves to assert EULA acceptance, and the second line containing the password. For example:

      y

      <password>

      The agent installation command looks like this:

      kuma agent --core https://kuma.example.com:7210 --id XXXXX --user domain\username --install < <name of the file with the password>.txt

      In this case, you will not need to additionally accept the EULA when installing the agent.

      If the EULA has been accepted before running the command with the password file, the first line in the file is interpreted as the password and the installation is aborted with the Access denied error.

   2. You can accept the EULA and perform a silent installation at the same time by using the --accept-eula flag.

      The agent installation command looks like this:

      kuma agent --core https://kuma.example.com:7210 --id XXXXX --user domain\username --accept-eula --install < <name of the file with the password>.txt

      Make sure that only the password is specified in the file, on the first line, otherwise an error will occur.

The C:\ProgramData\Kaspersky Lab\Open Single Management Platform\agent\<agent ID> folder is created and the Open Single Management Platform agent service is installed in it. The agent forwards Windows events to Open Single Management Platform, and you can set up a collector to receive them.

When the agent service is installed, it starts automatically. The service is also configured to restart in case of any failures. The agent can be restarted from the Open Single Management Platform web interface, but only when the service is active. Otherwise, the service needs to be manually restarted on the Windows asset.

Removing an Open Single Management Platform agent from Windows assets

When configuring services, you can check the configuration for errors before installation by running the agent with the following command:

kuma agent --core https://<fully qualified domain name of the Open Single Management Platform Core server>:<port used by the Open Single Management Platform Core server for internal communications (port 7210 by default)> --id <ID of the agent service that was created in Open Single Management Platform> --user <name of the user account used to run the agent, including the domain>

Page top