NSClient

What's Changed

• Added even more client commands by @mickem in https://github.com/mickem/nscp/pull/1086

You can now login/logout using the auth command which will store the token in credential store:

check_nsclient nsclient --insecure auth login --username admin --password PASSWORD

After this you no longer need to specify the username and password:

check_nsclient nsclient --insecure settings list
╭───────────────┬──────────────────────────────────────────┬──────────────────────────────────────────────────────────────────────────────────────────────────╮
│ key           │ path                                     │ value                                                                                            │
├───────────────┼──────────────────────────────────────────┼──────────────────────────────────────────────────────────────────────────────────────────────────┤
│ CheckHelpers  │ /modules                                 │ enabled                                                                                          │
│ CheckSystem   │ /modules                                 │ disabled                                                                                         │
│ LuaScript     │ /modules                                 │ enabled                                                                                          │
│ WEBServer     │ /modules                                 │ enabled                                                                                          │
| client        │ /settings/WEB/server/roles               │ public,info.get,info.get.version,queries.list,queries.get,queries.execute,login.get,modules.list │
│ full          │ /settings/WEB/server/roles               │ *                                                                                                │
│ legacy        │ /settings/WEB/server/roles               │ legacy,login.get                                                                                 │
│ view          │ /settings/WEB/server/roles               │ *                                                                                                │
╰───────────────┴──────────────────────────────────────────┴──────────────────────────────────────────────────────────────────────────────────────────────────╯

Besides settings related commands you can now also show logs:

check_nsclient nsclient --insecure logs list
╭───────┬──────────────────────┬───────────────────────────────────────────────────────────────╮
│ level │ date                 │ message                                                       │
├───────┼──────────────────────┼───────────────────────────────────────────────────────────────┤
│ debug │ 2025-Dec-24 19:00:16 │ Loading plugin: CheckHelpers                                  │
│ debug │ 2025-Dec-24 19:00:16 │ Loading plugin: LuaScript                                     │
│ debug │ 2025-Dec-24 19:00:16 │ Adding script: C:\src\build\nscp\scripts\lua\mock.lua         │
│ debug │ 2025-Dec-24 19:00:16 │ Lua not compiled with protocol buffer support                 │
│ debug │ 2025-Dec-24 19:00:16 │ Loading plugin: WEBServer                                     │
│ debug │ 2025-Dec-24 19:00:16 │ Using certificate: C:\src\build\nscp/security/certificate.pem │
│ debug │ 2025-Dec-24 19:00:16 │ Loading webserver on port: 8443                               │
│ debug │ 2025-Dec-24 19:00:16 │ Starting plugin: LuaScript                                    │
│ debug │ 2025-Dec-24 19:00:16 │ NSClient++ - 0.4.0 2025-12-22 Started!                        │
│ debug │ 2025-Dec-24 19:00:16 │ Loading module C:\src\build\nscp\modules\CommandClient.dll () │
╰───────┴──────────────────────┴───────────────────────────────────────────────────────────────╯

Full Changelog: https://github.com/mickem/nscp/compare/0.11.1...0.11.2

What's Changed

Added query command to check_nsclient command and attached client only binaries to release.

This means you can now inventory queries (check_commands):

check_nsclient nsclient --insecure --password PASSWORD queries list
╭───────────────────────┬──────────────╮
│ title                 │ plugin       │
├───────────────────────┼──────────────┤
│ check_always_critical │ CheckHelpers │
│ check_always_ok       │ CheckHelpers │
│ check_always_warning  │ CheckHelpers │
│ check_and_forward     │ CheckHelpers │
╰───────────────────────┴──────────────╯

As well as execute queries:

check_nsclient nsclient --insecure --password PASSWORD queries execute check_memory
╭─────────────┬────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────╮
│ command     │ check_memory                                                                                                           │
│ output      │ OK: committed: 36.009GB/68.483GB, physical: 30.276GB/63.733GB                                                          │
│ committed   │ 36.008548736572266GB, warning: 54.78678588848561, critical: 61.635134124197066, minimum: 0, maximum: 68.48348236083984 │
│ physical %  │ 48%, warning: 80, critical: 90, minimum: 0, maximum: 100                                                               │
│ committed % │ 53%, warning: 80, critical: 90, minimum: 0, maximum: 100                                                               │
│ physical    │ 30.27570343017578GB, warning: 50.986785888671875, critical: 57.36013412475586, minimum: 0, maximum: 63.73348236083984  │
│ result      │ OK                                                                                                                     │
╰─────────────┴────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────╯

As with most commands you can get output as json:

check_nsclient --output json nsclient --insecure --password PASSWORD queries execute check_cpu
{
  "command": "check_cpu",
  "lines": [
    {
      "message": "OK: CPU load is ok.",
      "perf": {
        "total 1m": {
          "value": 20.0,
          "unit": "%",
          "warning": 80.0,
          "critical": 90.0,
          "minimum": null,
          "maximum": null
        },
        "total 5s": {
          "value": 23.0,
          "unit": "%",
          "warning": 80.0,
          "critical": 90.0,
          "minimum": null,
          "maximum": null
        },
        "total 5m": {
          "value": 21.0,
          "unit": "%",
          "warning": 80.0,
          "critical": 90.0,
          "minimum": null,
          "maximum": null
        }
      }
    }
  ],
  "result": 0
}

As well as in the nagios format:

check_nsclient nsclient --insecure --password PASSWORD queries execute-nagios check_cpu
OK: CPU load is ok.|'total 5m'=22%;80;90 'total 1m'=21%;80;90 'total 5s'=22%;80;90

Full Changelog: https://github.com/mickem/nscp/compare/0.11.0...0.11.1

What's Changed

New experimental client check_nsclient which can be used to check NSClient using the REST interface. This is planned to eventually replace the nscp cli used today. This is also available for linux meaning you can remotely configure your NSClient instances using the CLI.

> Unfortunately I forgot to attach the binaries to the release so linux binaries will come in the next version.

Currently it is limited and can only list and enable modules (but in the next few weeks it will be extended to support many more features).

check_nsclient nsclient --insecure --password PASSWORD modules list
╭───────────────┬───────────────┬─────────┬────────┬───────╮
│ id            │ title         │ enabled │ loaded │ alias │
├───────────────┼───────────────┼─────────┼────────┼───────┤
│ CheckHelpers  │ CheckHelpers  │ true    │ true   │       │
│ LuaScript     │ LUAScript     │ true    │ true   │       │
│ WEBServer     │ WEBServer     │ true    │ true   │       │
│ CommandClient │ CommandClient │ false   │ true   │       │
│ checksystem   │ CheckSystem   │ true    │ true   │       │
╰───────────────┴───────────────┴─────────┴────────┴───────╯

You can also add --all to show all modules (not just loaded ones) as well as load and enable a module using use:

check_nsclient nsclient --insecure --password PASSWORD modules use checksystem
Successfully loaded and enable module checksystem

You can also change the out to csv, jsonor yaml:

check_nsclient --output yaml nsclient --insecure --password PASSWORD modules show checksystem
id: checksystem
name: checksystem
title: CheckSystem
description: Various system related checks, such as CPU load, process state, service state memory usage and PDH counters.
enabled: true
loaded: true
metadata:
  alias: ''
  plugin_id: '4'
load_url: /api/v2/modules/checksystem/commands/load
unload_url: /api/v2/modules/checksystem/commands/unload

> Feel free to come with suggestions and ideas for this feature.

Full Changelog: https://github.com/mickem/nscp/compare/0.10.9...0.11.0