Changes between Version 3 and Version 4 of doc/configuration/0.4.x

Timestamp:

01/13/12 07:11:22 (17 months ago)

Author:

mickem

Comment:

--

doc/configuration/0.4.x

@@ -11 +11 @@
 
 The various sections are described in short below. The default configuration file has a lot of examples and comments so make sure you change this before you use NSClient++ as some of the examples might be potential security issues.
-
-== /modules ==
-This is a list of modules to load at startup. All the modules included in this list has to be NSClient++ modules and located in the modules subdirectory. This is in effect the list of plug-ins that will be available as the service is running.
-For information on the various plug-ins check the Modules section in the navigation box.
-Apart from module each module can be given an alias as well as an optional disabled flag to indicate it should not be loaded. The point of aliases is to allow the same module to be loaded multiple times. For instance perhaps you want to have multiple NRPE server one with SSL enable one without or different payload length or some such.
-The syntax is:
-{{{
-[/modules]
-<alias>=<module>
-<module>=1
-<module>=disabled
-<module>=enabled
-<module>=
-}}}
-'''Notice''' that = is '''NOT''' optional (which is was in previous versions)
-
-A complete list of all available modules:
-[[ListTagged(module)]]
 
 
@@ -37 +19 @@
 Discarding: Failed to register plugin: Could not load NSLoadModuleEx in file: LUAScript
 == /modules ==
+
 '''Normal settings'''
 ||CheckDisk||||CheckDisk: CheckDisk can check various file and disk related things.
-The current version has commands to check Size of hard drives and directories.
+||||||The current version has commands to check Size of hard drives and directories.
 ||CheckEventLog||||Event log Checker.: Check for errors and warnings in the event log.
-This is only supported through NRPE so if you plan to use only NSClient this wont help you at all.
+||||||This is only supported through NRPE so if you plan to use only NSClient this wont help you at all.
 ||CheckExternalScripts||||Check External Scripts: A simple wrapper to run external scripts and batch files.
 ||CheckHelpers||||Helper function: Various helper function to extend other checks.
-This is also only supported through NRPE.
+||||||This is also only supported through NRPE.
 ||CheckNSCP||||Check NSCP: Checkes the state of the agent
 ||CheckSystem||||CheckSystem: Various system related checks, such as CPU load, process state, service state memory usage and PDH counters.
 ||CheckTaskSched||||CheckTaskSched: CheckTaskSched can check various file and disk related things.
-The current version has commands to check Size of hard drives and directories.
+||||||The current version has commands to check Size of hard drives and directories.
 ||CheckTaskSched2||||CheckTaskSched2: CheckTaskSched2 can check various file and disk related things.
-The current version has commands to check Size of hard drives and directories.
+||||||The current version has commands to check Size of hard drives and directories.
 ||CheckWMI||||CheckWMI: CheckWMI can check various file and disk related things.
-The current version has commands to check Size of hard drives and directories.
-||DistributedClient||||DistributedClient: A client for connecting to a distributed Server.
-
-||DistributedServer||||Distributed server: A simple server that listens for incoming distributed requests.
+||||||The current version has commands to check Size of hard drives and directories.
 ||FileLogger||||File logger: Writes errors and (if configured) debug info to a text file.
 ||NRPEClient||||NRPE client (w/ SSL): A simple client for checking remote NRPE servers (think proxy).
-
+||||||
 ||NRPEServer||||NRPE server: A simple server that listens for incoming NRPE connection and handles them.
-NRPE is preferred over NSClient as it is more flexible. You can of cource use both NSClient and NRPE.
+||||||NRPE is preferred over NSClient as it is more flexible. You can of cource use both NSClient and NRPE.
 ||NSCAClient||||NSCAClient: Passive check support (needs NSCA on nagios server).
