Package org.opennms.netmgt.poller.monitors

Class SshMonitor

  • All Implemented Interfaces:
    ServiceMonitor
    public final class SshMonitor
extends AbstractServiceMonitor
    This class is designed to be used by the service poller framework to test the availability of SSH remote interfaces. The class implements the ServiceMonitor interface that allows it to be used along with other plug-ins by the service poller framework.
    Author:
    Benjamin Reed, OpenNMS

    • Field Detail

      • DEFAULT_TIMEOUT

        public static final int DEFAULT_TIMEOUT
        Constant DEFAULT_TIMEOUT=3000
        See Also:
        Constant Field Values

      • DEFAULT_PORT

        public static final int DEFAULT_PORT
        Constant DEFAULT_PORT=22
        See Also:
        Constant Field Values

    • Constructor Detail

      • SshMonitor

        public SshMonitor()

    • Method Detail

      • poll

        public PollStatus poll​(InetAddress address,
                       Map<String,​Object> parameters)
        Poll an InetAddress for SSH availability. During the poll an attempt is made to connect on the specified port. If the connection request is successful, the banner line generated by the interface is parsed and if the banner text indicates that we are talking to Provided that the interface's response is valid we mark the poll status as available and return.

        Parameters:
        address -
        parameters -
        Returns:

      • poll

        public PollStatus poll​(MonitoredService svc,
                       Map<String,​Object> parameters)

        This method is the heart of the plug-in monitor. Each time an interface requires a check to be performed as defined by the scheduler the poll method is invoked. The poll is passed the service to check.

        By default when the status transition from up to down or vice versa the framework will generate an event. Additionally, if the polling interval changes due to an extended unavailability, the framework will generate an additional down event. The plug-in can suppress the generation of the default events by setting the suppress event bit in the returned integer.

        NOTE: This method may be invoked on a Minion, in which case certain bean and facilities will not be available. If any state related information is required such as agent related configuration, it should retrieved by the ServiceMonitor.getRuntimeAttributes(MonitoredService, Map).

        Poll the specified address for service availability.

        Parameters:
        svc -
        parameters -
        Returns:

        See Also:
        poll(InetAddress, Map)