Configuration

All runtime configuration settings needed by the SKOOR collector are contained in the file eRangerAgent.ini. There are no other configuration options in the registry (besides the registration of the program itself in Windows). Copying the eRangerAgent.ini file from one WinAgent to another one is enough to replicate all configuration settings.

The configuration file must be kept in the same directory as the executables.

WinAgent can also be started without any configuration file at all. Default values (as with a new installation) will be used in this case.

WinAgent GUI configuration

The easiest way to configure the SKOOR WinAgent is to use the Windows GUI. Click on the configuration button in the tool bar or choose “Configuration…” from the file menu.

The names in italic at the end of the option descriptions underneath are the names used in the configuration file eRangerAgent.ini.

Network settings

Setting	Description
Listen on port	Port on which the WinAgent listens for incoming connections (52998 by default)
Username	If a username is specified, this username is used for authentication. This means that the SKOOR collector must pass valid credentials to successfully make requests to the agent. auth_username (Name)
Password	Password used for authentication
SSL	If this option is set, the communication is encrypted with ssl
Keep-alive	If this option is set, TCP connections from the collector are not disconnected after the request has been received by the agent. The agent can reuse the same TCP connection for many requests. If the connection is broken, the agent opens a new connection without losing data. Setting this option may be useful if establishing a new TCP connection is very expensive or slow (i.e. if the WinAgent is in the internet or on a very slow line). Normally, this option needs not to be set. keep_alive (0 \| 1)

Authorized hosts

Only SKOOR collectors (hosts) with IPs in this list are allowed to connect. If this list is empty, all IPs are allowed to connect.

authorized_host (multiple values possible)

Log settings

These settings configure the logging of the eRanger service.

Setting	Description
Write logfile	Enables/disables logging
Logfile path	Path of the logfile. If WinAgent does not run as a service, the user that runs the WinAgent must have permission to write to this location (which is not always the case for the default C:\Program Files\Junisphere… path). log_file_path (absolute path)
Loglevel	Sets the log level (Debug > Info > Warning > Error) log_level (0 \| 1 \| 2 \| 3)
Truncate at size	If the file grows larger then this value, the file is truncated. max_log_size (size in KB)

Filetransfer options

This tab sets the permissions to send (Agent fetchfile) and receive (Agent putfile) files to/from the agent.

Setting	Description
Allow files to be received	Files can be received with Client Putfile jobs
Allowed targets	Files received from agents can be stored to these target locations. The wildcard characters * and ? can be used. receive_file (absolute path, multiple values possible)
Allow files to be sent	Files can be sent with Client Fetchfile jobs. allow_file_sending (0 \| 1)
File allowed to be sent	Files from these locations can be fetched by the agent. The wildcards characters * and ? can be used. send_file (absolute path, multiple values possible)

Do not forget to add an entry to the list with the button.

If you try to get or put a file which is not in the list or if sending/receiving functionality is disabled completely, an error message will be sent to the agent and displayed within SKOOR.

Run programs

These settings control if and which programs can be executed on the agent.

Setting	Description
Allow to run programs	Enable this option to allow programs to be run. allow_program_execution (0 \| 1)
Programs allowed	Programs in this list are allowed to be executed by the agent. The wildcard characters * and ? can be used. executable_program (absolute path, multiple values possible)
Local Windows User	If WinAgent runs as a service, all programs are executed under this Windows user. The username can be given in UPN format if it must contain the domain part (user@domain). If the username is left empty, the programs are executed in the context of the service-owner, the WinAgent is running on. This is normally the LocalSystem account. Applications that use a GUI may not work as expected (see also chapter 5.2). local_windows_user (username)
Password	Password for the user. The password is stored in encrypted form in the configuration file. local_windows_user_pwd (encrypted password)
Default Process timeout	Started processes will be killed after the given timeout (in seconds) if they are still running. This value can be overridden by setting a timeout value in the execute job. default_execute_timeout (number in seconds). If this value is 0, the process is not killed at all

Do not forget to add an entry to the list with the button.

If you try to execute a program which is not in the list or if the execution is disabled completely, an error message will be sent to the agent and displayed in SKOOR.

Service and Autorun control

This tab allows to install, uninstall and start/stop the SKOOR collector service. All these operations can also be done in the service control (see chapter 3). WinAgent must be started as Administrator to be able to control the service.

If the Start the eRanger WinAgent after login (all users) checkbox is checked, WinAgent.exe is registered as an autorun program for all users in the registry under:

HKEY_LOCAL_MACHINE\Software\Microsoft\Windows\CurrentVersion\Run

This option is visible if the WinAgent has been installed for all users and has been started as an Administrator. If the WinAgent is started as a normal User, the check box is labelled with Start the eRangerWinAgent after login (current user). If it is selected, the WinAgent is registered as an autorun program under:

HKEY_CURRENT_USER\Software\Microsoft\Windows\CurrentVersion\Run

With both options, the WinAgent is then started at login and run in the background.

Issues

Administrator privileges

The SKOOR WinAgent needs administrator privileges to read all performance data from the operating system (e.g. to see all processes from all users etc.). If reliable monitoring data shall be collected and the client cannot be started as a service (which is recommended for this use case) the user has to start the WinAgent as an administrator (right click – Run as administrator).

If the client is installed as a service, WinAgent must be started as an administrator to be able to control the service. Use the built-in Windows service control otherwise.

If the app is installed for all users in C:\Program Files\Junisphere, a normal user cannot change the configuration because he has no permission to write to the file C:\Program Files\Junisphere\eRangerAgent.ini). To be able to edit the configuration, WinAgent has to be started as an administrator.

Starting GUI applications from the agent

Services are not allowed to use the graphical user interface in Windows. If GUI applications (like EEM robot scripts) shall be started by the SKOOR WinAgent on Windows, the agent must be started as a normal application and not as a service. To be sure that the WinAgent runs as an application, uninstall the service (if it is installed).

Third Party Integrations