-Avalible crypto are: {0=No Encryption (not safe), 1=XOR, 2=DES, 3=DES-EDE3, 4=CAST-128, 6=XTEA, 8=Blowfish, 9=Twofish, 11=RC2, 14=AES, 15=AES, 16=AES, 20=Serpent, 23=GOST}
+||||||Avalible crypto are: {0=No Encryption (not safe), 1=XOR, 2=DES, 3=DES-EDE3, 4=CAST-128, 6=XTEA, 8=Blowfish, 9=Twofish, 11=RC2, 14=AES, 15=AES, 16=AES, 20=Serpent, 23=GOST}
 ||NSCAServer||||NSCA server (w/ encryption): A simple server that listens for incoming NSCA connection and handles them.
-Avalible crypto are: {0=No Encryption (not safe), 1=XOR, 2=DES, 3=DES-EDE3, 4=CAST-128, 6=XTEA, 8=Blowfish, 9=Twofish, 11=RC2, 14=AES, 15=AES, 16=AES, 20=Serpent, 23=GOST}
+||||||Avalible crypto are: {0=No Encryption (not safe), 1=XOR, 2=DES, 3=DES-EDE3, 4=CAST-128, 6=XTEA, 8=Blowfish, 9=Twofish, 11=RC2, 14=AES, 15=AES, 16=AES, 20=Serpent, 23=GOST}
 ||NSCPClient||||NSCP client: A simple client for checking remote NSCP servers (think proxy).
-SSL support is missing (so you cant use encryption)!
+||||||SSL support is missing (so you cant use encryption)!
 ||NSCPServer||||NSCP server (no SSL): A simple server that listens for incoming NSCP connection and handles them.
 ||NSClientServer||||NSClient server: A simple server that listens for incoming NSClient (check_nt) connection and handles them.
-Although NRPE is the preferred method NSClient is fully supported and can be used for simplicity or for compatibility.
+||||||Although NRPE is the preferred method NSClient is fully supported and can be used for simplicity or for compatibility.
 ||PythonScript||||PythonScript: PythonScript...
 ||SMTPClient||||SMTPClient: Passive check support via SMTP
@@ -75 +55 @@
 ||SyslogClient||||SyslogClient: Passive check support via Syslog
 == /settings/NRPE/client ==
+Section for NRPE active/passive check module.
 '''Normal settings'''
 ||channel||NRPE||CHANNEL: The channel to listen to.
 == /settings/NRPE/client/handlers ==
+
 == /settings/NRPE/client/targets ==
+
 == /settings/NRPE/client/targets/default ==
+Target defnition for: default
 '''Normal settings'''
 ||address||||TARGET ADDRESS: Target host address
@@ -90 +74 @@
 ||use ssl||1||ENABLE SSL ENCRYPTION: This option controls if SSL should be enabled.
 == /settings/NRPE/server ==
+Section for NRPE (NRPEListener.dll) (check_nrpe) protocol options.
 '''Normal settings'''
 ||allow arguments||0||COMMAND ARGUMENT PROCESSING: This option determines whether or not the we will allow clients to specify arguments to commands that are executed.
@@ -105 +90 @@
 ||use ssl||1||ENABLE SSL ENCRYPTION: This option controls if SSL should be enabled. Parent element can be found under: /settings/default
 == /settings/NSCA/client ==
+Section for NSCA passive check module.
 '''Normal settings'''
 ||channel||NSCA||CHANNEL: The channel to listen to.
@@ -110 +96 @@
 ||hostname||auto||HOSTNAME: The host name of this host if set to blank (default) the windows name of the computer will be used.
 == /settings/NSCA/client/handlers ==
+
 == /settings/NSCA/client/server ==
+Configure the NSCA server to report to.
 == /settings/NSCA/client/targets ==
+
 == /settings/NSCA/client/targets/default ==
+Target defnition for: default
 '''Normal settings'''
 ||address||||TARGET ADDRESS: Target host address
@@ -125 +115 @@
 ||timeout||30||TIMEOUT: Timeout when reading packets on incoming sockets. If the data has not arrived withint this time we will bail out.
 == /settings/NSCA/server ==
