Versions Compared

Key

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

Table of Contents

Introduction

  • The NSCAFragment

...

SystemMonitorNotification / Notification / NotificationMonitor / NotificationInterface

NSCA plug-in Interface to be executed for System Monitor notification.

  • is used for direct connections to System Monitors that operate a Nagios-compatible NSCA service for passive checks such as Nagios®, Icinga®, Opsview®.
  • This fragment type makes use of the JSend NSCA Java API. Consider that this fragment type does not support more elaborated encryption as required by a number of System Monitors.

NSCAFragment

NSCAFragment supports NotificationInterface supports the following attributes:

AttributeUsageDescription
nameRequiredThe unique name of this fragment.
monitor_hostRequiredThis setting specifies the host name or
ip
IP address of the System Monitor host.
monitor_portRequiredThis setting specifies the TCP port that the System Monitor
would listen
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.
The name must match the corresponding setting in the System Monitor.pluginOptional

Default:

JobScheduler releases before 1.11
  • com.sos.scheduler.notification.plugins.notifier.SystemNotifierSendNscaPlugin
  • JobScheduler releases starting from 1.11

    • com.sos.jitl.notification.plugins.notifier.SystemNotifierSendNscaPlugin
  • See : Message, Examples

    Code Block
    languagexml
    titleExample
    collapsetrue
    ...
    <NotificationInterface<Message monitor_hostname="monitor_host" monitor_port="5667" monitor_encryption="XOR" service_host="service_host"nsca_message"><![CDATA[
    schedulercontroller id=${MON_NO_SCHEDULERCONTROLLER_ID}, history id=${MON_N_ORDERO_HISTORY_ID}, job_chainworkflow path=${MON_NO_JOBWORKFLOW_CHAIN_NAME}PATH}, order id=(${MON_NO_ORDER_ID}), order step status=${MON_N_ORDER_STEP_STATEOS_SEVERITY}, error=${MON_NOS_ERROR_TEXT}
    ]]></NotificationInterface>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 it the plugin in case you use that no encryption (type: NONE) for connections to Opsview®is used.

    Instead, you should can use the XML  CommandFragment element and indicate the exact command to send passive checks to Opsview® your System Monitor from a remote machine (see example for op5 or example for zabbix)by use of the System Monitor's Agent.