Plugin reference

Checks for software updates on systems that use package management systems based on the apt-get(8) command found in Debian GNU/Linux and Ubuntu.

This plugin helps you keep your Debian GNU/Linuxand Ubuntu systems updated with the latest security packages by using the apt sources added to the system to see if there are any new updates to download.

Naemon plugin for monitoring AWS using CloudWatch.

This plugin provides a Naemon-compatible CLI for performing AWS health checks through CloudWatch.

check_by_snmp_cpu_total_usage_v2, check_by_snmp_cpu_total_usage_v3, check_by_snmp_cpu_user_v2, check_by_snmp_cpu_user_v3, check_by_snmp_cpu_nice_v2, check_by_snmp_cpu_nice_v3, check_by_snmp_cpu_system_v2, check_by_snmp_cpu_system_v3, check_by_snmp_cpu_idle_v2, check_by_snmp_cpu_idle_v3, check_by_snmp_cpu_iowait_v2, check_by_snmp_cpu_iowait_v3, check_by_snmp_cpu_steal_v2, check_by_snmp_cpu_steal_v3, check_by_snmp_cpu_custom

Checks CPU usage over SNMP.

This plugin can monitor CPU usage on hosts where you cannot install any agents by collecting monitored data over SNMP.

Checks disk information on hard drives using SNMP.

This plugin can monitor disk usage on hosts where you cannot install any agents by collecting monitored data over SNMP.

Checks disk information about IO on hard drives using SNMP.

This plugin can monitor disk usage on hosts where you cannot install any agents by collecting monitored data over SNMP.

Runs other plugins using SNMP.

If you do not want to use other types of agents, this plugin lets you run plugins on remote systems with tools that are usually readily packaged by vendors by collecting monitored data over SNMP.

Checks CPU load average over SNMP.

This plugin can monitor CPU load average on hosts where you cannot install any agents by collecting monitored data over SNMP.

Checks memory usage on Unix and Linux platforms using SNMP.

This plugin can monitor memory usage on hosts where you cannot install any agents by collecting monitored data over SNMP.

Checks if and how many processes are running on the remote system.

This plugin can monitor processes on hosts where you cannot install any agents by collecting monitored data over SNMP.

Executes commands on remote hosts.

This plugin can check different statuses over an encrypted protocol. This also uses SSH to connect to the remote host, and then executes your specified check command.

Tests clamd connections with the specified host (or Unix socket).

To make sure the clam antivirus daemon is running and is responding.
How? Connects to the clam daemon either via TCP or the local Unix socket. The received string is parsed.

Used to check a cluster of services or hosts.

This plugin ensures that a clustered service is working as expected by checking defined services in OP5 Monitor.

Tests functionality of a DHCP server.

Use this plugin to see that the DHCP server is working. This requests an IP address and you can also specify which IP to ask for and what server to ask.

Checks DNS servers on a specific host using dig.

This plugin can verify the functionality of the DNS server by using the dig command to resolve a hostname. The plugin also allows you to specify a hostname and the expected IP address.

check_disk_of_backup_share, check_disk_custom, check_disk_local_mb

Checks disk usage on a mounted partition.

This plugin can keep track of disk usage and be notified before the disks fill up by checking disk usage on a mounted partition. This also allows you to specify usage thresholds and the partitions to check.

Checks disk usage on an SMB partitions.

This plugin can keep track of disk usage and be notified before the disks fill up by using the smbclient program and connecting to the SMB share.

Checks DNS servers.

This plugin ensures that your DNS is resolving correctly by using the nslookup command to obtain the IP address for the given host or domain query.

Checks Docker container status.

This plugin ensures that Docker containers are working as expected. It uses check_docker.py and check_swarm.py to monitor Docker containers over INET or Unix sockets.

Not platform dependent

Returns whatever status, service output data, and service performance data you specify.

This can be used if you want to add hosts to your configuration that you cannot monitor but really want to include in the network map.

Checks Elasticsearch query total documents. It is designed to work with Energy Logserver, OP5 Log Analytics, open source Elasticsearch, and X-Pack.

This plugin can check thresholds on saved searches from Elasticsearch by querying the Elasticsearch REST API for information.

Checks Elasticsearch query total documents. It is designed to work with Energy Logserver, OP5 Log Analytics, open source Elasticsearch, and X-Pack.

This plugin can check thresholds on saved searches from Elasticsearch by querying the Elasticsearch REST API for information.

Checks the age and size of a file. It can also be used to monitor the number of files of a specific type in a folder.

For example, by making sure a specific file does not get too large, this plugin is checking the age and size of files and the number of files in folders.

Checks available FLEXlm licence managers.

In order not to run out of available licences by using the lmstat program.

Checks a list of hosts over ICMP to check if they are alive or not.

