FlorianHeigl/check_mk.yml

## check_mk.yml
#
# Default Check MK configuration file
#

# Copyright Mathias Kettner GmbH

# $CUSTOM_PLUGINS_PATH$  -> is ProgramData/checkmk/agent/plugins
# $BUILTIN_PLUGINS_PATH$ -> is Program Files(x86)/checkmk/service/plugins
# $CUSTOM_AGENT_PATH$    -> is ProgramData/checkmk/agent/
# $CUSTOM_LOCAL_PATH$    -> is ProgramData/checkmk/agent/local

# 1. use http://www.yamllint.com/ for example to validate your yamllint
# 2. Windows filenames may contain backslash \, ergo you have to write either "c:\\windows" or 'c:\windows'

global:
    # section may be fully disabled
    enabled: yes

    # Restrict access to certain IP addresses
    # If ipv6 is enabled, all listed ipv4 adresses are also accepted as
    # source adresses in their ipv6-mapped form. I.e. if
    # 192.168.56.0/24 is listed, connections from ::ffff:c0a8:3800/120
    # are also possible
    only_from: # 127.0.0.1 192.168.56.0/24 ::1

    # Change port where the agent is listening ( default 6556 )
    port: 6556

    # Disable ipv6 support. By default, ipv4 is always supported
    # and ipv6 is enabled additionally if supported by the system.
    ipv6: no

    # encryption
    encrypted: no

    # password
    passphrase: secret

    # Do only execute programs and scripts with
    # the following suffixes (in local and plugins).
    execute: [exe, bat, vbs, cmd, ps1]

    # Run sync scripts in parallel (to each other). Default is "async"
    async: yes

    # Just output certain sections
    # Output order is random with exception check_mk, always first and systemtime, always last`
    sections:
        - check_mk
        - mrpe
        - skype
        - spool
        - plugins
        - local
        - winperf
        - uptime
        - systemtime
        - df
        - mem
        - services
        - msexch
        - dotnet_clrmemory
        - wmi_webservices
        - wmi_cpuload
        - ps
        - fileinfo
        - logwatch
        - openhardwaremonitor

    # sections to be skipped
    disabled_sections: [logwatch]

    #realtime data
    realtime:
        # by default we do not send realtime data to server
        enabled: no

        # specifies how long (in seconds) realtime updates are sent to
        # the last monitoring system that requested an update.
        # this should be longer than the request frequency (usually
        # one minute).
        # Please note that any new request cancels previous realtime
        # update schedules, so no more than one update is sent per second,
        # no matter if this timeout is "too high" or how many monitoring
        # systems are querying the agent.
        timeout: 90

        # Default port for realtime data
        port: 6559

        # enable/disable encryption of regular agent output (default: disabled)
        # yes or no
        encrypted: no

        # passphrase for encrypted communication.
        passphrase: this is my password

        # which sections are provided in realtime
        run: [mem, df, winperf_processor]

    # Windows may be slow during WMI, increase the value when you have problems
    # In seconds
    wmi_timeout: 3

    # Internal log of agent
    # Write a logfile for tackling down crashes of the agent
    logging:
        # folder with log file, empty is default which means '$CUSTOM_AGENT_PATH$\log'
        location:
        # name of file log, default(if file value is absent) is check_mk.log
        file :

        # log in file also internal debug messages, recommended when we have problems
        # Allowed: no, yes and all. Default: yes, this is different from the Legacy Agent settings
        debug: yes

        # you may send logging messages in realtime in windows debug sink, default is yes
        windbg: yes

        # you may disable your eventlog ability
        eventlog: yes

ps:
    enabled: yes
    # This is required for the additional ps feature below.
    use_wmi: yes
    # Include the whole path of a process and its arguments in the process list.
    full_path: no

winperf:
    enabled: yes

    # default value,  do not change it if do not know what are you douing
    exe: agent

    # changes only section name winperf_******
    prefix: winperf

    # default value,  increase for heavy loaded machine
    timeout: 10

    # Select counters to extract. The following counters
    # are needed by checks shipped with check_mk.
    # Format:
    # - id:name
    # where id is OS counter and name is part of CHECK_MK Header
    counters:
        - 234: phydisk
        - 510: if
        - 238: processor
        - MSExchangeTransport Queues:msx_queues
        - Terminal Services:ts_sessions

