OP5 Monitor ["OP5 Monitor"]
["Technical Reference"]

Plugin reference

Overview

Listed below are all the plugins included with standard OP5 Monitor distributions. The Slim Poller does not include all of the plugins in the list.

You can extend the functionality of both standard OP5 Monitor installations and Slim Poller installations by installing custom plugins. For more information, see Custom plugins.

Note: If you have upgraded from an earlier version of OP5 Monitor or installed custom plugins, you may have additional plugins in your OP5 Monitor instance.

check_apt

Commands check_apt
Description

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.

Supported platforms Debian GNU/Linux and Ubuntu systems
Categories Operating systems
Support level Level 4 (high and fully supported)
Tags debian, ubuntu, system packages, apt

check_aws

Commands check_aws
Description

Naemon plugin for monitoring AWS using CloudWatch.

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

Supported platforms Not platform dependent
Categories Misc, AWS
Support level Level 4 (high and fully supported)
Tags AWS, CloudWatch
   

This plugin is available on GitHubITRS-Group/check_aws. For guidance in using the check_aws plugin, see check_aws plugin.

check_by_snmp_cpu

Commands

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

Description

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.

Supported platforms Unix/Linux
Categories SNMP, CPU
Support level Level 5 (medium and bug support)
Tags unix, linux, snmp, net-snmp, cpu, iowait

check_by_snmp_disk

Commands check_by_snmp_disk_list_available_disks_v2, check_by_snmp_disk_used_v2, check_by_snmp_disk_list_available_disks_v3, check_by_snmp_disk_used_v3, check_by_snmp_disk_custom
Description

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.

Supported platforms Unix/Linux
Categories SNMP, File System
Support level Level 5 (medium and bug support)
Tags unix, linux, snmp, net-snmp, storage, disk, hardware

check_by_snmp_disk_io

Commands check_by_snmp_disk_io_list_available_disks_v2, check_by_snmp_disk_io_nread_v2, check_by_snmp_disk_io_nwritten_v2, check_by_snmp_disk_io_reads_v2, check_by_snmp_disk_io_writes_v2, check_by_snmp_disk_io_load_v2, check_by_snmp_disk_io_list_available_disks_v3, check_by_snmp_disk_io_nread_v3, check_by_snmp_disk_io_nwritten_v3, check_by_snmp_disk_io_reads_v3, check_by_snmp_disk_io_writes_v3, check_by_snmp_disk_io_load_v3, check_by_snmp_disk_io_custom
Description

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.

Supported platforms Unix/Linux
Categories SNMP, File System
Support level Level 5 (medium and bug support)
Tags unix, linux, snmp, net-snmp, disk, io, hardware

check_by_snmp_extend

Commands check_by_snmp_extend_v2, check_by_snmp_extend_v3, check_by_snmp_extend_custom
Description

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.

Supported platforms Unix/Linux
Categories SNMP
Support level Level 5 (medium and bug support)
Tags unix, linux, snmp, net-snmp, process, processes

check_by_snmp_load_avg

Commands check_by_snmp_load_avg_v2, check_by_snmp_load_avg_v3, check_by_snmp_load_avg_custom
Description

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.

Supported platforms Unix/Linux
Categories SNMP, CPU
Support level Level 5 (medium and bug support)
Tags unix, linux, snmp, net-snmp, cpu, load

check_by_snmp_memory

Commands check_by_snmp_memory_ram_used_v2, check_by_snmp_memory_swap_used_v2, check_by_snmp_memory_ram_used_v3, check_by_snmp_memory_swap_used_v3, check_by_snmp_memory_custom
Description

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.

Supported platforms Unix/Linux
Categories SNMP, memory
Support level Level 5 (medium and bug support)
Tags unix, linux, snmp, net-snmp, memory, swap, buffer, cached

check_by_snmp_procs

Commands check_by_snmp_procs_total_number_of_processes_v2, check_by_snmp_procs_total_number_of_zombie_processes_v2, check_by_snmp_procs_process_by_name_v2, check_by_snmp_procs_cron_v2, check_by_snmp_procs_syslog_v2, check_by_snmp_procs_total_number_of_processes_v3, check_by_snmp_procs_total_number_of_zombie_processes_v3, check_by_snmp_procs_process_by_name_v3, check_by_snmp_procs_cron_v3, check_by_snmp_procs_syslog_v3, check_by_snmp_procs_custom
Description

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.

