Skip to content
Permalink
Browse files

[CMK-2379] - documentation update

Change-Id: I6df0063df357d4adf13100cbccb036c420800b1d
  • Loading branch information...
s-kipnis committed Aug 9, 2019
1 parent bd89dca commit 929617e22c81b91b36d15d89ba54d7d49964f864
Showing with 62 additions and 4 deletions.
  1. +62 −4 agents/wnx/install/resources/readme.txt
@@ -1,8 +1,24 @@
# New Windows Agent: FAQ

## New Directory structures
The fabric files are located in the directory %ProgramFiles(x86)%\checkmk\service\
Normally you should never switch to this folder or change files in this folder.

## Where is my log files?
The Log file is moved to %ProgramData%\checkmk\agent\log, usually you will find log file here: c:\ProgramData\checkmk\agent\log\check_mk.log
The user and bakery files are located in the directory %ProgramData%\checkmk\agent\
This directory has structure similar to directory structure of the Legacy Agent.
For example
- the Log file is in %ProgramData%\checkmk\agent\log, usually you will find log file here: c:\ProgramData\checkmk\agent\log\check_mk.log
- state files are in %ProgramData%\checkmk\agent\state
- temporary directory is %ProgramData%\checkmk\agent\tmp
- config, mrpe, bin, spool, plugins, local and so on

New subdirectories are
- bakery, %ProgramData%\checkmk\agent\bakery, which contains bakery config
- install %ProgramData%\checkmk\agent\install, which contains files installed internally by Windows Agent
- upgrade %ProgramData%\checkmk\agent\upgrade, which is used to install MSI files automatically
- backup %ProgramData%\checkmk\agent\backup, in which the Agent saves last known good user YML.
Those subdirectories are intended for internal use by bakery, agent and updater.
Backup may be used to restore your yml config

## Where is my ini file?
The New Windows Agent uses YAML files to configure own parameters.
@@ -15,10 +31,37 @@ The New Windows Agent uses YAML files to configure own parameters.
## Where is my folders?
In %ProgramData%\checkmk\agent, usually this is c:\ProgramData\checkmk\agent\


## Quick switch to factory settings
- Stop Agent
- rename ProgramData\checkmk\agent to agent.sav, for example
- Start agent

## Quick switch to bakery settings
- rename ProgramData\checkmk\agent\check_mk.user.yml to check_mk.user.yml.sav, for example
- check_mk_agent.exe reload_config


## Configuration reloading
To reload configuration after edit you may use nexte methods
- start and stop service
- command line option reload_config
The Agent supports also an automatic reload on every call from the Monitoring Site.
To enable this feature you have to set CMA_AUTO_RELOAD=yes

## What happened with Legacy Agent?
Installation of the New Windows Agent stops and disables the Legacy Agent(if it is presented).
All files of the Legacy Agent are preserved intact on the disk.
To fully uninstall the Legacy Agent you have to use Windows Uninstall Procedure using either Windows Control Panel or command line.
To fully uninstall the Legacy Agent you have to use one of those methods
- use Windows Uninstall Procedure using either Windows Control Panel or command line.
- use command line option of the new Agent remove_lgacy
- set in section global remove_legacy: yes
- use bakery

## Firewall
The current Agent version doesn't support Firewall Automation, do not forget to open for new Agent.
An old rule may be incompatible with new Agent.


## What happened with plugins and configurations files of the Legacy Agent?
After installation New Agent should migrate to Legacy Agent's configuration and plugins.
@@ -30,4 +73,19 @@ After installation New Agent should migrate to Legacy Agent's configuration and

Known Problems with Migration:
1. "logfiles" section is not supported anymore by New Agent.
2. Custom user plugins with hard coded paths may not work
2. Custom user plugins with hard coded paths may not work
3. The installation of the Baked Agent(Including Vanilla) prevents the Migration.
You have to use Packaged agent if you want to upgrade your current configuration.


## Uninstallation
The uninstallation routine will preserve user data in next directories
%ProgramData%\checkmk\agent\state
%ProgramData%\checkmk\agent\config
%ProgramData%\checkmk\agent\plugins
%ProgramData%\checkmk\agent\local
%ProgramData%\checkmk\agent\mrpe
%ProgramData%\checkmk\agent\
This is done intentionally to prevent occasional user data loss due to uninstallation.


0 comments on commit 929617e

Please sign in to comment.
You can’t perform that action at this time.