Code: Select all
# If you want to fill this file with all avalible options run the following command:
# nscp settings --generate --add-defaults --load-all
# If you want to activate a module and bring in all its options use:
# nscp settings --activate-module <MODULE NAME> --add-defaults
# For details run: nscp settings --help
; Undocumented section
[/settings/default]
; Undocumented key
password = xxxxxxxxxxx
; Undocumented key
allowed hosts = 1.1.1.1
; CACHE ALLOWED HOSTS - If host names (DNS entries) should be cached, improves speed and security somewhat but won't allow you to have dynamic IPs for your Nagios server.
cache allowed hosts = 1
; TIMEOUT - Timeout when reading packets on incoming sockets. If the data has not arrived within this time we will bail out.
timeout = 120
; INBOX - The default channel to post incoming messages on
inbox = inbox
; Undocumented section
[/settings/NRPE/server]
; Undocumented key
verify mode = none
; Undocumented key
insecure = true
; ENABLE SSL ENCRYPTION - This option controls if SSL should be enabled.
;use ssl = 1
; COMMAND ALLOW NASTY META CHARS - This option determines whether or not the we will allow clients to specify nasty (as in |`&><'"\[]{}) characters in arguments.
allow nasty characters = 1
; COMMAND ARGUMENT PROCESSING - This option determines whether or not the we will allow clients to specify arguments to commands that are executed.
allow arguments = 1
; PORT NUMBER - Port to use for NRPE.
port = 5666
; EXTENDED RESPONSE - Send more then 1 return packet to allow response to go beyond payload size (requires modified client if legacy is true this defaults to false).
extended response = 0
; ENABLE SSL ENCRYPTION - This option controls if SSL should be enabled.
use ssl = 1
; Undocumented section
[/modules]
; Undocumented key
CheckExternalScripts = 1
; Undocumented key
CheckHelpers = 1
; Undocumented key
CheckNSCP = 1
; Undocumented key
CheckDisk = 1
; Undocumented key
CheckSystem = 1
; Undocumented key
NSClientServer = 1
; Undocumented key
CheckEventLog = 1
; Undocumented key
NSCAClient = 1
; Undocumented key
NRPEServer = 1
; SimpleFileWriter - Write status updates to a text file (A bit like the NSCA server does)
SimpleFileWriter = 0
; PythonScript - Loads and processes internal Python scripts
PythonScript = 0
; NRDPClient - NRDP client can be used both from command line and from queries to check remote systes via NRDP
NRDPClient = 0
; DotnetPlugin - Plugin to load and manage plugins written in dot net.
DotnetPlugins = 0
; CommandClient - A command line client, generally not used except with "nscp test".
CommandClient = 0
; NSCAServer - A server that listens for incoming NSCA connection and processes incoming requests.
NSCAServer = 0
; CheckLogFile - File for checking log files and various other forms of updating text files
CheckLogFile = 0
; SyslogClient - Forward information as syslog messages to a syslog server
SyslogClient = 0
; Scheduler - Use this to schedule check commands and jobs in conjunction with for instance passive monitoring through NSCA
Scheduler = 0
; NRPEClient - NRPE client can be used both from command line and from queries to check remote systes via NRPE as well as configure the NRPE server
NRPEClient = 0
; WEBServer - A server that listens for incoming HTTP connection and processes incoming requests. It provides both a WEB UI as well as a REST API in addition to simplifying configuration of WEB Server module.
WEBServer = 0
; GraphiteClient - Graphite client can be used to submit graph data to a graphite graphing system
GraphiteClient = 0
; SMTPClient - SMTP client can be used both from command line and from queries to check remote systes via SMTP
SMTPClient = 0
; CheckWMI - Check status via WMI
CheckWMI = 0
; SimpleCache - Stores status updates and allows for active checks to retrieve them
SimpleCache = 0
; CheckTaskSched - Check status of your scheduled jobs.
CheckTaskSched = enabled
; A list of available remote target systems
[/settings/targets]
; Configure which services has to be in which state
[/settings/system/windows/service mapping]
; A set of options to configure the real time checks
[/settings/system/windows/real-time]
; Section for system checks and system settings
[/settings/system/windows]
; DEFAULT LENGTH - Used to define the default interval for range buffer checks (ie. CPU).
default buffer length = 1h
; Section for configuring the shared session.
[/settings/shared session]
; ENABLE THE SAHRED SESSION - This is currently not added in 0.4.x
enabled = false
; Section for the PythonScripts module.
[/settings/python]
; A set of options to configure the real time checks
[/settings/logfile/real-time]
; REAL TIME CHECKING - Spawns a background thread which waits for file changes.
enabled = 0
; Configure log file properties.
[/settings/log/file]
; MAXIMUM FILE SIZE - When file size reaches this it will be truncated to 50% if set to 0 (default) truncation will be disabled
max size = 0
; A list of scripts available to run from the PythonScript module.
[/settings/python/scripts]
; Configure log properties.
[/settings/log]
; LOG LEVEL - Log level to use. Available levels are error,warning,info,debug,trace
level = info
; FILENAME - The file to write log data to. Set this to none to disable log to file.
file name = ${exe-path}/nsclient.log
; DATEMASK - The size of the buffer to use when getting messages this affects the speed and maximum size of messages you can recieve.
date format = %Y-%m-%d %H:%M:%S
; Section for simple file writer module (SimpleFileWriter.dll).
[/settings/writers/file]
; MESSAGE SYNTAX - The syntax of the message to write to the line. Can be any arbitrary string as well as include any of the following special keywords:${command} = The command name, ${host} the host, ${channel} the recieving channel, ${alias} the alias for the command, ${alias-or-command} = alias if set otherweise command, ${message} = the message data (no escape), ${result} = The result status (number).
syntax = ${alias-or-command} ${result} ${message}
; FILE TO WRITE TO - The filename to write output to.
file = output.txt
; CHANNEL - The channel to listen to.
channel = FILE
; Section for graphite passive check module.
[/settings/graphite/client]
; CHANNEL - The channel to listen to.
channel = GRAPHITE
; HOSTNAME - The host name of this host if set to blank (default) the windows name of the computer will be used.
hostname = auto
; A list of wrapped scripts (ie. scruts using a template mechanism). The template used will be defined by the extension of the script.
[/settings/external scripts/wrapped scripts]
; Target definition for: default
[/settings/syslog/client/targets/default]
; TODO -
warning severity = warning
; TODO -
tag_syntax = NSCA
; TODO -
severity = error
; TODO -
ok severity = informational
; TODO -
message_syntax = %message%
; TODO -
facility = kernel
; TODO -
critical severity = critical
; TODO -
unknown severity = emergency
; Section for external scripts configuration options (CheckExternalScripts).
[/settings/external scripts]
; COMMAND TIMEOUT - The maximum time in seconds that a command can execute. (if more then this execution will be aborted). NOTICE this only affects external commands not internal ones.
timeout = 60
; COMMAND ALLOW NASTY META CHARS - This option determines whether or not the we will allow clients to specify nasty (as in |`&><'"\[]{}) characters in arguments.
allow nasty characters = 1
; COMMAND ARGUMENT PROCESSING - This option determines whether or not the we will allow clients to specify arguments to commands that are executed.
allow arguments = 1
; Section for SYSLOG passive check module.
[/settings/syslog/client]
; CHANNEL - The channel to listen to.
channel = syslog
; A set of options to configure the real time checks
[/settings/eventlog/real-time]
; STARTUP AGE - The initial age to scan when starting NSClient++
startup age = 30m
; REAL TIME CHECKING - Spawns a background thread which detects issues and reports them back instantly.
enabled = 0
; LOGS TO CHECK - Comma separated list of logs to check
log = application,system
; DEBUG - Log missed records (useful to detect issues with filters) not useful in production as it is a bit of a resource hog.
debug = 0
; Section for configuring the crash handler.
[/settings/crash]
; CRASH ARCHIVE LOCATION - The folder to archive crash dumps in
archive folder = ${shared-path}/crash-dumps
; RESTART SERVICE NAME - The url to submit crash reports to
restart target = NSCP
; SUBMISSION URL - The url to submit crash reports to
submit url = https://crash.nsclient.org/post
; RESTART - Submit crash reports to nsclient.org (or your configured submission server)
restart = true
; ARCHIVE CRASHREPORTS - Archive crash reports in the archive folder
archive = true
; SUBMIT CRASHREPORTS - Submit crash reports to nsclient.org (or your configured submission server)
submit = false
; Section for log file checker
[/settings/logfile]
; Section for SMTP passive check module.
[/settings/SMTP/client]
; CHANNEL - The channel to listen to.
channel = SMTP
; Section for NSCA (NSCAServer) (check_nsca) protocol options.
[/settings/NSCA/server]
; PORT NUMBER - Port to use for NSCA.
port = 5667
; PERFORMANCE DATA - Send performance data back to nagios (set this to false to remove all performance data).
performance data = 1
; ENABLE SSL ENCRYPTION - This option controls if SSL should be enabled.
use ssl = 0
; ENCRYPTION - Name of encryption algorithm to use. Has to be the same as your agent i using or it wont work at all.This is also independent of SSL and generally used instead of SSL. Available encryption algorithms are: none = No Encryption (not safe) xor = XOR des = DES 3des = DES-EDE3 cast128 = CAST-128 xtea = XTEA blowfish = Blowfish twofish = Twofish rc2 = RC2 aes128 = AES aes192 = AES aes = AES serpent = Serpent gost = GOST
encryption = aes
; PAYLOAD LENGTH - Length of payload to/from the NSCA agent. This is a hard specific value so you have to "configure" (read recompile) your NSCA agent to use the same value for it to work.
payload length = 512
; Target definition for: default
[/settings/NSCA/client/targets/default]
; ENABLE SSL ENCRYPTION - This option controls if SSL should be enabled.
use ssl = 0
; TIMEOUT - Timeout when reading/writing packets to/from sockets.
timeout = 120
; ENCRYPTION - Name of encryption algorithm to use. Has to be the same as your server i using or it wont work at all.This is also independent of SSL and generally used instead of SSL. Available encryption algorithms are: none = No Encryption (not safe) xor = XOR des = DES 3des = DES-EDE3 cast128 = CAST-128 xtea = XTEA blowfish = Blowfish twofish = Twofish rc2 = RC2 aes128 = AES aes192 = AES aes = AES serpent = Serpent gost = GOST
encryption = aes
; ALLOWED CIPHERS - A better value is: ALL:!ADH:!LOW:!EXP:!MD5:@STRENGTH
allowed ciphers = ADH
; VERIFY MODE -
verify mode = none
; Section for NSClient (NSClientServer.dll) (check_nt) protocol options.
[/settings/NSClient/server]
; ENABLE SSL ENCRYPTION - This option controls if SSL should be enabled.
use ssl = 0
; PERFORMANCE DATA - Send performance data back to Nagios (set this to 0 to remove all performance data).
performance data = 1
; PORT NUMBER - Port to use for check_nt.
port = 12489
; A set of filters to use in real-time mode
[/settings/system/windows/real-time/checks]
; Section for NSCA passive check module.
[/settings/NSCA/client]
; HOSTNAME - The host name of the monitored computer. Set this to auto (default) to use the windows name of the computer. auto Hostname ${host} Hostname ${host_lc} Hostname in lowercase ${host_uc} Hostname in uppercase ${domain} Domainname ${domain_lc} Domainname in lowercase ${domain_uc} Domainname in uppercase
hostname = auto
; CHANNEL - The channel to listen to.
channel = NSCA
; Target definition for: default
[/settings/NRDP/client/targets/default]
; SENDER - Sender of email message
sender = nscp@localhost
; RECIPIENT - Recipient of email message
recipient = nscp@localhost
; TEMPLATE - Template for message data
template = Hello, this is %source% reporting %message%!
; TIMEOUT - Timeout when reading/writing packets to/from sockets.
timeout = 120
; Section for SMTP passive check module.
[/settings/NRDP/client]
; HOSTNAME - The host name of this host if set to blank (default) the windows name of the computer will be used.
hostname = auto
; CHANNEL - The channel to listen to.
channel = NRDP
; Target definition for: default
[/settings/NRPE/client/targets/default]
; VERIFY MODE - What to verify default is non, to validate remote certificate use remote-peer
verify mode = none
; PAYLOAD LENGTH - Length of payload to/from the NRPE agent. This is a hard specific value so you have to "configure" (read recompile) your NRPE agent to use the same value for it to work.
payload length = 1024
; ENABLE SSL ENCRYPTION - This option controls if SSL should be enabled.
use ssl = 1
; TIMEOUT - Timeout when reading/writing packets to/from sockets.
timeout = 120
; Section for WEB (WEBServer.dll) (check_WEB) protocol options.
[/settings/WEB/server]
; PORT NUMBER - Port to use for WEB server.
port = 8443s
; CERTIFICATE - Ssl certificate to use for the ssl server
certificate = ${certificate-path}/certificate.pem
; Target definition for: default
[/settings/SMTP/client/targets/default]
; SENDER - Sender of email message
sender = nscp@localhost
; TEMPLATE - Template for message data
template = Hello, this is %source% reporting %message%!
; TIMEOUT - Timeout when reading/writing packets to/from sockets.
timeout = 120
; RECIPIENT - Recipient of email message
recipient = nscp@localhost
; Files to be included in the configuration
[/includes]
; Section for the EventLog Checker (CheckEventLog.dll).
[/settings/eventlog]
; BUFFER_SIZE - The size of the buffer to use when getting messages this affects the speed and maximum size of messages you can recieve.
buffer size = 131072
; LOOKUP NAMES - Lookup the names of eventlog files
lookup names = 1
; DEBUG - Log more information when filtering (useful to detect issues with filters) not useful in production as it is a bit of a resource hog.
debug = 0
; Section for NRPE active/passive check module.
[/settings/NRPE/client]
; CHANNEL - The channel to listen to.
channel = NRPE
; Section for the Scheduler module.
[/settings/scheduler/schedules]
; A list of scripts available to run from the CheckExternalScripts module. Syntax is: <command>=<script> <arguments>
[/settings/external scripts/scripts]
; VMWare Tools
check_vmwaretools=c:\\windows\\system32\\cscript.exe //NoLogo scripts\\check_vmwaretools.vbs
; Check Windows Temp Folder
check_winfile = scripts\\check_winfile.exe $ARG1$ $ARG2$ $ARG3$
; Check Explorer
check_explorer = scripts\\check_winprocess.exe $ARG1$ $ARG2$ $ARG3$
; PSCheckApplicationEventLog - Alias for PSCheckApplicationEventLog. To configure this item add a section called: /settings/external scripts/scripts/PSCheckApplicationEventLog
PSCheckApplicationEventLog = cmd /c echo scripts\Check-EventLog.ps1 -LogName Application; exit($lastexitcode) | powershell.exe -command -
; PSCheckSystemEventLog - Alias for PSCheckSystemEventLog. To configure this item add a section called: /settings/external scripts/scripts/PSCheckSystemEventLog
PSCheckSystemEventLog = cmd /c echo scripts\Check-EventLog.ps1; exit($lastexitcode) | powershell.exe -command -
; Check Windows Updates
;Check_Updates = cscript.exe //T:30 //NoLogo scripts\\nm-check-available-updates.vbs
check_updates = cmd /c echo scripts\check_windows_updates.ps1; exit $LastExitCode | powershell.exe -command -
; check_users - Alias for check_users. To configure this item add a section called: /settings/external scripts/scripts/check_users
check_users = scripts\\perl\\check_users.exe $ARG1$ $ARG2$ $ARG3$
; check veeam backups
;checkveeambu = cmd /c echo scripts/powershell/check_veeam.ps1 "$ARG1$" "$ARG2$"; exit $LastExitCode | powershell.exe -command -
checkveeambu = cmd /c echo scripts/powershell/check_veeam_backups.ps1 "$ARG1$" "$ARG2$"; exit $LastExitCode | powershell.exe -command -
; check veeam copy jobs
checkveeamcopy = cmd /c echo scripts/powershell/check_veeam_backups.ps1 "$ARG1$" "$ARG2$"; exit $LastExitCode | powershell.exe -command -
; A list of aliases available.
;An alias is an internal command that has been predefined to provide a single command without arguments. Be careful so you don't create loops (ie check_loop=check_a, check_a=check_loop)
[/settings/external scripts/alias]
; alias_sched_all - Alias for alias_sched_all. To configure this item add a section called: /settings/external scripts/alias/alias_sched_all
alias_sched_all = check_tasksched show-all "syntax=${title}: ${exit_code}" "crit=exit_code ne 0"
; alias_file_size - Alias for alias_file_size. To configure this item add a section called: /settings/external scripts/alias/alias_file_size
alias_file_size = check_files "path=$ARG1$" "crit=size > $ARG2$" "top-syntax=${list}" "detail-syntax=${filename] ${size}" max-dir-depth=10
; alias_process_hung - Alias for alias_process_hung. To configure this item add a section called: /settings/external scripts/alias/alias_process_hung
alias_process_hung = check_process "filter=is_hung" "crit=count>0"
; alias_process - Alias for alias_process. To configure this item add a section called: /settings/external scripts/alias/alias_process
alias_process = check_process "process=$ARG1$" "crit=state != 'started'"
; alias_service_ex - Alias for alias_service_ex. To configure this item add a section called: /settings/external scripts/alias/alias_service_ex
alias_service_ex = check_service "exclude=Net Driver HPZ12" "exclude=Pml Driver HPZ12" exclude=stisvc
; alias_event_log - Alias for alias_event_log. To configure this item add a section called: /settings/external scripts/alias/alias_event_log
alias_event_log = check_eventlog
; alias_volumes_loose - Alias for alias_volumes_loose. To configure this item add a section called: /settings/external scripts/alias/alias_volumes_loose
alias_volumes_loose = check_drivesize
; alias_volumes - Alias for alias_volumes. To configure this item add a section called: /settings/external scripts/alias/alias_volumes
alias_volumes = check_drivesize
; alias_disk - Alias for alias_disk. To configure this item add a section called: /settings/external scripts/alias/alias_disk
alias_disk = check_drivesize
; alias_up - Alias for alias_up. To configure this item add a section called: /settings/external scripts/alias/alias_up
alias_up = check_uptime
; alias_cpu_ex - Alias for alias_cpu_ex. To configure this item add a section called: /settings/external scripts/alias/alias_cpu_ex
alias_cpu_ex = check_cpu "warn=load > $ARG1$" "crit=load > $ARG2$" time=5m time=1m time=30s
; alias_file_age - Alias for alias_file_age. To configure this item add a section called: /settings/external scripts/alias/alias_file_age
alias_file_age = check_files "path=$ARG1$" "crit=written > $ARG2$" "top-syntax=${list}" "detail-syntax=${filename] ${written}" max-dir-depth=10
; alias_process_stopped - Alias for alias_process_stopped. To configure this item add a section called: /settings/external scripts/alias/alias_process_stopped
alias_process_stopped = check_process "process=$ARG1$" "crit=state != 'stopped'"
; alias_service - Alias for alias_service. To configure this item add a section called: /settings/external scripts/alias/alias_service
alias_service = check_service
; alias_cpu - Alias for alias_cpu. To configure this item add a section called: /settings/external scripts/alias/alias_cpu
alias_cpu = check_cpu
; alias_mem - Alias for alias_mem. To configure this item add a section called: /settings/external scripts/alias/alias_mem
alias_mem = check_memory
; alias_process_count - Alias for alias_process_count. To configure this item add a section called: /settings/external scripts/alias/alias_process_count
alias_process_count = check_process "process=$ARG1$" "warn=count > $ARG2$" "crit=count > $ARG3$"
; alias_sched_task - Alias for alias_sched_task. To configure this item add a section called: /settings/external scripts/alias/alias_sched_task
alias_sched_task = check_tasksched show-all "filter=title eq '$ARG1$'" "detail-syntax=${title} (${exit_code})" "crit=exit_code ne 0"
; alias_disk_loose - Alias for alias_disk_loose. To configure this item add a section called: /settings/external scripts/alias/alias_disk_loose
alias_disk_loose = check_drivesize
; alias_sched_long - Alias for alias_sched_long. To configure this item add a section called: /settings/external scripts/alias/alias_sched_long
alias_sched_long = check_tasksched "filter=status = 'running'" "detail-syntax=${title} (${most_recent_run_time})" "crit=most_recent_run_time < -$ARG1$"
; Target definition for: default
[/settings/graphite/client/targets/default]
; PATH FOR VALUES - Path mapping for metrics
path = system.${hostname}.${check_alias}.${perf_alias}
; Modules written in dotnet/CLR
[/modules/dotnet]
; Add counters to check
[/settings/system/windows/counters]
; A set of filters to use in real-time mode
[/settings/logfile/real-time/checks]
; Section for simple cache module (SimpleCache.dll).
[/settings/cache]
; CHANNEL - The channel to listen to.
channel = CACHE
; PRIMARY CACHE INDEX - Set this to the value you want to use as unique key for the cache. Can be any arbitrary string as well as include any of the following special keywords:${command} = The command name, ${host} the host, ${channel} the recieving channel, ${alias} the alias for the command, ${alias-or-command} = alias if set otherweise command, ${message} = the message data (no escape), ${result} = The result status (number).
primary index = ${alias-or-command}
; Section for the Scheduler module.
[/settings/scheduler]
; THREAD COUNT - Number of threads to use.
threads = 5
; A list of templates for wrapped scripts.
;%SCRIPT% will be replaced by the actual script an %ARGS% will be replaced by any given arguments.
[/settings/external scripts/wrappings]
; BATCH FILE WRAPPING -
bat = scripts\\%SCRIPT% %ARGS%
; VISUAL BASIC WRAPPING -
vbs = cscript.exe //T:30 //NoLogo scripts\\lib\\wrapper.vbs %SCRIPT% %ARGS%
; POWERSHELL WRAPPING -
ps1 = cmd /c echo scripts\\%SCRIPT% %ARGS%; exit($lastexitcode) | powershell.exe -command -
; A set of filters to use in real-time mode
[/settings/eventlog/real-time/filters]
[/paths]
; Path for shared-path -
shared-path = C:\Program Files\NSClient++
; Path for exe-path -
exe-path = C:\Program Files\NSClient++
; Path for crash-folder -
crash-folder = C:\Program Files\NSClient++
; Path for certificate-path -
certificate-path = ${shared-path}/security
; Path for base-path -
base-path = C:\Program Files\NSClient++
; Path for module-path -
module-path = ${shared-path}/modules