Supported platforms Unix/Linux
Categories SNMP
Support level Level 5 (medium and bug support)
Tags unix, linux, snmp, net-snmp, process, processes

check_by_ssh

Commands check_by_ssh
Description

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.

Supported platforms Not platform dependent
Categories Misc
Support level Level 4 (high and fully supported)
Tags linux, unix, ssh, os

check_clamd

Commands check_clamd
Description

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.

Supported platforms Any host running clamd
Categories Misc
Support level Level 5 (medium and bug support)
Tags antivirus, clamd

check_cluster

Commands check_cluster
Description

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.

Supported platforms Not platform dependent
Categories Misc
Support level Level 5 (medium and bug support)
Tags clustered services, OP5 Monitor

check_dhcp

Commands check_dhcp
Description

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.

Supported platforms Not platform dependent
Categories Networking
Support level Level 4 (high and fully supported)
Tags dhcp, network, ip address

check_dig

Commands check_dig
Description

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.

Supported platforms Not platform dependent
Categories DNS
Support level Level 4 (high and fully supported)
Tags dns, domain name, hostname, resolve

check_disk

Commands

check_disk_of_backup_share, check_disk_custom, check_disk_local_mb

Description

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.

Supported platforms Unix
Categories File system
Support level Level 4 (high and fully supported)
Tags linux, unix, file system, disk

check_disk_smb

Commands check_disk_smb
Description

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.

Supported platforms Not platform dependent
Categories File system
Support level Level 4 (high and fully supported)
Tags microsoft windows, linux, samba, smb, disk

check_dns

Commands check_dns
Description

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.

Supported platforms Not platform dependent
Categories DNS
Support level Level 4 (high and fully supported)
Tags dns, domain names, resolve

check_docker

Commands check_docker_cpu, check_docker_memory, check_docker_status, check_docker_health, check_docker_uptime, check_docker_image_age, check_docker_restarts
Description

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.

Supported platforms

Not platform dependent

Categories Containerisation
Support Level Level 6 (low and best effort)
Tags docker

check_dummy

Commands check_dummy
Description

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.

Supported platforms Not platform dependent
Categories Misc
Support level Level 4 (high and fully supported)
Tags dummy

check_elasticquery

Commands check_elasticquery
Description

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.

Supported platforms Elasticsearch 6
Categories Logs
Support level Level 4 (high and fully supported)
Tags logs, loganalytics

check_elasticquery_7x

Commands check_elasticquery_7x
Description

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.

Supported platforms Elasticsearch 7
Categories Logs
Support level Level 4 (high and fully supported)
Tags logs, loganalytics

check_file

Commands check_sms_failed (sms)
Description

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.

Supported platforms Unix/Linux
Categories File System
Support level Level 5 (medium and bug support)
Tags unix, linux, file, file system

check_flexlm

Commands check_flexlm
Description

Checks available FLEXlm licence managers.

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

Supported platforms Unix
Categories Misc
Support level Level 5 (medium and bug support)
Tags unix, lmstat, flexlm license

check_fping

Commands check_fping
Description

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.

Supported platforms Not platform dependent
Categories Networking
Support level Level 4 (high and fully supported)
Tags Icmp, ping, host

check_ftp

Commands check_ftp
Description

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.

Supported platforms Not platform dependent
Categories Networking
Support level Level 4 (high and fully supported)
Tags ftp, tcp

check_host

Commands check-host-alive
Description

Checks status of a host.

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

Supported platforms Not platform dependent
Categories Networking
Support level Level 4 (high and fully supported)
Tags host, icmp, network

check_http

Commands check_http, check_https, check_https_auth, check_https_auth_url, check_https_certificate, check_https_port, check_https_port_url, check_https_timeout, check_https_timeout_url, check_https_url, check_https_url_regex, check_https_url_string, check_https_vhost, check_https_vhost_certificate, check_https_vhost_url_string, check_http_auth, check_http_auth_url, check_http_port, check_http_port_url, check_http_timeout, check_http_timeout_url, check_http_url, check_http_url_regex, check_http_url_string, check_http_vhost, check_http_vhost_url_string
Description

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.

Supported platforms Not platform dependent
Categories Networking, Web
Support level Level 4 (high and fully supported)
Tags http, web, https, ssl, url

check_icmp

Commands check-host-alive-icmp, check_ping, check_ping_critical, check_ping_normal
Description

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.

Supported platforms Not platform dependent
Categories Networking
Support level Level 4 (high and fully supported)
Tags host, icmp, ping, packet loss, rta

check_ide_smart

