| 1 | <html> |
|---|
| 2 | |
|---|
| 3 | <head> |
|---|
| 4 | <meta http-equiv="Content-Type" content="text/html; charset=windows-1252"> |
|---|
| 5 | <title>Configuration</title> |
|---|
| 6 | <link rel="stylesheet" type="text/css" href="../nscplus.css"> |
|---|
| 7 | </head> |
|---|
| 8 | |
|---|
| 9 | <body> |
|---|
| 10 | |
|---|
| 11 | <div id="content" class="documentContent"> |
|---|
| 12 | <h1>Configuration</h1> |
|---|
| 13 | <p>Configuration is fairly simple and straight forward. Open the configuration |
|---|
| 14 | file in notepad (or you favorite editor) notepad <installation path>\NSC.ini |
|---|
| 15 | and edit it accordingly. A longer description of the Configuration file is included |
|---|
| 16 | in the following page.</p> |
|---|
| 17 | <p> </p> |
|---|
| 18 | <p>The file has sections (denoted with section name in brackets) and key/value |
|---|
| 19 | pairs (denoted by key=value). Thus it has the same syntax as pretty much any |
|---|
| 20 | other INI file in windows.</p> |
|---|
| 21 | <p> </p> |
|---|
| 22 | <p>The sections are described in short below. The default configuration file |
|---|
| 23 | has a lot of examples and comments so make sure you change this before you use |
|---|
| 24 | NSClient++ as some of the examples might be potential security issues.</p> |
|---|
| 25 | <h2>[Log]</h2> |
|---|
| 26 | <p>This section has options for how logging is performed. First off notice that |
|---|
| 27 | for logging to make sense you need to enable the FileLogger.dll module that |
|---|
| 28 | logs all log data to a text file in the same directory as the NSClient++ binary |
|---|
| 29 | if you dont enable any logging module nothing will be logged.</p> |
|---|
| 30 | <p>The options you have available here are</p> |
|---|
| 31 | <table class="MsoNormalTable" border="0" cellspacing="0" cellpadding="0" id="table16"> |
|---|
| 32 | <tr> |
|---|
| 33 | <td valign="top">Option</td> |
|---|
| 34 | <td valign="top">Default value</td> |
|---|
| 35 | <td valign="top">Description</td> |
|---|
| 36 | </tr> |
|---|
| 37 | <tr> |
|---|
| 38 | <td valign="top">debug</td> |
|---|
| 39 | <td valign="top">0</td> |
|---|
| 40 | <td valign="top">A Boolean value that toggles if debug information should |
|---|
| 41 | be logged or not. This can be either 1 or 0.</td> |
|---|
| 42 | </tr> |
|---|
| 43 | <tr> |
|---|
| 44 | <td valign="top">file</td> |
|---|
| 45 | <td valign="top">nsclient.log</td> |
|---|
| 46 | <td valign="top">The file to write log data to. If no directory is used |
|---|
| 47 | this is relative to the NSClient++ binary.</td> |
|---|
| 48 | </tr> |
|---|
| 49 | </table> |
|---|
| 50 | <h2>[Systray]</h2> |
|---|
| 51 | <p>This section configures the system tray module.</p> |
|---|
| 52 | <table class="MsoNormalTable" border="0" cellspacing="0" cellpadding="0" id="table17"> |
|---|
| 53 | <tr> |
|---|
| 54 | <td valign="top">Option</td> |
|---|
| 55 | <td valign="top">Default value</td> |
|---|
| 56 | <td valign="top">Description</td> |
|---|
| 57 | </tr> |
|---|
| 58 | <tr> |
|---|
| 59 | <td valign="top">defaultCommand</td> |
|---|
| 60 | <td valign="top">
</td> |
|---|
| 61 | <td valign="top">A string that will be the default in the inject command |
|---|
| 62 | dialog.</td> |
|---|
| 63 | </tr> |
|---|
| 64 | </table> |
|---|
| 65 | <h2>[NSClient]</h2> |
|---|
| 66 | <p>This is the NSClient module configuration options.</p> |
|---|
| 67 | <p><b><i>This is subject to change in the near future</i></b></p> |
|---|
| 68 | <table class="MsoNormalTable" border="0" cellspacing="0" cellpadding="0" id="table18"> |
|---|
| 69 | <tr> |
|---|
| 70 | <td valign="top">Option</td> |
|---|
| 71 | <td valign="top">Default value</td> |
|---|
| 72 | <td valign="top">Description</td> |
|---|
| 73 | </tr> |
|---|
| 74 | <tr> |
|---|
| 75 | <td valign="top">port</td> |
|---|
| 76 | <td valign="top">12489</td> |
|---|
| 77 | <td valign="top">The port to listen to</td> |
|---|
| 78 | </tr> |
|---|
| 79 | <tr> |
|---|
| 80 | <td valign="top">password</td> |
|---|
| 81 | <td valign="top"> </td> |
|---|
| 82 | <td valign="top">The password that incoming client needs to authorize |
|---|
| 83 | themselves by.</td> |
|---|
| 84 | </tr> |
|---|
| 85 | <tr> |
|---|
| 86 | <td valign="top">allowed_hosts</td> |
|---|
| 87 | <td valign="top"> </td> |
|---|
| 88 | <td valign="top">A list (coma separated) with hosts that are allowed |
|---|
| 89 | to poll information from NSClient++</td> |
|---|
| 90 | </tr> |
|---|
| 91 | <tr> |
|---|
| 92 | <td valign="top">use_ssl</td> |
|---|
| 93 | <td valign="top">0</td> |
|---|
| 94 | <td valign="top">Boolean value to toggle SSL encryption. This is not |
|---|
| 95 | yet supported in any client I know of but as the underlying structure |
|---|
| 96 | (NRPE) supports it I thought Id might add it if someone wants to update |
|---|
| 97 | check_nt to support SSL.<b>Not implemented in this version</b></td> |
|---|
| 98 | </tr> |
|---|
| 99 | </table> |
|---|
| 100 | <h2>[NRPE]</h2> |
|---|
| 101 | <p>This is configuration for the NRPE module that controls how the NRPE listener |
|---|
| 102 | operates. </p> |
|---|
| 103 | <table class="MsoNormalTable" border="0" cellspacing="0" cellpadding="0" id="table19"> |
|---|
| 104 | <tr> |
|---|
| 105 | <td valign="top">Option</td> |
|---|
| 106 | <td valign="top">Default value</td> |
|---|
| 107 | <td valign="top">Description</td> |
|---|
| 108 | </tr> |
|---|
| 109 | <tr> |
|---|
| 110 | <td valign="top">port</td> |
|---|
| 111 | <td valign="top">5666</td> |
|---|
| 112 | <td valign="top">The port to listen to</td> |
|---|
| 113 | </tr> |
|---|
| 114 | <tr> |
|---|
| 115 | <td valign="top">allowed_hosts</td> |
|---|
| 116 | <td valign="top"> </td> |
|---|
| 117 | <td valign="top">A list (coma separated) with hosts that are allowed |
|---|
| 118 | to poll information from NSClient++</td> |
|---|
| 119 | </tr> |
|---|
| 120 | <tr> |
|---|
| 121 | <td valign="top">use_ssl</td> |
|---|
| 122 | <td valign="top">1</td> |
|---|
| 123 | <td valign="top">Boolean value to toggle SSL encryption on the socket |
|---|
| 124 | connection</td> |
|---|
| 125 | </tr> |
|---|
| 126 | <tr> |
|---|
| 127 | <td valign="top">command_timeout</td> |
|---|
| 128 | <td valign="top">60</td> |
|---|
| 129 | <td valign="top">The maximum time in seconds that a command can execute. |
|---|
| 130 | (if more then this execution will be aborted).<b>NOTICE</b> this only |
|---|
| 131 | affects external commands not internal ones.</td> |
|---|
| 132 | </tr> |
|---|
| 133 | <tr> |
|---|
| 134 | <td valign="top">allow_arguments</td> |
|---|
| 135 | <td valign="top">0</td> |
|---|
| 136 | <td valign="top">A Boolean flag to determine if arguments are accepted |
|---|
| 137 | on the incoming socket. If arguments are not accepted you can still |
|---|
| 138 | use external commands that need arguments but you have to define them |
|---|
| 139 | in the NRPE handlers below. This is similar to the NRPE dont_blame_nrpe |
|---|
| 140 | option.</td> |
|---|
| 141 | </tr> |
|---|
| 142 | <tr> |
|---|
| 143 | <td valign="top">allow_nasty_meta_chars</td> |
|---|
| 144 | <td valign="top">0</td> |
|---|
| 145 | <td valign="top">Allow NRPE execution to have nasty meta characters |
|---|
| 146 | that might affect execution of external commands (things like > etc).</td> |
|---|
| 147 | </tr> |
|---|
| 148 | </table> |
|---|
| 149 | <h2>[NRPE Handlers]</h2> |
|---|
| 150 | <p>This is a list of handlers for NRPE execution this can of course be used |
|---|
| 151 | by any module (such as NSClient) but for historical reasons they are located |
|---|
| 152 | in this section especially as NRPE plug-in is the one that does the actual execution.</p> |
|---|
| 153 | <p>The handlers can have two different syntaxes:</p> |
|---|
| 154 | <p>Either command[my_command]=/some/executable or my_command=/some/executable |
|---|
| 155 | The latter is the preferred way as it is shorter.</p> |
|---|
| 156 | <h2>[Check System]</h2> |
|---|
| 157 | <p>Here you can set various options to configure the Syetem Check module.</p> |
|---|
| 158 | <table class="MsoNormalTable" border="0" cellspacing="0" cellpadding="0" id="table20"> |
|---|
| 159 | <tr> |
|---|
| 160 | <td valign="top">Option</td> |
|---|
| 161 | <td valign="top">Default value</td> |
|---|
| 162 | <td valign="top">Description</td> |
|---|
| 163 | </tr> |
|---|
| 164 | <tr> |
|---|
| 165 | <td valign="top">CPUBufferSize</td> |
|---|
| 166 | <td valign="top">1h</td> |
|---|
| 167 | <td valign="top">The time to store CPU load. This means you can get |
|---|
| 168 | averaged values this far back in time. The downside is the buffer might |
|---|
| 169 | use a lot of memory if the check resolution is high.</td> |
|---|
| 170 | </tr> |
|---|
| 171 | <tr> |
|---|
| 172 | <td valign="top">CheckResolution</td> |
|---|
| 173 | <td valign="top">10</td> |
|---|
| 174 | <td valign="top">Time between checks in 1/10 of seconds. That means |
|---|
| 175 | a value of 10 means check every second. A value of 100 means check every |
|---|
| 176 | 10 seconds and so on.</td> |
|---|
| 177 | </tr> |
|---|
| 178 | <tr> |
|---|
| 179 | <td valign="top">CounterPageLimit</td> |
|---|
| 180 | <td valign="top">\\\\.\\Memory\\Commit Limit</td> |
|---|
| 181 | <td valign="top">Counter to use to check upper memory limit.</td> |
|---|
| 182 | </tr> |
|---|
| 183 | <tr> |
|---|
| 184 | <td valign="top">CounterPage</td> |
|---|
| 185 | <td valign="top">\\\\.\\Memory\\Committed Bytes</td> |
|---|
| 186 | <td valign="top">Counter to use to check current memory usage.</td> |
|---|
| 187 | </tr> |
|---|
| 188 | <tr> |
|---|
| 189 | <td valign="top">CounterUptime</td> |
|---|
| 190 | <td valign="top">\\\\.\\System\\System Up Time</td> |
|---|
| 191 | <td valign="top">Counter to use to check the uptime of the system.</td> |
|---|
| 192 | </tr> |
|---|
| 193 | <tr> |
|---|
| 194 | <td valign="top">CounterCPU</td> |
|---|
| 195 | <td valign="top">\\\\.\\Processor(_total)\\% Processor Time</td> |
|---|
| 196 | <td valign="top">Counter to use for CPU load.</td> |
|---|
| 197 | </tr> |
|---|
| 198 | </table> |
|---|
| 199 | <h2>[modules]</h2> |
|---|
| 200 | <p>This is a list of modules to load at startup. All the modules included in |
|---|
| 201 | this list has to be NSClient++ modules and located in the modules subdirectory. |
|---|
| 202 | This is in effect the list of plug-ins that will be available as the service |
|---|
| 203 | is running.</p> |
|---|
| 204 | <p>A good idea here is to disable all modules you dont actually use for two |
|---|
| 205 | reasons. One less code equals less potential security holes and two less modules |
|---|
| 206 | means less resource drain.</p> |
|---|
| 207 | </div> |
|---|
| 208 | |
|---|
| 209 | </body> |
|---|
| 210 | |
|---|
| 211 | </html> |
|---|
