# 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 = PASS ; Undocumented key allowed hosts = 10.10.10.50 ; 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 = 60 ; in flight - TODO [/settings/NRPE/server] ; Undocumented key verify mode = none ; Undocumented key insecure = true allow arguments = true ; PORT NUMBER - Port to use for NRPE. port = 5666 ; 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 ; 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 = false ssl options = ; in flight - TODO [/modules] ; Undocumented key ;CheckExternalScripts = enabled ; Undocumented key ;CheckHelpers = enabled ; Undocumented key CheckEventLog = disabled ; Undocumented key CheckNSCP = disabled ; Undocumented key ;CheckDisk = enabled ; Undocumented key ;CheckSystem = enabled ; Undocumented key NSClientServer = enabled ; Undocumented key NRPEServer = enabled ; Scheduler - Use this to schedule check commands and jobs in conjunction with for instance passive monitoring through NSCA Scheduler = enabled ; CheckSystem - Various system related checks, such as CPU load, process state, service state memory usage and PDH counters. CheckSystem = disabled ; CheckDisk - CheckDisk can check various file and disk related things. CheckDisk = enabled ; CheckHelpers - Various helper function to extend other checks. CheckHelpers = enabled ; CheckExternalScripts - Module used to execute external scripts CheckExternalScripts = enabled [/settings/external scripts/scripts] ; check_vmware_snapshots = powershell.exe -ExecutionPolicy RemoteSigned -noprofile -file scripts\check_new.ps1 ; check_vmware_snapshots = cmd /c echo scripts\check_new.ps1; exit $lastexitcode | powershell.exe -command - ; check_vmware_snapshots = cmd /c scripts\ check_vmware_snapshots = powershell.exe -PSConsoleFile "c:\Program Files (x86)\VMware\Infrastructure\vSphere PowerCLI\vim.psc1" "& 'C:\Program Files\NSClient++\scripts\check_vmware_snapshots.ps1'" ; exit($lastexitcode) ;check_vmware_snapshots = scripts\check_vm_snapshots.bat ;TfsStuckBuilds = cmd /c echo scripts\CheckForTfsStuckBuilds.ps1 $ARG1$ $ARG2$; exit($lastexitcode) | powershell.exe -command - ; Scheduler - Section for the Scheduler module. [/settings/scheduler] ; Threads - Number of threads to use. threads = 5 ; 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 SETTINGS - Section for configuring the log handling. [/settings/log] ; LOG LEVEL - Log level to use. Available levels are error,warning,info,debug,trace level = debug ; 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 ; Schedules - Section for the Scheduler module. [/settings/scheduler/schedules] ; CRASH HANDLER - Section for configuring the crash handler. [/settings/crash] ; SUBMISSION URL - The url to submit crash reports to submit url = https://crash.nsclient.org/post ; 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 ; NSCLIENT SERVER SECTION - 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 = false ; PERFORMANCE DATA - Send performance data back to Nagios (set this to 0 to remove all performance data). performance data = true ; PORT NUMBER - Port to use for check_nt. port = 12489 ; [/paths] ; Path for shared-path - shared-path = C:\Program Files\NSClient++ ; 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 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] ; Realtime memory filters - A set of filters to use in real-time mode [/settings/system/windows/real-time/memory] ; Realtime process filters - A set of filters to use in real-time mode [/settings/system/windows/real-time/process] ; COUNTER - Definition for counter: default [/settings/system/windows/counters/default] ; Interpret instances - IF we shoul interpret instance (default auto). Values: auto, true, false instances = UNKNOWN ; FLAGS - Extra flags to configure the counter (nocap100, 1000, noscale) flags = UNKNOWN ; COUNTER TYPE - The type of counter to use long, large and double type = UNKNOWN ; COLLECTION STRATEGY - The way to handled values when collecting them: static means we keep the last known value, rrd means we store values in a buffer from which you can retrieve the average collection strategy = UNKNOWN ; COUNTER - The counter to check counter = UNKNOWN ; BUFFER SIZE - Size of buffer (in seconds) larger buffer use more memory buffer size = UNKNOWN ; Windows system - Section for system checks and system settings [/settings/system/windows] ; Default buffer time - Used to define the default size of range buffer checks (ie. CPU). default buffer length = 1h ; PDH Counters - Add counters to check [/settings/system/windows/counters] ; disk_queue_length - To configure this create a section under: /settings/system/windows/counters/disk_queue_length disk_queue_length = UNKNOWN ; Realtime cpu filters - A set of filters to use in real-time mode [/settings/system/windows/real-time/cpu] ; Legacy generic filters - A set of filters to use in real-time mode [/settings/system/windows/real-time/checks] ; 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_service_ex - To configure this create a section under: /settings/external scripts/alias/alias_service_ex alias_service_ex = UNKNOWN ; alias_service - To configure this create a section under: /settings/external scripts/alias/alias_service alias_service = UNKNOWN ; alias_sched_all - To configure this create a section under: /settings/external scripts/alias/alias_sched_all alias_sched_all = UNKNOWN ; alias_process_hung - To configure this create a section under: /settings/external scripts/alias/alias_process_hung alias_process_hung = 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_mem - To configure this create a section under: /settings/external scripts/alias/alias_mem alias_mem = UNKNOWN ; alias_file_size - To configure this create a section under: /settings/external scripts/alias/alias_file_size alias_file_size = 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_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_process_stopped - To configure this create a section under: /settings/external scripts/alias/alias_process_stopped alias_process_stopped = UNKNOWN ; alias_disk_loose - To configure this create a section under: /settings/external scripts/alias/alias_disk_loose alias_disk_loose = UNKNOWN ; alias_sched_task - To configure this create a section under: /settings/external scripts/alias/alias_sched_task alias_sched_task = UNKNOWN ; alias_sched_long - To configure this create a section under: /settings/external scripts/alias/alias_sched_long alias_sched_long = 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: default - The configuration section for the default script. [/settings/external scripts/scripts/default] ; IGNORE PERF DATA - Do not parse performance data from the output ignore perfdata = UNKNOWN ; COMMAND - Command to execute command = 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 - ; alias: default - The configuration section for the default alias [/settings/external scripts/alias/default] ; COMMAND - Command to execute command = UNKNOWN ; 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 ; 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 = false ; 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 = false ; 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