This plugin can be used to monitor a set of hosts to monitor if they are alive or not by using the fping command to ping the specified host(s) for a fast check.

Checks the status of an FTP server.

This plugin ensures the FTP server is working by connecting to the FTP server and checking for a correct response. You can also set thresholds on response time.

Checks status of a host.

This plugin canverify that the host is alive by using ICMP.

Checks status of a web server

This plugin can get the status of your web servers. In addition, this plugin also enables you to check a lot of different things on a web server, including response time, HTTP, HTTPS, specific URLs, match strings on a page, different ports, validity of SSL certificates, and more. You can also use it to validate certificates on mail servers.

Monitors JSON queries.

This generic plugin for Nagios checks JSON values from a given HTTP endpoint against argument-specified rules and determines the status and performance data for that service.

You must import the new check command in order to use this plugin. To do this, see Import commands in Manage commands.

Checks RTA and packet loss using ICMP.

This plugin can see status and reachability on your network by checking connectivity on the network using ICMP. It lets you specify thresholds for RTA and loss, and also how many packets to send, packetsize, TTL, interval between packets, and timeout.

Checks a local hard drive with a Linux specific smart interface.

This plugin can get control over the local hard drives on your server by checking the local hard drive with ioctl.

Checks for errors on a network interface.

Use this plugin to be notified of and locate network problems by using SNMP. You can specify thresholds on the amount of errors.

Checks the operational status of a network interface.

This plugin can monitor the status of a network port by using SNMP.

Checks connectivity to an IMAP server.

This plugin can monitor the status of an IMAP mail server by connecting to the IMAP server. You can send IMAP commands to the server and specify the expected response. You can also set thresholds on response time.

Support for monitoring Kubernetes clusters.

This plugin ensures that Kubernetes clusters are working as expected by getting conditions and other health data over HTTP.

You can use the --ignore command line option to the check_k8s plugin to exclude specified resource names from the check result. The --ignore option takes a regular expression (regex) as an input which will be compared to the Kubernetes resource names (node, deployments, and pods) to determine which resources will be excluded from the check results. For more information on the supported regex, please see Python's regular expression operations.

You can also use the --version command line option to display the script name and current version of the plugin.

Not platform dependent

Tests connections to an LDAP server.

This plugin ensures the LDAP server is working. This can be used to check, for example, Windows Active Directory Servers.

By connecting to the LDAP server, you can specify protocol version, password, and different search criteria. You can also set thresholds on response time.

Tests connections to LDAPS server.

This plugin ensures that the LDAPS server is working. This can be used to check, for example, Windows Active Directory servers.

By connecting to the LDAPS server, you can specify protocol version, password, and different search criteria. You can also set thresholds on response time.

Checks system load on a Unix server.

This plugin can check for problems with the capacity of a server, to determine if and when you need to upgrade.

By checking the number of jobs in the processor queue. A load of 1 means that the processor always has one job in the queue on a single processor system. The plugin lets you specify thresholds on load values.

Checks log files on the Unix system.

This plugin scans a specific log file for a specific pattern, as specified by options. Successive calls to the plugin script only report new pattern matches in the log file, since a copy of the log file from the previous run is saved.

Checks the number of mails in a mail queue in the Unix mail systems.

This plugin can identify problems with the mail system by searching through mailq and lets you specify minimum and maximum allowed mails in the queue. Supports Sendmail, qmail, PostFix and Exim.

check_mssql_health_batch-requests, check_mssql_health_checkpoint-pages, check_mssql_health_connected-users, check_mssql_health_cpu-busy, check_mssql_health_database-backup-age, check_mssql_health_database-backup-age_all, check_mssql_health_database-datafile-auto-growths, check_mssql_health_database-datafile-auto-growths_all, check_mssql_health_database-datafile-auto-shrinks, check_mssql_health_database-datafile-auto-shrinks_all, check_mssql_health_database-file-auto-growths, check_mssql_health_database-file-auto-growths_all, check_mssql_health_database-file-auto-shrinks, check_mssql_health_database-file-auto-shrinks_all, check_mssql_health_database-file-dbcc-shrinks, check_mssql_health_database-file-dbcc-shrinks_all, check_mssql_health_database-free, check_mssql_health_database-free_all, check_mssql_health_database-logbackup-age, check_mssql_health_database-logbackup-age_all, check_mssql_health_database-logfile-auto-growths, check_mssql_health_database-logfile-auto-growths_all, check_mssql_health_database-logfile-auto-shrinks, check_mssql_health_database-logfile-auto-shrinks_all, check_mssql_health_database-online, check_mssql_health_database-online_all, check_mssql_health_failed-jobs, check_mssql_health_free-list-stalls, check_mssql_health_full-scans, check_mssql_health_io-busy, check_mssql_health_latches-wait-time, check_mssql_health_latches-waits, check_mssql_health_lazy-writes, check_mssql_health_list-databases, check_mssql_health_list-datafiles, check_mssql_health_list-locks, check_mssql_health_locks-deadlocks, check_mssql_health_locks-timeouts, check_mssql_health_locks-waits, check_mssql_health_mem-pool-data-buffer-hit-ratio, check_mssql_health_page-life-expectancy, check_mssql_health_sql-initcompilations, check_mssql_health_sql-recompilations, check_mssql_health_sql-runtime, check_mssql_health_sql, check_mssql_health_total-server-memory, check_mssql_health_transactions, check_mssql_health_transactions_all