Commands check_ide_smart
Description

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.

Supported platforms Linux host with the smart interface installed
Categories Hardware
Support level Level 5 (medium and bug support)
Tags hardware, storage, ide, smart, linux

check_iferrors

Commands check_iferrors
Description

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.

Supported platforms Not platform dependent
Categories Networking
Support level Level 5 (medium and bug support)
Tags network, interface errors, snmp

check_ifoperstatus

Commands check_ifoperstatus
Description

Checks the operational status of a network interface.

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

Supported platforms Not platform dependent
Categories Networking
Support level Level 4 (high and fully supported)
Tags switch, router, network, interface status, snmp

check_imap

Commands check_imap
Description

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.

Supported platforms Not platform dependent
Categories Mail
Support level Level 4 (high and fully supported)
Tags email, imap

check_k8s

Commands check_k8s_nodes, check_k8s_pods, check_k8s_deployments
Description

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.

Supported platforms

Not platform dependent

Categories Containerisation
Support Level Introduction to plugins
Tags kubernetes

check_ldap

Commands check_ldap
Description

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.

Supported platforms Not platform dependent
Categories Misc
Support level Level 4 (high and fully supported)
Tags ldap

check_ldaps

Commands check_ldaps
Description

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.

Supported platforms Not platform dependent
Categories Misc
Support level Level 4 (high and fully supported)
Tags ldap, secure ldap

check_load

Commands check_load
Description

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.

Supported platforms Unix
Categories CPU
Support level Level 4 (high and fully supported)
Tags unix, linux, cpu, load

check_log

Commands check_log, check_log_eventlog, check_log_snmptraps, check_log_syslog
Description

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.

Supported platforms Unix
Categories Logs
Support level Level 5 (medium and bug support)
Tags linux, unix, logs

check_mailq

Commands check_mailq
Description

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.

Supported platforms Unix
Categories Mail
Support Level Level 5 (medium and bug support)
Tags email, local mail queue, sendmail, qmail, postfix, exim, unix, linux

check_mssql_health

Commands

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

Description

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.

Supported platforms Windows, Azure, Docker, Linux
Categories Databases
Support Level Level 5 (medium and bug support)
Tags microsoft windows, sql server, database

check_mysql

Commands check_mysql
Description

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

Supported platforms Not platform dependent
Categories Databases
Support level Level 6 (low and best effort)
Tags mysql, database
   

check_mysql_health

Commands check_mysql_health_connection-time, check_mysql_health_uptime, check_mysql_health_threads-connected, check_mysql_health_threadcache-hitrate, check_mysql_health_threads-created, check_mysql_health_threads-running, check_mysql_health_threads-cached, check_mysql_health_connects-aborted, check_mysql_health_clients-aborted, check_mysql_health_slave-lag, check_mysql_health_slave-io-running, check_mysql_health_slave-sql-running, check_mysql_health_qcache-hitrate, check_mysql_health_qcache-lowmem-prunes, check_mysql_health_myisam_keycache-hitrate, check_mysql_health_innodb_bufferpool-hitrate, check_mysql_health_innodb_bufferpool-wait-free, check_mysql_health_innodb_log-waits, check_mysql_health_tablecache-hitrate, check_mysql_health_table-lock-contention, check_mysql_health_index-usage, check_mysql_health_tmp-disk-tables, check_mysql_health_table-fragmentation_all, check_mysql_health_table-fragmentation, check_mysql_health_open-files, check_mysql_health_slow-queries, check_mysql_health_long-running-procs, check_mysql_health_cluster-ndbd-running, check_mysql_health_sql_query, check_mysql_health_sql_query_custom_units
Description

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.

Supported platforms Not platform dependent
Categories Databases
Support Level Level 5 (medium and bug support)
Tags mysql, database

check_mysql_query

Commands check_mysql_query
Description

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.

Supported platforms Anything that can run a MySQL server
Categories Databases
Support Level Level 6 (low and best effort)
Tags mysql, database, sql query

check_nagios

Commands check_nagios
Description

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.

Supported platforms Unix server running OP5 Monitor Nagios
Categories Misc
Support Level Level 4 (high and fully supported)
Tags unix, linux, nagios, op5 monitor core

check_nrpe

Commands check_nrpe, check_nrpe_win_services, check_nrpe_win_counter, check_nrpe_win_cpu, check_nrpe_win_drivesize, check_nrpe_win_eventlog, check_nrpe_win_ram, check_nrpe_win_swap, check_nrpe_win_uptime, check_mssql_buffer_cache_hit_ratio, check_nrpe_win_process
Description

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.

