Monitoring Agent on Windows

Installation Using the EXE Distribution

Run the agent_setup.exe file downloaded via the Windows (exe) button on the computer where you want to install the monitoring agent. During installation, the setting fields take the values specified when the file was downloaded.

To start the installation, click Next. After the installation completes, click OK.

If the application server is inaccessible from the computer where the agent is being installed, the installation results in an error.

The EXE distribution file contains CLI keys that can be used in automated installation scripts:

1. Main parameters:
   • silent — parameter that defines a "silent" installation
   • action — operation type (install/update/remove)
2. Optional parameters:
   • autoupdate_enabled — agent auto-update (true/false)
   • web_server.host — server address
   • auth.value — API key (value can be obtained from the system's web interface)
   • auth.type — authorization type for this API key (none/ad/certificate)

Example:

agent_setup.exe silent action=install autoupdate_enabled=true web_server.host=http://srv.domain.com:8010 auth.value=01235ed47546459780f1001a36e41de2 auth.type=none

Installation Using the MSI Package

The MSI package contains an MST file with pre-configured answers, which can be used in various automated software deployment systems: GPO, SCCM, and others. Installation in this case proceeds according to the recommendations of the developer of the respective system.

The downloaded archive contains 2 files:

• agent_setup.msi (installation file)
• setting.mst (configuration file)

If needed, this monitoring agent distribution can be installed using the standard Windows OS tool — msiexec.

Example msiexec command for a "silent" installation of the monitoring agent:

msiexec.exe /i "path_to_agent_setup.msi" /q TRANSFORMS="path_to_settings.mst"

Updating the Monitoring Agent

Updating the monitoring agent is performed automatically via the application server, except in cases where monitoring agents are installed using an MSI package and the Auto-update parameter was disabled in the monitoring agent settings.

Agent updates can also be performed manually. Rolling back to an older version of the agent is only possible through a complete reinstallation.

Auto-update

Once an hour, the agent service sends a request to the application server to check for a new agent version. If a new version is available on the server, the agent downloads the update and installs it.

When installing a new version of the monitoring agent, a backup of the current version is created. If the update is successful, the backup copies are deleted. If errors occur during the update, the agent restores the old version from the backup.

Phased Auto-update

Phased auto-update allows you to limit the list of computers for which auto-update will function on the application server side. Phased updating of monitoring agents is configured as follows:

1. Add the phased_agent_upgrade configuration block to the configuration file com.operavix.subsystem.monitoring.json, the path to which on the server is C:/ProgramData/Operavix/, and specify within the block:
   • stable_version — the stable agent version (must be specified and pass validation against the pattern XXX.XXX.XXX)
   • host_mask — an array of computer FQDNs in regular expression format (cannot be empty)
2. Save the changes and restart the Operavix service.

Configuration file example:

{
"partition_life_circle_time": 3,
"agent_activity_queue_dir": "agent_activity_queue",
"rdb_ch_synchronization":

{ "delay": "10s", "interval": "30s" }
,
"parsing_activity_enabled": true,
"phased_agent_upgrade":

{ "stable_version": "2.6.41", "host_masks":[".+\\.testoperavix\\.com"] }
}

To disable phased agent updates, remove the phased_agent_upgrade configuration block from the server's configuration file and restart the Operavix service. After this, monitoring agents will update in the standard mode.

Manual Update

A manual update of the monitoring agent may be required to update the agent on a specific computer. It can be performed using:

• the agent configurator
• the new version's agent distribution

To update using the monitoring agent configurator:

1. Run the agent configurator located at C:\Program Files\OperavixAgent\agent_configurator.exe.
2. In the opened window, click Update Agent.

To update using the new version's agent distribution:

1. Run the installation of the new distribution agent_setup.exe.
2. Confirm the action to update the monitoring agent.

Specifics of updating the monitoring agent are described on the page Known Limitations.

Removing the Monitoring Agent

To remove a monitoring agent installed using the EXE file, run the file C:\Program Files\OperavixAgent\agent_setup.exe. A window will open with a proposal to uninstall the program.

An agent installed using msiexec (GPO Package) can only be removed via the command:

msiexec.exe /x "path_to_agent_setup.msi" /q

A monitoring agent installed via the GPO Package can also be removed through the Windows OS Control Panel under the Programs and Features section.