CheckNSCP
Use this module to check the healt and status of NSClient++ it self

CheckNSCP — CheckNSCP

Use this module to check the healt and status of NSClient++ it self

Queries (Overview):

A list of all avalible queries (check commands)

Command Description
check_nscp Check the internal healt of NSClient++.

Commands (executable): TODO: Add command list

Configuration (Overview):

A list of all configuration options

Path / Section Key Default value Description
/settings/crash submit url http://crash.nsclient.org/submit SUBMISSION URL
/settings/crash submit 0 SUBMIT CRASHREPORTS
/settings/crash restart target NSCP RESTART SERVICE NAME
/settings/crash archive folder ${shared-path}crash-dumps CRASH ARCHIVE LOCATION
/settings/crash archive 1 ARCHIVE CRASHREPORTS
/settings/crash restart 1 RESTART

Queries

A quick reference for all avalible queries (check commands) in the CheckNSCP module.

check_nscp

CheckNSCPcheck_nscp
Check the internal healt of NSClient++.

Usage:

Option Default value Description
help N/A Show help screen (this screen)
help-csv N/A Show help screen as a comma separated list.
help-short N/A Show help screen (short format).

Arguments

help (CheckNSCP, check_nscp)
Show help screen (this screen)
help-csv (CheckNSCP, check_nscp)
Show help screen as a comma separated list.
This is useful for parsing the output in scripts and generate documentation etc
help-short (CheckNSCP, check_nscp)
Show help screen (short format).

Configuration

A quick reference for all avalible configuration options in the CheckNSCP module.

... / crash

/settings/crash (CheckNSCP)
Key Default Value Description
archive 1 ARCHIVE CRASHREPORTS
archive folder ${shared-path}crash-dumps CRASH ARCHIVE LOCATION
restart 1 RESTART
restart target NSCP RESTART SERVICE NAME
submit 0 SUBMIT CRASHREPORTS
submit url http://crash.nsclient.org/submit SUBMISSION URL

Sample:

# CRASH SECTION
# Configure crash handling properties.
[/settings/crash]
# SUBMISSION URL
# The url to submit crash reports to
submit url=http://crash.nsclient.org/submit
# SUBMIT CRASHREPORTS
# Submit crash reports to nsclient.org (or your configured submission server)
submit=0
# 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
# ARCHIVE CRASHREPORTS
# Archive crash reports in the archive folder
archive=1
# RESTART
# Submit crash reports to nsclient.org (or your configured submission server)
restart=1
submit url (CheckNSCP, /settings/crash)

SUBMISSION URL

The url to submit crash reports to

Path: /settings/crash

Key: submit url

Default value: http://crash.nsclient.org/submit

Used by: CheckNSCP, :module:``

Sample:

# SUBMISSION URL
# The url to submit crash reports to
[/settings/crash]
submit url=http://crash.nsclient.org/submit
submit (CheckNSCP, /settings/crash)

SUBMIT CRASHREPORTS

Submit crash reports to nsclient.org (or your configured submission server)

Path: /settings/crash

Key: submit

Default value: 0

Used by: CheckNSCP, :module:``

Sample:

# SUBMIT CRASHREPORTS
# Submit crash reports to nsclient.org (or your configured submission server)
[/settings/crash]
submit=0
restart target (CheckNSCP, /settings/crash)

RESTART SERVICE NAME

The url to submit crash reports to

Path: /settings/crash

Key: restart target

Default value: NSCP

Used by: CheckNSCP, :module:``

Sample:

# RESTART SERVICE NAME
# The url to submit crash reports to
[/settings/crash]
restart target=NSCP
archive folder (CheckNSCP, /settings/crash)

CRASH ARCHIVE LOCATION

The folder to archive crash dumps in

Path: /settings/crash

Key: archive folder

Default value: ${shared-path}crash-dumps

Used by: CheckNSCP, :module:``

Sample:

# CRASH ARCHIVE LOCATION
# The folder to archive crash dumps in
[/settings/crash]
archive folder=${shared-path}crash-dumps
archive (CheckNSCP, /settings/crash)

ARCHIVE CRASHREPORTS

Archive crash reports in the archive folder

Path: /settings/crash

Key: archive

Default value: 1

Used by: CheckNSCP, :module:``

Sample:

# ARCHIVE CRASHREPORTS
# Archive crash reports in the archive folder
[/settings/crash]
archive=1
restart (CheckNSCP, /settings/crash)

RESTART

Submit crash reports to nsclient.org (or your configured submission server)

Path: /settings/crash

Key: restart

Default value: 1

Used by: CheckNSCP, :module:``

Sample:

# RESTART
# Submit crash reports to nsclient.org (or your configured submission server)
[/settings/crash]
restart=1
comments powered by Disqus

Table Of Contents

Previous topic

CheckMKServer — CheckMKServer

Next topic

CheckSystem — CheckSystem

This Page