Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

...

AttributeUsageDescription
nameRequiredThe unique name of this fragment.
monitor_hostRequiredThis setting specifies the host name or IP address of the System Monitor host.
monitor_portRequiredThis setting specifies the TCP port that the System Monitor listens to.
monitor_passwordOptional

This setting specifies the connection password

  • for NSCA - password configured in the ncsa.cfg file.
monitor_connection_timeoutOptional

This setting specifies the connection timeout in ms.

Default: 5000

monitor_response_timeoutOptionalThis setting specifies the response timeout in ms.
monitor_encryptionOptional

This setting specifies that the communication with the System Monitor is encrypted. By default no encryption is used.

  • NONE             - no encryption
  • XOR            - XOR encryption
  • TRIPLE_DES - use of triple des algorithm for encryption
service_hostRequiredThis setting specifies the name of the host that executes the passive check.



Note
titleSystem Monitor: Opsview

In case you are using Opsview® as a monitoring tool consider that the plugin will not work, since Opsview® supports ca. 20 encryption types that are not supported by this plugin. You could only use the plugin in case that no encryption (type: NONE) is used.

Instead, you can use the JS7 - Notifications - Configuration Element CommandFragment and indicate the exact command to send passive checks to your System Monitor from a remote machine by use of the System Monitor's Agent.

Examples

Nagios / op5

The following is an excerpt from an XML configuration for notification with Nagios or op5 via the NSCAFragment:

Code Block
languagexml
titleExampleSystemMonitorNotification_OP5.xml
collapsetrue
 ...
<!--
monitor_host            The hostname or IP address of the System Monitor host 
monitor_port            The TCP port that the System Monitor listens to
monitor_encryption      Encryption algorithm
service_host            The host that executes the passive check. The name must match the corresponding setting in the System Monitor.
{MON_O_CONTROLLER_ID}   The JS7 Controller ID, see Monitor Variables
-->
...
...
<Message name="nsca_message"><![CDATA[
controller id=${MON_O_CONTROLLER_ID}, history id=${MON_O_HISTORY_ID}, workflow path=${MON_O_WORKFLOW_PATH}, order id=(${MON_O_ORDER_ID}), order step status=${MON_OS_SEVERITY}, error=${MON_OS_ERROR_TEXT}
]]></Message>
...
<NSCAFragment monitor_host="monitor_host" 
              monitor_port="5667" 
              monitor_encryption="XOR" 
              service_host="service_host">
  <MessageRef ref="nsca_message"/>
</NSCAFragment>
...
Note
titleSystem Monitor: Opsview
In case you are using Opsview® as a monitoring tool consider that the plugin will not work, since Opsview® supports ca. 20 encryption types that are not supported by this plugin
.
You could only use the plugin in case that no encryption (type: NONE) is used
.
Instead, you can use the XML  CommandFragment element and indicate the exact command to send passive checks to your System Monitor from a remote machine by use of the System Monitor's Agent
.