# If you want to fill this file with all available 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 --add-defaults # For details run: nscp settings --help ; in flight - TODO [/settings/default] ; Undocumented key ; password = hwQKQ9ALAdtRLiNh ; Undocumented key allowed hosts = 10.211.26.65 ; 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 = false ; TIMEOUT - Timeout when reading packets on incoming sockets. If the data has not arrived within this time we will bail out. timeout = 30 ; BIND TO ADDRESS - Allows you to bind server to a specific local address. This has to be a dotted ip address not a host name. Leaving this blank will bind to all available IP addresses. ; bind to = UNKNOWN port = 12489 ; in flight - TODO [/settings/NRPE/server] ; Undocumented key verify mode = none ; Undocumented key insecure = true ; 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 = false ; ENABLE SSL ENCRYPTION - This option controls if SSL should be enabled. use ssl = true ; COMMAND ARGUMENT PROCESSING - This option determines whether or not the we will allow clients to specify arguments to commands that are executed. allow arguments = true ; 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 = true ; in flight - TODO [/modules] ; Undocumented key CheckHelpers = enabled ; Undocumented key CheckEventLog = disabled ; Undocumented key CheckNSCP = disabled ; Undocumented key CheckDisk = enabled ; Undocumented key CheckSystem = enabled ; Undocumented key NRPEServer = enabled ; Undocumented key NSClientServer = enabled ; CheckExternalScripts - Module used to execute external scripts CheckExternalScripts = enabled ; LOG SECTION - 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 = -1 ; LOG SECTION - 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 ; CRASH HANDLER - Section for configuring the crash handler. [/settings/crash] ; RESTART SERVICE NAME - The url to submit crash reports to restart target = NSCP ; CRASH ARCHIVE LOCATION - The folder to archive crash dumps in archive folder = ${shared-path}/crash-dumps ; SUBMISSION URL - The url to submit crash reports to submit url = https://crash.nsclient.org/post ; [/paths] ; Path for module-path - module-path = ${exe-path}/modules ; Path for certificate-path - certificate-path = ${shared-path}/security ; Path for exe-path - exe-path = C:\Program Files\NSClient++ ; Path for shared-path - shared-path = C:\Program Files\NSClient++ ; Path for base-path - base-path = C:\Program Files\NSClient++ ; Path for scripts - scripts = ${exe-path}/scripts ; INCLUDED FILES - Files to be included in the configuration [/includes] ; script: default - The configuration section for the default script. [/settings/external scripts/scripts/default] default = check_win_updates = cscript.exe //T:30 //NoLogo scripts\lib\wrapper.vbs scripts\check_updates.vbs -warning 0 -critical 0 ; IGNORE PERF DATA - Do not parse performance data from the output ignore perfdata = UNKNOWN ; COMMAND - Command to execute command = UNKNOWN ; Wrapped scripts - A list of wrapped scripts (ie. script using a template mechanism). The template used will be defined by the extension of the script. Thus a foo.ps1 will use the ps1 wrapping from the wrappings section. [/settings/external scripts/wrapped scripts] ; Command aliases - A list of aliases for already defined commands (with arguments). 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_volumes_loose - To configure this create a section under: /settings/external scripts/alias/alias_volumes_loose alias_volumes_loose = UNKNOWN ; alias_volumes - To configure this create a section under: /settings/external scripts/alias/alias_volumes alias_volumes = UNKNOWN ; alias_sched_all - To configure this create a section under: /settings/external scripts/alias/alias_sched_all alias_sched_all = UNKNOWN ; alias_process_count - To configure this create a section under: /settings/external scripts/alias/alias_process_count alias_process_count = UNKNOWN ; alias_process - To configure this create a section under: /settings/external scripts/alias/alias_process alias_process = UNKNOWN ; alias_file_size - To configure this create a section under: /settings/external scripts/alias/alias_file_size alias_file_size = UNKNOWN ; alias_service_ex - To configure this create a section under: /settings/external scripts/alias/alias_service_ex alias_service_ex = UNKNOWN ; alias_event_log - To configure this create a section under: /settings/external scripts/alias/alias_event_log alias_event_log = UNKNOWN ; alias_cpu - To configure this create a section under: /settings/external scripts/alias/alias_cpu alias_cpu = UNKNOWN ; alias_mem - To configure this create a section under: /settings/external scripts/alias/alias_mem alias_mem = UNKNOWN ; alias_disk - To configure this create a section under: /settings/external scripts/alias/alias_disk alias_disk = UNKNOWN ; alias_up - To configure this create a section under: /settings/external scripts/alias/alias_up alias_up = UNKNOWN ; alias_service - To configure this create a section under: /settings/external scripts/alias/alias_service alias_service = UNKNOWN ; alias_process_stopped - To configure this create a section under: /settings/external scripts/alias/alias_process_stopped alias_process_stopped = UNKNOWN ; alias_sched_task - To configure this create a section under: /settings/external scripts/alias/alias_sched_task alias_sched_task = UNKNOWN ; alias_disk_loose - To configure this create a section under: /settings/external scripts/alias/alias_disk_loose alias_disk_loose = UNKNOWN ; alias_sched_long - To configure this create a section under: /settings/external scripts/alias/alias_sched_long alias_sched_long = UNKNOWN ; alias_process_hung - To configure this create a section under: /settings/external scripts/alias/alias_process_hung alias_process_hung = UNKNOWN ; alias_cpu_ex - To configure this create a section under: /settings/external scripts/alias/alias_cpu_ex alias_cpu_ex = UNKNOWN ; alias_file_age - To configure this create a section under: /settings/external scripts/alias/alias_file_age alias_file_age = UNKNOWN ; Script wrappings - A list of templates for defining script commands. Enter any command line here and they will be expanded by scripts placed under the wrapped scripts section. %SCRIPT% will be replaced by the actual script an %ARGS% will be replaced by any given arguments. [/settings/external scripts/wrappings] ; Batch file - Command used for executing wrapped batch files bat = scripts\\%SCRIPT% %ARGS% ; Visual basic script - Command line used for wrapped vbs scripts vbs = cscript.exe //T:30 //NoLogo scripts\\lib\\wrapper.vbs %SCRIPT% %ARGS% ; POWERSHELL WRAPPING - Command line used for executing wrapped ps1 (powershell) scripts ps1 = cmd /c echo If (-Not (Test-Path "scripts\%SCRIPT%") ) { Write-Host "UNKNOWN: Script `"%SCRIPT%`" not found."; exit(3) }; scripts\%SCRIPT% $ARGS$; exit($lastexitcode) | powershell.exe /noprofile -command - ; External scripts - A list of scripts available to run from the CheckExternalScripts module. Syntax is: `command=script arguments` [/settings/external scripts/scripts] check_openmanage="C:\Program Files\NSClient++\plugins\check_openmanage.exe -s -e -t 120" check_openmanage_all="C:\Program Files\NSClient++\plugins\check_openmanage.exe -d" check_openmanage_disk="C:\Program Files\NSClient++\plugins\check_openmanage.exe -p -e" ; alias: default - The configuration section for the default alias [/settings/external scripts/alias/default] ; COMMAND - Command to execute alias_cpu=checkCPU warn=80 crit=90 time=5m time=1m time=30s alias_cpu_ex=checkCPU warn=$ARG1$ crit=$ARG2$ time=5m time=1m time=30s alias_mem=checkMem MaxWarn=80% MaxCrit=90% ShowAll=long type=physical type=virtual type=paged type=page alias_up=checkUpTime MinWarn=1d MinWarn=1h alias_disk=CheckDriveSize MinWarn=10% MinCrit=5% CheckAll FilterType=FIXED alias_disk_loose=CheckDriveSize MinWarn=10% MinCrit=5% CheckAll FilterType=FIXED ignore-unreadable alias_volumes=CheckDriveSize MinWarn=10% MinCrit=5% CheckAll=volumes FilterType=FIXED alias_volumes_loose=CheckDriveSize MinWarn=10% MinCrit=5% CheckAll=volumes FilterType=FIXED ignore-unreadable alias_service=checkServiceState CheckAll alias_service_ex=checkServiceState CheckAll "exclude=Net Driver HPZ12" "exclude=Pml Driver HPZ12" exclude=stisvc alias_process=checkProcState "$ARG1$=started" alias_process_stopped=checkProcState "$ARG1$=stopped" alias_process_count=checkProcState MaxWarnCount=$ARG2$ MaxCritCount=$ARG3$ "$ARG1$=started" alias_process_hung=checkProcState MaxWarnCount=1 MaxCritCount=1 "$ARG1$=hung" alias_event_log=CheckEventLog file=application file=system MaxWarn=1 MaxCrit=1 "filter=generated gt -2d AND severity NOT IN ('success', 'informational') AND source != 'SideBySide'" truncate=800 unique descriptions "syntax=%severity%: %source%: %message% (%count%)" alias_file_size=CheckFiles "filter=size > $ARG2$" "path=$ARG1$" MaxWarn=1 MaxCrit=1 "syntax=%filename% %size%" max-dir-depth=10 alias_file_age=checkFile2 filter=out "file=$ARG1$" filter-written=>1d MaxWarn=1 MaxCrit=1 "syntax=%filename% %write%" alias_sched_all=CheckTaskSched "filter=exit_code ne 0" "syntax=%title%: %exit_code%" warn=>0 alias_sched_long=CheckTaskSched "filter=status = 'running' AND most_recent_run_time < -$ARG1$" "syntax=%title% (%most_recent_run_time%)" warn=>0 alias_sched_task=CheckTaskSched "filter=title eq '$ARG1$' AND exit_code ne 0" "syntax=%title% (%most_recent_run_time%)" warn=>0 alias_updates=check_updates -warning 0 -critical 0 check_ok=CheckOK Everything is fine! ; External script settings - General settings for the external scripts module (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 ; Script root folder - Root path where all scripts are contained (You can not upload/download scripts outside this folder). script root = ${scripts} ; Load all scripts in a given folder - Load all scripts in a given directory and use them as commands. script path = UNKNOWN ; Allow arguments when executing external scripts - This option determines whether or not the we will allow clients to specify arguments to commands that are executed. allow arguments = true ; Allow certain potentially dangerous characters in arguments - This option determines whether or not the we will allow clients to specify nasty (as in |`&><'"\[]{}) characters in arguments. allow nasty characters = true