Checks Microsoft SQL servers.

This plugin can check the status of Microsoft SQL servers by connecting to a Microsoft SQL database and checks if it is accepting connections. This also allows you to specify a database, user name, and password. It can also accept a query and thresholds for the number of rows that the query can return.

Tests a MySQL server or database.

This plugin can catch problems with MySQL database servers or specific database by connecting to a MySQL server and checking status. This also lets you specify username, password and database to connect to

Tests various parameters of a MySQL database. You can also use custom SQL queries that return a single number.

This plugin can identify problems with MySQL database servers or specific databases. This can also be used to monitor the data you have in your databases by connecting to a MySQL server and checks the status mainly, using the MySQL show status command.

This program checks a query result against threshold levels.
This plugin allows you to send custom queries to a MySQL database by sending an SQL query and make sure it returns a numeric value.

Checks the status of the Nagios process on the local machine.

Use this plugin so you will be notified if there are any problems with your OP5 Monitor Nagios service.

Checks to make sure the Nagios status log is no older than the number of minutes specified by the expires option. It also checks the process table for a process matching the command argument.

Checks remote servers running agents compatible with NRPE.

This plugin can check the status of remote Unix hosts by running plugins on remote Unix servers running NRPE. You can use check_nrpe to run all plugins that normally only check statuses on a local server. You can also run checks to test the network from a remote server instead of from the OP5 Monitor server. What you can check is configured in the nrpe.cfg configuration file on the remote server and the set of plugins on the remote server.

Checks remote servers running agents compatible with NRPE versions 2, 3, and 4.

This plugin can check the status of remote Unix hosts by running plugins on remote Unix servers running NRPE. You can use check_nrpe4 to run all plugins that normally only check statuses on a local server. You can also run checks to test the network from a remote server instead of from the OP5 Monitor server. What you can check is configured in the nrpe.cfg configuration file on the remote server and the set of plugins on the remote server.

Checks remote Windows servers running NSClient++.

To monitor the status of your Windows servers. This plugin Connects to the NSClient++ service and retrieves the following information: CPU usage, memory usage, swap usage, disk usage, process status, service status. It also allows you to run queries against performance counters.

Checks the health of an NTP server.
Check the health of an ntp server.

To make sure the NTP server is in sync with its peers. This plugin checks the health of an NTP server and allows you to set thresholds on accepted offset, jitter, and stratum.

Checks the clock offset between the local host and a remote NTP server.

To keep track of server clocks. This plugin connects to an NTP server and compares the NTP clock to the local clock and lets you set thresholds on accepted offset.

Allows you to monitor OP5 Monitor list view filters. The plugin counts the number of hits you get from a filter you provide. It is mainly to be used for monitoring logserver filters in OP5 Monitor, but can be used for other types of list views as well.

To monitor the content of log data sent to the OP5 Monitor logserver extension. The plugin connects to the OP5 Monitor API and queries the filter provided as the plugin argument.

Checks the backup process state.

To notify you about latest backup process state. This plugin checks the latest backup log.

This is a collection of commands to be used to monitor your OP5 Monitor server.

The commands included to get an overall picture of your OP5 Monitor server. All commands use NRPE. If you are running a peered solution, you need to check the correct OP5 Monitor server no matter which peer is executing the check.

Checks the status of an Oracle database.

To monitor the status of your Oracle databases.

Checks the status of a Postgresql database.

Keep track of the status of your Postgresql databases. This plugin connects to a Postgresql database and checks if it is accepting connections. You can specify database, user name, and password and also to set thresholds on response times.

Checks a number of given hosts to see if they are alive.

To test the connectivity to a number of hosts at the same time. This plugin checks over ICMP and if any of the hosts are down the result is critical.

Checks the status of a POP3 server.

To see the status of your POP3 servers. This plugin connects to a POP3 server and checks the status.

check_procs_local, check_procs_local_limits_with_args

Checks the status of processes.

To test important applications are running.
This plugin checks the number of running processes. Lets you configure thresholds for the number of processes allowed to run. You can also check for a specific process, processes of a specific user, and different process states.

Checks the status of a radius server.

