| 5 | | Configuration is fairly simple and straight forward. Open the configuration file in notepad (or your favorite editor) "notepad <installation path>\NSC.ini" and edit it accordingly. A longer description of the Configuration file is included in the following page. |
| 6 | | |
| 7 | | The file has sections (denoted with section name in brackets) and key/value pairs (denoted by key=value). Thus it has the same syntax as pretty much any other INI file in windows. |
| 8 | | |
| 9 | | The 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. |
| 10 | | |
| 11 | | The configuration can also be stored in the System Registry (HKLM\Software\NSClient++). There is currently no UI to configure this so the simplest way is to maintain the configuration in the INI file and "Migrate that" to the Registry. |
| 12 | | This is can be done via the [RemoteConfiguration] module but in short: |
| 13 | | {{{ |
| 14 | | NSClient++ -noboot RemoteConfiguration ini2reg |
| 15 | | }}} |
| 16 | | |
| 17 | | A sample configuration file is included in the download but can also be found here [source:trunk/NSC.dist] |
| 18 | | |
| 19 | | == Modules == |
| 20 | | 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. |
| 21 | | For information on the various plug-ins check the Modules section in the navigation box. |
| 22 | | |
| 23 | | A good idea here is to disable all modules you don’t actually use for two reasons: less code equals less potential security holes, and less modules means less resource drain. |
| 24 | | |
| 25 | | A complete list of all available modules: |
| 26 | | [[ListTagged(module)]] |
| 27 | | |
| 28 | | == Settings == |
| 29 | | This section has generic options for NSClient++. Some of these settings (such as allowed_hosts) are inherited in the sections below so it is probably a better idea to set them here in the "global" section. |
| 30 | | |
| 31 | | The options available in this section: |
| 32 | | ||Option||Default value||Description|| |
| 33 | | ||obfuscated_password||...||An obfuscated version of password. For more details refer to the password option below. To create the obfuscated Password use: "NSClient++.exe /encrypt" |
| 34 | | ||password||...||The password used by various (presently only NSClient) daemons. If no password is set everyone will be able to use this service remotely. |
| 35 | | ||allowed_hosts||127.0.0.1||A list (comma separated) with hosts that are allowed to connect and query data. If this is empty all hosts will be allowed to query data. BEWARE: NSClient++ will not resolve the IP address of DNS entries if the service is set to startup automatically. Use an IP address instead. |
| 36 | | ||use_file||0||Has to be set to 1 if you want the file to be read (if set to 0, and the use_reg is set to 1 the registry will be used instead) |
| 37 | | |
| 38 | | '''Advanced options:''' |
| 39 | | ||Option||Default value||Description|| |
| 40 | | ||master_key||...||The secret "key" used when (de)obfuscating passwords. |
| 41 | | ||cache_allowed_hosts||1||Used to cache looked up hosts if you check dynamic/changing hosts set this to 0. |
| 42 | | |
| 43 | | == includes == |
| 44 | | A list of other configuration files to include when reading this file. |
| 45 | | Might be useful if you have a very complex setup or want to have setting split up in segments. |
| 46 | | |
| 47 | | |
| 48 | | = Module Configuration = |
| 49 | | |
| 50 | | == NRPE Listener Sections == |
| 51 | | === NRPE Section === |
| 52 | | ''This section is included from [wiki:NRPEListener/config/nrpe]'' |
| 53 | | [[Include(NRPEListener/config/nrpe)]] |
| 54 | | === NRPE Handlers Section === |
| 55 | | ''This section is included from [wiki:NRPEListener/config/nrpe_handlers]'' |
| 56 | | [[Include(NRPEListener/config/nrpe_handlers)]] |
| 57 | | |
| 58 | | == File Logging Sections == |
| 59 | | === Log Section === |
| 60 | | ''This section is included from [wiki:FileLogger/config]'' |
| 61 | | [[Include(FileLogger/config)]] |
| 62 | | |
| 63 | | == NSClient Sections == |
| 64 | | === NSClient Section === |
| 65 | | ''This section is included from [wiki:NSClientListener/config]'' |
| 66 | | [[Include(NSClientListener/config)]] |
| 67 | | |
| 68 | | == Check System Sections == |
| 69 | | === CheckSystem Section === |
| 70 | | ''This section is included from [wiki:CheckSystem/config]'' |
| 71 | | [[Include(CheckSystem/config)]] |
| 72 | | |
| 73 | | == External Script Sections == |
| 74 | | === External Script Section === |
| 75 | | ''This section is included from [wiki:CheckExternalScripts/config/external_script]'' |
| 76 | | [[Include(CheckExternalScripts/config/external_script)]] |
| 77 | | === External Scripts Section === |
| 78 | | ''This section is included from [wiki:CheckExternalScripts/config/external_scripts]'' |
| 79 | | [[Include(CheckExternalScripts/config/external_scripts)]] |
| 80 | | === External Alias Section === |
| 81 | | ''This section is included from [wiki:CheckExternalScripts/config/external_alias]'' |
| 82 | | [[Include(CheckExternalScripts/config/external_alias)]] |
| 83 | | |
| 84 | | == Event Log Sections == |
| 85 | | === Event Log Section === |
| 86 | | ''This section is included from [wiki:CheckEventLog/config]'' |
| 87 | | [[Include(CheckEventLog/config)]] |
| 88 | | |
| 89 | | == NSCA Agent Sections == |
| 90 | | These sections describe the configuration options for the [wiki:NSCAAgent NSCA module]. |
| 91 | | === NSCA Agent Section === |
| 92 | | ''This section is included from [wiki:NSCAAgent/config/NSCA_Agent]'' |
| 93 | | [[Include(NSCAAgent/config/NSCA_Agent)]] |
| 94 | | === NSCA Commands Section === |
| 95 | | ''This section is included from [wiki:NSCAAgent/config/NSCA_Commands]'' |
| 96 | | [[Include(NSCAAgent/config/NSCA_Commands)]] |
| 97 | | |
| 98 | | == LUA Scripts == |
| 99 | | A list of LUA script to load at startup. In difference to "external checks" all LUA scripts are loaded at startup. Names have no meaning since the script (on boot) submits the available commands and tie them to various functions. |
| 100 | | {{{ |
| 101 | | [LUA Scripts] |
| 102 | | scripts\test.lua |
| 103 | | }}} |
| | 5 | The configuration is split into two page one for [[wiki:doc/configuration/0.3.x]] and one for [[wiki:doc/configuration/0.4.x]] |