+Section for NSCA (NSCAServer) (check_nsca) protocol options.
 '''Normal settings'''
 ||allowed hosts||127.0.0.1||ALLOWED HOSTS: A comaseparated list of allowed hosts. You can use netmasks (/ syntax) or * to create ranges. Parent element can be found under: /settings/default
@@ -139 +130 @@
 ||timeout||30||TIMEOUT: Timeout when reading packets on incoming sockets. If the data has not arrived within this time we will bail out. Parent element can be found under: /settings/default
 == /settings/NSCA/test_nsca_client ==
+Section for NSCA passive check module.
 '''Normal settings'''
 ||channel||NSCA||CHANNEL: The channel to listen to.
@@ -144 +136 @@
 ||hostname||auto||HOSTNAME: The host name of this host if set to blank (default) the windows name of the computer will be used.
 == /settings/NSCA/test_nsca_client/handlers ==
+
 == /settings/NSCA/test_nsca_client/server ==
+Configure the NSCA server to report to.
 == /settings/NSCA/test_nsca_client/targets ==
+
 == /settings/NSCA/test_nsca_client/targets/default ==
+Target defnition for: default
 '''Normal settings'''
 ||address||||TARGET ADDRESS: Target host address
@@ -159 +155 @@
 ||timeout||30||TIMEOUT: Timeout when reading packets on incoming sockets. If the data has not arrived withint this time we will bail out.
 == /settings/NSCA/test_nsca_client/targets/nsca_test_local ==
+Target defnition for: nsca_test_local
 '''Normal settings'''
 ||address||||TARGET ADDRESS: Target host address
@@ -165 +162 @@
 ||parent||default||TARGET PARENT: The parent the target inherits from
 == /settings/NSCA/test_nsca_server ==
+Section for NSCA (NSCAServer) (check_nsca) protocol options.
 '''Normal settings'''
 ||allowed hosts||127.0.0.1||ALLOWED HOSTS: A comaseparated list of allowed hosts. You can use netmasks (/ syntax) or * to create ranges. Parent element can be found under: /settings/default
@@ -179 +177 @@
 ||timeout||30||TIMEOUT: Timeout when reading packets on incoming sockets. If the data has not arrived within this time we will bail out. Parent element can be found under: /settings/default
 == /settings/NSCP/client ==
+Section for NSCP active/passive check module.
 '''Normal settings'''
 ||channel||NSCP||CHANNEL: The channel to listen to.
 == /settings/NSCP/client/handlers ==
+
 == /settings/NSCP/client/targets ==
+
 == /settings/NSCP/client/targets/default ==
+Target defnition for: default
 '''Normal settings'''
 ||address||||TARGET ADDRESS: Target host address
@@ -194 +196 @@
 ||use ssl||1||ENABLE SSL ENCRYPTION: This option controls if SSL should be enabled.
 == /settings/NSClient/server ==
+Section for NSClient (NSClientServer.dll) (check_nt) protocol options.
 '''Normal settings'''
 ||allowed hosts||127.0.0.1||ALLOWED HOSTS: A comaseparated list of allowed hosts. You can use netmasks (/ syntax) or * to create ranges. Parent element can be found under: /settings/default/socket
@@ -207 +210 @@
 ||use ssl||1||ENABLE SSL ENCRYPTION: This option controls if SSL should be enabled. Parent element can be found under: /settings/default/socket
 == /settings/SMTP/client ==
+Section for SMTP passive check module.
 '''Normal settings'''
 ||channel||SMTP||CHANNEL: The channel to listen to.
 == /settings/SMTP/client/handlers ==
+
 == /settings/SMTP/client/targets ==
+
 == /settings/SMTP/client/targets/default ==
+Target defnition for: default
 '''Normal settings'''
 ||address||||TARGET ADDRESS: Target host address