Supported platforms NRPE
Categories Misc
Support Level Level 6 (low and best effort)
Tags nrpe, unix, linux

check_nrpe4

Commands check_nrpe4, check_nrpe_disk_root, check_nrpe_disk_var, check_nrpe_load, check_nrpe_proc_crond, check_nrpe_proc_named, check_nrpe_proc_syslogd, check_nrpe_proc_total, check_nrpe_proc_zombie, check_nrpe_swap, check_nrpe_users
Description

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.

Supported platforms NRPE
Categories Misc
Support Level Level 5 (medium and bug support)
Tags nrpe, unix, linux

For guidance in using the check_nrpe4 plugin, see Nagios Remote plugin Executor (NRPE) plugin version 4.

check_nt

Commands check-host-alive-nsclient, check_nt_clientversion, check_nt_cpuload, check_nt_disk, check_nt_memuse, check_nt_pagingfile, check_nt_process, check_nt_service, check_nt_uptime, check_mssql_db_file_size, check_mssql_log_file_size, check_nt_memory_page_per_sec, check_nt_physical_disk_time, check_mssql_cache_hit_ratio, check_mssql_num_deadlocks, check_mssql_num_user_connections, check_perf_phys_disk_time, check_perf_avg_disk_queue_length, check_perf_io_read, check_perf_io_write, check_perf_memory_pages_per_sec, check_perf_proc_elapsed_time, check_perf_proc_id_process, check_perf_proc_pagefile_bytes, check_perf_proc_page_faults, check_perf_proc_pool_nonpaged_bytes, check_perf_proc_pool_paged_bytes, check_perf_proc_priority_base, check_perf_proc_private_bytes, check_perf_proc_thread_count, check_perf_proc_virtual_bytes, check_perf_terminal_active_sessions, check_perf_terminal_inactive_sessions, check_perf_terminal_total_sessions
Description

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.

Supported platforms Windows
Categories Operating systems
Support Level Level 6 (low and best effort)
Tags microsoft windows, nsclient

check_ntp_peer

Commands check_ntp_server, check_ntp_stratum
Description

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.

Supported platforms Not platform dependent
Support Level Level 6 (low and best effort)
Tags ntp, time

check_ntp_time

Commands check_ntp_time
Description

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.

Supported platforms Not platform dependent
Support Level Level 4 (high and fully supported)
Tags ntp, time

check_op5_filter

Commands check_op5_listview_filter, check_op5_listview_filter_auth_file, check_op5_listview_filter_custom_status_label, check_op5_listview_filter_custom_status_label_auth_file, check_op5_listview_log_messages_filter, check_op5_listview_log_messages_filter_msg_last_servicecheck, check_op5_listview_log_messages_filter_auth_file, check_op5_listview_log_messages_filter_custom_host, check_op5_listview_log_messages_filter_custom_host_auth_file
Description

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.

Supported platforms OP5 Monitor server
Support Level Level 5 (medium and bug support)
Tags op5, list view, filter, logserver

check_op5_license

Commands check_op5_license_monitor_percentage_left, check_op5_license_monitor_hosts_left, check_op5_license_monitor_days_left
Description Notifies you when your license expires.
Support Level Level 4 (high and fully supported)
Tags op5

check_op5backup2

Commands check_op5backup_state
Description

Checks the backup process state.

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

Supported platforms

Any server running OP5 Monitor
Categories Backup
Support Level Level 5 (medium and bug support)
Tags op5, backup

check_op5monitor

Commands checkmerlin_mysql, check_merlin_mysql_virt_mem_usage, check_merlin_process,, check_merlin_process_cpu_usage, check_merlin_process_virt_mem_usage, check_merlin_prog_status, check_monitor_core_files, check_monitor_distribution, check_monitor_failed_sms, check_monitor_hardware_ipmi, check_monitor_host_check_exec_time, check_monitor_host_check_orphans, check_monitor_host_latency, check_monitor_op5backup, check_monitor_pnp_graph_procs, check_monitor_processes, check_monitor_processes_cpu_usage, check_monitor_rrdcached_proc, check_monitor_service_check_exec_time, check_monitor_service_check_orphans, check_monitor_service_latency, check_monitor_smsd_procs, check_monitor_smsd_zombie_procs, check_monitor_spooled_checks, check_monitor_spooled_perfdata, check_monitor_tmp_disk, check_monitor_yum_update
Description

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.