To ensure that your radius server is working. This plugin simulates a connection from a NAS to a radius server and lets you specify user name, password, and NAS identifier. You can also specify the expected response and timeout.

Checks hardware status.

Gives you a knowledge of the hardware status, temperature, and so on. This plugin checks status of your local hardware using the lm-sensors package.

Tests SIMAP connections with the specified host (or Unix socket).

To monitor the status of an IMAP mail server. This plugin connects to a secure IMAP server and checks the status.

Checks status of an SMTP server.

To see the status of your SMTP mail server. This plugin connects to an SMTP server and checks the status and allows you to specify expected response string. You can also run commands and specify thresholds on response times.

Checks devices that support SNMP.

To get the status of devices that support SNMP. This plugin obtains the status using the SNMP protocol.

The plugin supports version 1, 2c, and 3. You need to specify version, community, or username/password and OID to poll. You can set thresholds on numeric ranges or match for specific strings. This is a very flexible plugin and can be used for almost anything with SNMP support.

Checks interface traffic, status, and errors using SNMP.

To be notified if, for example, you suddenly have strange patterns on your network, which may indicate a virus attack.
This plugin polls traffic, status, and error usage on an SNMP enabled network device, for example a router or a switch. The plugin allows you to specify threshold values.

Checks the status of a POP3 server.

To check the status of your secure POP3 server. This plugin connects to a secure POP3 server and checks the status.

Checks an SSH server.

Checks the status of your SSH servers. This plugin connects to an SSH server and checks for an expected response. This also allows you to specify what version to check for and also set thresholds on response time.

Checks status of a secure SMTP server.

To monitor the status of your secure SMTP mail server. This plugin connects to a secure SMTP server and checks the status. Allows you to specify an expected response string. You can also run a command and specify thresholds on response time.

Checks swap usage.

To ensure sure you are notified if the server is using too much swap space. The swap is checked on the local machine. How this is done depends on what operating system the plugin is executed on.

Tests connection to a TCP port.

Checks the status of different applications that are listening on a TCP port. This plugin connects to a specified TCP port and checks the connection. Lets you specify a port number, send and expect a string and also set thresholds on response time.

Checks the time on a host running timeserver.

To check that the time is correct on remote systems. This plugin connects to a host that is running timeserver on port 37. Allow you to set the accepted variance between the remote host and the local clock.

Checks the amount of traffic on a network port.

To be notified if, for example, you suddenly have strange traffic patterns in you network, indicating a possible virus attack. This plugin polls traffic usage on an SNMP enabled network device, for example, a router or a switch. The plugin also allows you specify to threshold values for traffic usage.

Tests connection to a UDP port.

To check the status of applications that listen on a UDP port. This plugin connects to a specified UDP port and checks the connection. This also allows you to specify port number, send and expect string and also to set thresholds on response time.

Checks SNMP enabled UPSs

To automatically monitor the status of your UPSs and be notified in case of an outage. This plugin checks status on UPSs. You can also check battery status, temperature, and battery load, among other things.

Checks the number of logged-in users.

To keep track of the number of users logged on to a system. if too many are logged on, it could be a sign your system was hacked, for example. This plugin checks for the number of users that are logged on to the system, with threshold values indicating the acceptable number.

Checks the status of VMware vSphere infrastructure.

The plugin can be used to monitor the infrastructure managed by a VMware vCenter server or a VMware ESXi server, such as its data centres, clusters, hosts, and virtual machines. It can check a large range of different metrics and statuses, depending on the targeted infrastructure; for example CPU load, memory usage, network activity, and runtime states.

The plugin also requires a separate service to run on the OP5 Monitor host. The plugin talks to the service which in turn talks to the target vSphere API server. The plugin service uses the pyVmomi vSphere API Python bindings from VMware to talk to the VMware vSphere infrastructure.

VMware vSphere infrastructure: VMware vCenter and VMware ESX and ESXi hypervisor hosts.

The plugin uses pyVmomi 6.7.1, which means that it fully supports vSphere 6.7.1, 6.7, 6.5 and 6.0.

Checks the status of Windows servers using WMI (agent-less).

The plugin queries the status of Windows servers using the WMI API.

Checks for available updates using the command yum check-updates.

To ensure sure you do not miss important updates on any Red Hat or CentOS Linux system that uses yum as a package manager. This plugin uses the yum command to get the number of new packages available for installation.

Negates the result of a plugin.

For example, if you want to check that it is not possible to connect to a specific TCP port, you can use check_tcp, which will return critical as long as the port is closed. Negate converts that response to OK.

The plugin needs to be used with other plugins, and negates the check result.

Beginning OP5 Monitor 9.1, the negate plugin has been updated to only accept commands and scripts to execute from the plugin path /opt/plugin/. This change may break the existing configurations if this plugin is used to execute applications and scripts outside the /opt/plugin/ path.