_logfiles:
    enabled: no
    # Define textfiles to be monitored
    # We do not support logfiles monitoring in agent at the moment
    # Please, use plugin mk_logwatch

fileinfo:
    enabled: yes
    path: []

logwatch:
    enabled: no

    sendall: no   # this value is MANDATORY, yes is useful only for debugging
    vista_api: no # this is RECOMMENDED

    logfile: # entries in the windows eventlog
        - '*': warn nocontext # This is default params for not missing entries

plugins:
    enabled: yes

    player: ''   # internal value, do not change this

    max_wait: 60 # max timeout for every sync plugin. Agen will gather plugins data no more than max_wait time.
                 # this is useful to terminate badly written or hanging plugins


    async_start: yes # start plugins asynchronous, this is default

    # folders are scanned left -> right, order is important
    # duplicated files will be removed
    folders: ['$CUSTOM_PLUGINS_PATH$', '$BUILTIN_PLUGINS_PATH$' ]       # ProgramData/checkmk/agent/plugins & Program Files x86/check/service/plugins

    # what to execute
    execution:

        - pattern     : '$BUILTIN_PLUGINS_PATH$\mk_inventory.vbs'
          run         : yes
          async       : yes
          timeout     : 120
          cache_age   : 3600
        - pattern     : '$BUILTIN_PLUGINS_PATH$\windows_updates.vbs'
          run         : yes
          async       : yes
          timeout     : 300
          cache_age   : 3600
          retry_count : 3
        - pattern     : '$BUILTIN_PLUGINS_PATH$\windows_multipath.vbs'
          run         : yes
        - pattern     : '$BUILTIN_PLUGINS_PATH$\ad_replication.bat'
          run         : yes
        - pattern     : '$BUILTIN_PLUGINS_PATH$\win_dhcp_pools.bat'
          run         : yes
        - pattern     : '$BUILTIN_PLUGINS_PATH$\hyperv*.*'
          run         : yes
        - pattern     : '$BUILTIN_PLUGINS_PATH$\windows*bonding.*'
          run         : yes
        - pattern     : '$BUILTIN_PLUGINS_PATH$\rds_licenses.*'
          run         : yes
        # Default behavior as in 1.5
        - pattern     : '$CUSTOM_PLUGINS_PATH$\*.*'         # Look for executable files in the ProgramData folder.
          timeout     : 60                  # in seconds, after expiring timeout, process will be killed.
          run         : yes                 # ALL FOUND files ARE ENABLED
        - pattern     : '$BUILTIN_PLUGINS_PATH$\*.*'         # Look for files in the ProgramFiles folder.
          timeout     : 60                  # in seconds, after expiring timeout, process will be killed.
          run         : no                  # ALL FOUND files ARE DISABLED

        - pattern     : '*'                 # This is safety entry.
          run         : no                  # ALL other FOUND files ARE DISABLED TOO.

# The same as plugins with same parameters
# But: used folder local
local:
    # scripts in plugin
    enabled: yes

    player: ''   # default value

    max_wait: 60 # max timeout for every sync plugin. Agent will gather plugins data no more than max_wait time.
                 # this is useful to terminate badly written or hanging plugins


    async_start: true # start plugins asynchronous, this is default

    execution:
        # all parameters below are DEFAULT set for every entry

        - pattern     : '*.*'           # in the local folder.
          timeout     : 60              # in seconds, after expiring timeout all processes matching the pattern will be killed.
          run         : yes             # ALL FOUND files ARE ENABLEDr