Supported platforms Any server running OP5 Monitor
Categories OP5 Monitor servers
Support Level Level 5 (medium and bug support)
Tags op5 monitor

check_oracle

Commands check_oracle_dummy_login, check_oracle_login, check_oracle_cache_hit_ratio_all, check_oracle_query, check_oracle_query_regex
Description

Checks the status of an Oracle database.

To monitor the status of your Oracle databases.

Supported platforms Unix
Categories Databases
Support Level Level 6 (low and best effort)
Tags database, oracle

check_pgsql

Commands check_pgsql
Description

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.

Supported platforms Not platform dependent
Categories Databases
Support Level Level 5 (medium and bug support)
Tags postgresql, database

check_ping

Commands check_ping
Description

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.

Supported platforms Not platform dependent
Categories Networking
Support Level Level 4 (high and fully supported)
Tags icmp, ping, network

check_pop

Commands check_pop
Description

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.

Supported platforms Not platform dependent
Categories Mail
Support Level Level 4 (high and fully supported)
Tags email, pop, tcp

check_procs

Commands

check_procs_local, check_procs_local_limits_with_args

Description

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.

Supported platforms Unix
Categories Misc
Support Level Level 4 (high and fully supported)
Tags unix, linux, process, states

check_radius

Commands check_radius
Description

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.

Supported platforms Not platform dependent
Categories Networking
Support Level Level 5 (medium and bug support)
Tags radius, network

check_sensors

Commands check_sensors
Description

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.

Supported platforms Unix with lm-sensors installed
Categories Hardware
Support Level Level 5 (medium and bug support)
Tags lmsensor, hardware, temperature, unix, linux

check_simap

Commands check_simap
Description

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.

Supported platforms Not platform dependent
Categories Mail
Support Level Level 5 (medium and bug support)
Tags email, imap, secure imap, tcp

check_smtp

Commands check_smtp, check_smtp_time
Description

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.

Supported platforms Not platform dependent
Categories Mail
Support Level Level 4 (high and fully supported)
Tags email, smtp

check_snmp

Commands check_snmp (generic snmp), check_snmp_sysinfo (system information snmp), check_snmp_v2c, check_snmp_v3, check_snmp_v3_authnopriv, check_snmp_v3_authpriv
Description

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.

Supported platforms Not platform dependent
Categories SNMP
Support Level Level 4 (high and fully supported)
Tags snmp

check_snmpif

Commands check_traffic_bps_v1, check_traffic_bps_v2, check_traffic_bps_v3, check_traffic_bps_v1_snmpport, check_traffic_bps_v2_snmpport, check_traffic_bps_v3_snmpport, check_snmpif_errors_v1, check_snmpif_errors_v2, check_snmpif_errors_v3, check_snmpif_status_v1, check_snmpif_status_v2, check_snmpif_status_v3, check_iferrors_v1, check_iferrors_v2, check_iferrors_v3,, check_iferrors_v1_snmpport, check_iferrors_v2_snmpport, check_iferrors_v3_snmpport, check_ifoperstatus_v1, check_ifoperstatus_v2, check_ifoperstatus_v3
Description

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.

Supported platforms Not platform dependent
Categories Networking
Support Level Level 5 (medium and bug support)
Tags network, traffic, interface status, errors, snmp

check_spop

Commands check_spop
Description

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.

Supported platforms Not platform dependent
Categories Mail
Support Level Level 5 (medium and bug support)
Tags email, secure pop, tcp

check_ssh

Commands check_ssh
Description

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.

Supported platforms Not platform dependent
Categories Networking
Support Level Level 4 (high and fully supported)
Tags ssh, ssh connection, tcp

check_ssmtp

Commands check_ssmtp
Description

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.

Supported platforms Not platform dependent
Categories Mail
Support Level Level 4 (high and fully supported)
Tags email, smtp, secure smtp, tcp

check_swap

Commands check_swap
Description

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.

Supported platforms Unix/Linux
Categories File system
Support Level Level 4 (high and fully supported)
Tags operating system, os, unix, linux, swap, memory

check_tcp

Commands check-host-alive-http (host alive over tcp 80), check-host-alive-telnet (host alive over tcp 23), check_imap3, check_imaps, check_tcp (general tcp port), check_telnet (telnet port)
Description

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.

Supported platforms Not platform dependent
Categories Networking
Support Level Level 4 (high and fully supported)
Tags tcp, network, port

check_time

Commands check_time
Description

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.