@@ -222 +229 @@
 ||timeout||30||TIMEOUT: Timeout when reading/writing packets to/from sockets.
 == /settings/Task Scheduler ==
+???
 '''Advanced settings'''
 ||syntax||%title% last run: %most-recent-run-time% (%exit-code%)||SYNTAX: Set this to use a specific syntax string for all commands (that don't specify one)
 == /settings/check/system/windows ==
+Section for system checks and system settings
 '''Normal settings'''
 ||AUTO_START||started||SERVICE_AUTO_START: TODO
@@ -235 +244 @@
 ||default buffer length||1h||DEFAULT INTERVALL: Used to define the default intervall for range buffer checks (ie. CPU).
 == /settings/check/system/windows/pdh ==
+
 == /settings/check/system/windows/pdh/counters ==
+
 == /settings/check/system/windows/service mapping ==
+Confiure which services has to be in which state
 == /settings/crash ==
+Configure crash handling properties.
 '''Normal settings'''
 ||archive||1||ARCHIVE CRASHREPORTS: Archive crash reports in the archive folder
@@ -246 +259 @@
 ||submit url||http://crash.nsclient.org/submit||SUBMISSION URL: The url to submit crash reports to
 == /settings/default ==
+
 '''Normal settings'''
 ||allowed hosts||127.0.0.1||ALLOWED HOSTS: A comaseparated list of allowed hosts. You can use netmasks (/ syntax) or * to create ranges. Parent element can be found under: /settings/default
@@ -258 +272 @@
 ||use ssl||1||ENABLE SSL ENCRYPTION: This option controls if SSL should be enabled. Parent element can be found under: /settings/default
 == /settings/default/socket ==
+
 '''Normal settings'''
 ||allowed hosts||127.0.0.1||ALLOWED HOSTS: A comaseparated list of allowed hosts. You can use netmasks (/ syntax) or * to create ranges. Parent element can be found under: /settings/default/socket
@@ -267 +282 @@
 ||timeout||30||TIMEOUT: Timeout when reading packets on incoming sockets. If the data has not arrived within this time we will bail out. Parent element can be found under: /settings/default/socket
 ||use ssl||1||ENABLE SSL ENCRYPTION: This option controls if SSL should be enabled. Parent element can be found under: /settings/default/socket
-== /settings/distributed/client ==
-'''Normal settings'''
-||channel||DNSCP||CHANNEL: The channel to listen to.
-== /settings/distributed/client/handlers ==
-== /settings/distributed/client/targets ==
-== /settings/distributed/client/targets/default ==
-'''Normal settings'''
-||address||||TARGET ADDRESS: Target host address
-||alias||default||TARGET ALIAS: The alias for the target
-||certificate||${certificate-path}/nrpe_dh_512.pem||SSL CERTIFICATE: 
-||host||default||TARGET HOST: Target host name
-||parent||default||TARGET PARENT: The parent the target inherits from
-||payload length||1024||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.
-||timeout||30||TIMEOUT: Timeout when reading/writing packets to/from sockets.
-||use ssl||1||ENABLE SSL ENCRYPTION: This option controls if SSL should be enabled.
-== /settings/distributed/server ==
-'''Normal settings'''
-||host||tcp://*:5555||HOST TO BIND/CONNECT TO: The host to bind/connect to
-||mode||master||OPERATION MODE: Mode of operation can only be master now but will add more later on (such as slave)
-||suffix||ncsp.dist||SUFFIX FOR INTERNAL CHANNELS: Has to be uniq on each server
-||worker pool size||10||WORKER POOL SIZE: Number of threads to spawn for the worker pool
 == /settings/eventlog ==
+Section for the EventLog Checker (CheckEventLog.dll).
 '''Normal settings'''
 ||buffer size||131072||BUFFER_SIZE: The size of the buffer to use when getting messages this affects the speed and maximum size of messages you can recieve.
@@ -295 +290 @@
 ||syntax||||SYNTAX: Set this to use a specific syntax string for all commands (that don't specify one).
 == /settings/eventlog/real-time ==
+A set of options to configure the real time checks
 '''Normal settings'''
 ||destination||NSCA||DESTINATION: The destination for intercepted messages
@@ -305 +301 @@
 ||syntax||%type% %source%: %message%||STARTUP AGE: The initial age to scan when starting NSClient++
 == /settings/eventlog/real-time/filters ==
+A set of filters to use in real-time mode
 == /settings/external scripts ==
+Section for external scripts configuration options (CheckExternalScripts).
 '''Normal settings'''
 ||allow arguments||0||COMMAND ARGUMENT PROCESSING: This option determines whether or not the we will allow clients to specify arguments to commands that are executed.
@@ -312 +310 @@
 ||timeout||60||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.
 == /settings/external scripts/alias ==
+A list of aliases available. An alias is an internal command that has been "wrapped" (to add arguments). Be careful so you don't create loops (ie check_loop=check_a, check_a=check_loop)
 == /settings/external scripts/scripts ==
+A list of scripts available to run from the CheckExternalScripts module. Syntax is: <command>=<script> <arguments>
 == /settings/external scripts/wrapped scripts ==
+A list of wrappped scripts (ie. using the template mechanism)
 == /settings/external scripts/wrappings ==
+A list of templates for wrapped scripts
 == /settings/log ==
+Configure loggning properties.
 '''Normal settings'''
 ||date format||%Y-%m-%d %H:%M:%S||DATEMASK: The size of the buffer to use when getting messages this affects the speed and maximum size of messages you can recieve.
@@ -323 +326 @@
 ||root||auto||ROOT: Set this to use a specific syntax string for all commands (that don't specify one).
 == /settings/nscp/server ==
+Section for NSCP (NSCPListener.dll) (check_nscp) protocol options.
 '''Normal settings'''
 ||allowed hosts||127.0.0.1||ALLOWED HOSTS: A comaseparated list of allowed hosts. You can use netmasks (/ syntax) or * to create ranges. Parent element can be found under: /settings/default
@@ -334 +338 @@
 ||use ssl||1||ENABLE SSL ENCRYPTION: This option controls if SSL should be enabled. Parent element can be found under: /settings/default
 == /settings/pytest ==
+Section for the PythonScripts module.
 == /settings/pytest/scripts ==
+A list of scripts available to run from the PythonScript module.
 == /settings/python ==
+Section for the PythonScripts module.
 == /settings/python/scripts ==
+A list of scripts available to run from the PythonScript module.
 == /settings/scheduler ==
+Section for the Scheduler module.
 '''Normal settings'''
 ||threads||5||THREAD COUNT: Number of threads to use.
 == /settings/scheduler/default ==
+Schedule defenition for: Default schedule
 '''Normal settings'''
 ||alias||||SCHEDULE ALIAS: The alias (service name) to report to server
@@ -348 +358 @@
 ||report||all||REPORT MODE: What to report to the server (any of the following: all, critical, warning, unknown, ok)
 == /settings/scheduler/schedules ==
+Section for the Scheduler module.
 == /settings/shared session ==
+Section for configuring the shared session.
 '''Normal settings'''
 ||enabled||0||LOG LEVEL: Log level to use
 == /settings/syslog/client ==
+Section for SYSLOG passive check module.
 '''Normal settings'''
 ||channel||syslog||CHANNEL: The channel to listen to.
 ||hostname||||HOSTNAME: The host name of this host if set to blank (default) the windows name of the computer will be used.
 == /settings/syslog/client/handlers ==
+
 == /settings/syslog/client/targets ==
+
 == /settings/syslog/client/targets/default ==
+Target defnition for: default
 '''Normal settings'''
 ||address||||TARGET ADDRESS: Target host address
@@ -372 +388 @@
 ||warning severity||warning||SSL CERTIFICATE: 
 == /settings/targets ==
+A list of avalible remote target systems