mrpe:
    enabled: yes

    # Allows to run MRPE scripts in parallel, this parameter is intended only
    # for experienced users and developers.
    parallel: no

    # 60 is default, this is safe value, because mrpe checks are relative fast ->
    # hitting this timeout is virtually not possible
    timeout: 60

    # entries and cfg have  the same format as in the Legacy agent
    config:
        # - check = Console 'c:\windows\system32\mode.com' CON CP /STATUS
        # - include user_name = $CUSTOM_AGENT_PATH$\mrpe_checks.cfg
        # - include = $CUSTOM_AGENT_PATH$\mrpe_checks.cfg
	#
	# Default Check MK configuration file
	#

	# Copyright Mathias Kettner GmbH

	# $CUSTOM_PLUGINS_PATH$ -> is ProgramData/checkmk/agent/plugins
	# $BUILTIN_PLUGINS_PATH$ -> is Program Files(x86)/checkmk/service/plugins
	# $CUSTOM_AGENT_PATH$ -> is ProgramData/checkmk/agent/
	# $CUSTOM_LOCAL_PATH$ -> is ProgramData/checkmk/agent/local

	# 1. use http://www.yamllint.com/ for example to validate your yamllint
	# 2. Windows filenames may contain backslash \, ergo you have to write either "c:\\windows" or 'c:\windows'

	global:
	# section may be fully disabled
	enabled: yes

	# Restrict access to certain IP addresses
	# If ipv6 is enabled, all listed ipv4 adresses are also accepted as
	# source adresses in their ipv6-mapped form. I.e. if
	# 192.168.56.0/24 is listed, connections from ::ffff:c0a8:3800/120
	# are also possible
	only_from: # 127.0.0.1 192.168.56.0/24 ::1

	# Change port where the agent is listening ( default 6556 )
	port: 6556

	# Disable ipv6 support. By default, ipv4 is always supported
	# and ipv6 is enabled additionally if supported by the system.
	ipv6: no

	# encryption
	encrypted: no

	# password
	passphrase: secret

	# Do only execute programs and scripts with
	# the following suffixes (in local and plugins).
	execute: [exe, bat, vbs, cmd, ps1]

	# Run sync scripts in parallel (to each other). Default is "async"
	async: yes

	# Just output certain sections
	# Output order is random with exception check_mk, always first and systemtime, always last`
	sections:
	- check_mk
	- mrpe
	- skype
	- spool
	- plugins
	- local
	- winperf
	- uptime
	- systemtime
	- df
	- mem
	- services
	- msexch
	- dotnet_clrmemory
	- wmi_webservices
	- wmi_cpuload
	- ps
	- fileinfo
	- logwatch
	- openhardwaremonitor

	# sections to be skipped
	disabled_sections: [logwatch]

	#realtime data
	realtime:
	# by default we do not send realtime data to server
	enabled: no

	# specifies how long (in seconds) realtime updates are sent to
	# the last monitoring system that requested an update.
	# this should be longer than the request frequency (usually
	# one minute).
	# Please note that any new request cancels previous realtime
	# update schedules, so no more than one update is sent per second,
	# no matter if this timeout is "too high" or how many monitoring
	# systems are querying the agent.
	timeout: 90

	# Default port for realtime data
	port: 6559

	# enable/disable encryption of regular agent output (default: disabled)
	# yes or no
	encrypted: no

	# passphrase for encrypted communication.
	passphrase: this is my password

	# which sections are provided in realtime
	run: [mem, df, winperf_processor]

	# Windows may be slow during WMI, increase the value when you have problems
	# In seconds
	wmi_timeout: 3

	# Internal log of agent
	# Write a logfile for tackling down crashes of the agent
	logging:
	# folder with log file, empty is default which means '$CUSTOM_AGENT_PATH$\log'
	location:
	# name of file log, default(if file value is absent) is check_mk.log
	file :

	# log in file also internal debug messages, recommended when we have problems
	# Allowed: no, yes and all. Default: yes, this is different from the Legacy Agent settings
	debug: yes

	# you may send logging messages in realtime in windows debug sink, default is yes
	windbg: yes

	# you may disable your eventlog ability
	eventlog: yes

	ps:
	enabled: yes
	# This is required for the additional ps feature below.
	use_wmi: yes
	# Include the whole path of a process and its arguments in the process list.
	full_path: no

	winperf:
	enabled: yes

	# default value, do not change it if do not know what are you douing
	exe: agent

	# changes only section name winperf_******
	prefix: winperf

	# default value, increase for heavy loaded machine
	timeout: 10

	# Select counters to extract. The following counters
	# are needed by checks shipped with check_mk.
	# Format:
	# - id:name
	# where id is OS counter and name is part of CHECK_MK Header
	counters:
	- 234: phydisk
	- 510: if
	- 238: processor
	- MSExchangeTransport Queues:msx_queues
	- Terminal Services:ts_sessions

	_logfiles:
	enabled: no
	# Define textfiles to be monitored
	# We do not support logfiles monitoring in agent at the moment
	# Please, use plugin mk_logwatch

	fileinfo:
	enabled: yes
	path: []

	logwatch:
	enabled: no

	sendall: no # this value is MANDATORY, yes is useful only for debugging
	vista_api: no # this is RECOMMENDED

	logfile: # entries in the windows eventlog
	- '*': warn nocontext # This is default params for not missing entries

	plugins:
	enabled: yes

	player: '' # internal value, do not change this

	max_wait: 60 # max timeout for every sync plugin. Agen will gather plugins data no more than max_wait time.
	# this is useful to terminate badly written or hanging plugins


	async_start: yes # start plugins asynchronous, this is default

	# folders are scanned left -> right, order is important
	# duplicated files will be removed
	folders: ['$CUSTOM_PLUGINS_PATH$', '$BUILTIN_PLUGINS_PATH$' ] # ProgramData/checkmk/agent/plugins & Program Files x86/check/service/plugins

	# what to execute
	execution:

	- pattern : '$BUILTIN_PLUGINS_PATH$\mk_inventory.vbs'
	run : yes
	async : yes
	timeout : 120
	cache_age : 3600
	- pattern : '$BUILTIN_PLUGINS_PATH$\windows_updates.vbs'
	run : yes
	async : yes
	timeout : 300
	cache_age : 3600
	retry_count : 3
	- pattern : '$BUILTIN_PLUGINS_PATH$\windows_multipath.vbs'
	run : yes
	- pattern : '$BUILTIN_PLUGINS_PATH$\ad_replication.bat'
	run : yes
	- pattern : '$BUILTIN_PLUGINS_PATH$\win_dhcp_pools.bat'
	run : yes
	- pattern : '$BUILTIN_PLUGINS_PATH$\hyperv.'
	run : yes
	- pattern : '$BUILTIN_PLUGINS_PATH$\windowsbonding.'
	run : yes
	- pattern : '$BUILTIN_PLUGINS_PATH$\rds_licenses.*'
	run : yes
	# Default behavior as in 1.5
	- pattern : '$CUSTOM_PLUGINS_PATH$\.' # Look for executable files in the ProgramData folder.
	timeout : 60 # in seconds, after expiring timeout, process will be killed.
	run : yes # ALL FOUND files ARE ENABLED
	- pattern : '$BUILTIN_PLUGINS_PATH$\.' # Look for files in the ProgramFiles folder.
	timeout : 60 # in seconds, after expiring timeout, process will be killed.
	run : no # ALL FOUND files ARE DISABLED

	- pattern : '*' # This is safety entry.
	run : no # ALL other FOUND files ARE DISABLED TOO.

	# The same as plugins with same parameters
	# But: used folder local
	local:
	# scripts in plugin
	enabled: yes

	player: '' # default value

	max_wait: 60 # max timeout for every sync plugin. Agent will gather plugins data no more than max_wait time.
	# this is useful to terminate badly written or hanging plugins


	async_start: true # start plugins asynchronous, this is default

	execution:
	# all parameters below are DEFAULT set for every entry

	- pattern : '.' # in the local folder.
	timeout : 60 # in seconds, after expiring timeout all processes matching the pattern will be killed.
	run : yes # ALL FOUND files ARE ENABLEDr


	mrpe:
	enabled: yes

	# Allows to run MRPE scripts in parallel, this parameter is intended only
	# for experienced users and developers.
	parallel: no

	# 60 is default, this is safe value, because mrpe checks are relative fast ->
	# hitting this timeout is virtually not possible
	timeout: 60

	# entries and cfg have the same format as in the Legacy agent
	config:
	# - check = Console 'c:\windows\system32\mode.com' CON CP /STATUS
	# - include user_name = $CUSTOM_AGENT_PATH$\mrpe_checks.cfg
	# - include = $CUSTOM_AGENT_PATH$\mrpe_checks.cfg