Supported platforms Not platform dependent
Categories Misc
Support Level Level 4 (high and fully supported)
Tags time, ntp, timeserver

check_traffic

Commands check_traffic
Description

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.

Supported platforms Not platform dependent
Categories Networking
Support Level Level 5 (medium and bug support)
Tags network, snmp, router, switch

check_udp

Commands check_udp
Description

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.

Supported platforms Not platform dependent
Categories Networking
Support Level Level 4 (high and fully supported)
Tags network, udp

check_ups

Commands check_ups
Description

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.

Supported platforms UPS with RFC1628 SNMP support
Categories Hardware
Support Level Level 5 (medium and bug support)
Tags ups, rfc1628, snmp, hardware

check_users

Commands check_users
Description

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.

Supported platforms Unix
Categories Misc
Support Level Level 4 (high and fully supported)
Tags linux, unix, users, logged in

check_vmware_v2

Note: Beginning OP5 Monitor 8.3.3, the check_vmware_v2 plugin supports VMware vSphere API 7, while version 5.5 and earlier are no longer supported.

Commands check_vmware_v2_esxi_host, check_vmware_v2_esxi_host_no_ssl, check_vmware_v2_vcenter_host, check_vmware_v2_vcenter_host_no_ssl, check_vmware_v2_vcenter_vm, check_vmware_v2_vcenter_vm_no_ssl, check_vmware_v2_vcenter_cluster, check_vmware_v2_vcenter_cluster_no_ssl, check_vmware_v2_vcenter_datacenter, check_vmware_v2_vcenter_datacenter_no_ssl
Description

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.

Supported platforms

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.

Categories Operating systems
Support Level Level 4 (high and fully supported)
Tags vmware, vsphere, vcenter, esx, esxi
   

When you encounter unknown sensors issues when using the check_vmware_v2 plugin, you can add the -x or --ignore-result option for ignoring all results with a matching description. Both options are interchangeable, and you should only use one of them. This is useful for counters such as runtime.health that contain multiple results values. With this option, you can exclude any unreliable results preventing known unknowns from affecting the check result, and still get an OK end result.

In the example below, the --ignore-result "rdlab01-datastore" option will ignore a sub-result that would cause a warning by passing its description to the --ignore-result. If the option is not set, the system will report the status as unknown.

# ./test_check --host vcsa01.it.itrsent.local --host-system 172.16.20.21 vmfs.usage -vvv -w 65 --ignore-result "rdlab01-datastore"
CHECK_VMWARE OK - 1/5 ignored, 4/5 ok
ok: nfs-prd-flash: 22.71% (3500.05GB / 15412.88GB)
ok: datastore1: 34.11% (7.5GB / 22.0GB)
ok: nfs-prd-hdd: 63.78% (27360.59GB / 42896.64GB)
ok: Content Library DS: 22.71% (3500.05GB / 15412.88GB)
ignored: rdlab01-datastore: 69.51% (3106.46GB / 4469.0GB)
| 'Content Library DS'=22.71%;65 'nfs-prd-flash'=22.71%;65 'nfs-prd-hdd'=63.78%;65 'rdlab01-datastore'=69.51%;65 datastore1=34.11%;65

You can repeat these options to ignore multiple type of results. The --regex option does not affect --ignore-result.

check_wmi_plus

Commands check_wmip, check_wmip_io, check_wmip_filesize, check_wmip_fileage, check_wmip_disk, check_wmip_cpuq, check_wmip_cpu, check_wmip_cpudetail, check_wmip_network, check_wmip_service, check_wmip_uptime, check_wmip_mem, check_wmip_page, check_wmip_process, check_wmip_eventlog, check_wmip_ts, check_wmip_iis, check_wmip_exchange, check_wmip_sql, check_wmip_sql_express, check_wmip_proc, check_wmip_dns, check_wmip_dhcp, check_wmip_dhcpv6, check_wmip_print, check_wmip_users, check_wmip_power, check_wmip_ad
Description

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

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

Supported platforms Windows
Categories Operating systems
Support Level Level 5 (medium and bug support)
Tags microsoft windows, wmi, agent less, os

check_yum_update

Commands check_yum_update
Description

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.

Supported platforms Red Hat, CentOS
Categories Misc
Support Level Level 5 (medium and bug support)
Tags yum, os updates, redhat, centos

negate

Commands negate
Description

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.

Supported platforms Not platform dependent
Categories Misc
Support Level Level 4 (high and fully supported)
Tags negate result