diff --git a/docs/modules/reference/pages/configuration/core-docker.adoc b/docs/modules/reference/pages/configuration/core-docker.adoc index a5a60476048c..139ab4aa1e71 100644 --- a/docs/modules/reference/pages/configuration/core-docker.adoc +++ b/docs/modules/reference/pages/configuration/core-docker.adoc @@ -1,6 +1,6 @@ [[core-docker]] = Core Docker -:description: Learn about startup arguments and environment variables for the Docker with the {page-component-title} core. +:description: Learn about startup arguments and environment variables for the Docker with the OpenNMS {page-component-title} core. == Startup arguments diff --git a/docs/modules/reference/pages/configuration/file-editor.adoc b/docs/modules/reference/pages/configuration/file-editor.adoc index a2b1334f74dd..a0af12520ef1 100644 --- a/docs/modules/reference/pages/configuration/file-editor.adoc +++ b/docs/modules/reference/pages/configuration/file-editor.adoc @@ -1,7 +1,7 @@ [[file-editor]] = File Editor -:description: Learn how to use the File Editor in {page-component-title} to view and edit configuration (.xml, .cfg, etc.) files through the UI. +:description: Learn how to use the File Editor in OpenNMS {page-component-title} to view and edit configuration (.xml, .cfg, etc.) files through the UI. The File Editor page lets you view and edit configuration files (`.xml`, `.cfg`, `.drl`, and so on) in the {page-component-title} UI instead of having to edit them in your local file system (for example, by locating the file in your `/etc` directory and editing it with a text editor). To access the file editor, log in to the web UI and click menu:Info[File Editor] in the top menu bar. diff --git a/docs/modules/reference/pages/configuration/filters/components.adoc b/docs/modules/reference/pages/configuration/filters/components.adoc index aa8d3ebf98cd..7acc726b3c95 100644 --- a/docs/modules/reference/pages/configuration/filters/components.adoc +++ b/docs/modules/reference/pages/configuration/filters/components.adoc @@ -1,7 +1,7 @@ [[filter-components]] = OpenNMS components that use filters -:description: Get a list of the {page-component-title} components that use filters/rules: notfifd, collectd, pollerd, threshd, and the web UI. +:description: Get a list of the OpenNMS {page-component-title} components that use filters/rules: notfifd, collectd, pollerd, threshd, and the web UI. == notifd diff --git a/docs/modules/reference/pages/configuration/filters/filters.adoc b/docs/modules/reference/pages/configuration/filters/filters.adoc index 861c3412efd4..df08a2863209 100644 --- a/docs/modules/reference/pages/configuration/filters/filters.adoc +++ b/docs/modules/reference/pages/configuration/filters/filters.adoc @@ -1,7 +1,7 @@ [[filters]] = Filters -:description: Learn about the database schema file in {page-component-title} and how to use filters (rules) to select IP addresses from the ipinterface table. +:description: Learn about the database schema file in OpenNMS {page-component-title} and how to use filters (rules) to select IP addresses from the ipinterface table. A filter (also known as a rule) is a shorthand expression that allows you to select IP addresses from the ipinterface table. The rule builds the WHERE clause of a SQL query. diff --git a/docs/modules/reference/pages/configuration/filters/parameters.adoc b/docs/modules/reference/pages/configuration/filters/parameters.adoc index 3183d3989f62..63948f739237 100644 --- a/docs/modules/reference/pages/configuration/filters/parameters.adoc +++ b/docs/modules/reference/pages/configuration/filters/parameters.adoc @@ -1,7 +1,7 @@ [[filter-parameters]] = Parameters -:description: View a list of filter/rule parameters, grouped by component, in {page-component-title}. +:description: View a list of filter/rule parameters, grouped by component, in OpenNMS {page-component-title}. This is a partial list of rule parameters, grouped by component. You can add parameters not available in `database-schema.xml` for use in filter expressions as long as you follow the existing database table hierarchy. diff --git a/docs/modules/reference/pages/configuration/filters/rule-formats.adoc b/docs/modules/reference/pages/configuration/filters/rule-formats.adoc index 797c971c22dc..28c4b4a68809 100644 --- a/docs/modules/reference/pages/configuration/filters/rule-formats.adoc +++ b/docs/modules/reference/pages/configuration/filters/rule-formats.adoc @@ -1,7 +1,7 @@ [[filter-rule-format]] = Rule formats -:description: View the formats for filters/rules in {page-component-title}: CDATA construct, GUI construct, and catinc. +:description: View the formats for filters/rules in OpenNMS {page-component-title}: CDATA construct, GUI construct, and catinc. There are at least two formats for these rules in xml (GUI format follows). diff --git a/docs/modules/reference/pages/configuration/install-jdbc-driver.adoc b/docs/modules/reference/pages/configuration/install-jdbc-driver.adoc index 9a278e1d5306..cec02709b603 100644 --- a/docs/modules/reference/pages/configuration/install-jdbc-driver.adoc +++ b/docs/modules/reference/pages/configuration/install-jdbc-driver.adoc @@ -1,7 +1,7 @@ [[install-jdbc-driver-core]] = Install JDBC Driver on {page-component-title} Core -:description: Learn how to install a JDBC driver in {page-component-title} to detect, poll, or collect on JDBC services. +:description: Learn how to install a JDBC driver in OpenNMS {page-component-title} to detect, poll, or collect on JDBC services. To detect, poll, or collect any JDBC service, you must install the appropriate JDBC driver. diff --git a/docs/modules/reference/pages/configuration/minion-confd/jmx-exporter.adoc b/docs/modules/reference/pages/configuration/minion-confd/jmx-exporter.adoc index b08f2ec1dfd1..b8a1485f5f02 100644 --- a/docs/modules/reference/pages/configuration/minion-confd/jmx-exporter.adoc +++ b/docs/modules/reference/pages/configuration/minion-confd/jmx-exporter.adoc @@ -1,6 +1,6 @@ [[jmx-exporter]] = Prometheus JMX exporter -:description: Learn how to set up out-of-band monitoring of the Java virtual machine (JVM) with the Minion process in {page-component-title}. +:description: Learn how to set up out-of-band monitoring of the Java virtual machine (JVM) with the Minion process in OpenNMS {page-component-title}. To provide an out-of-band monitoring of the JVM with the Minion process, this container image ships with the Prometheus JMX exporter. The default configuration, which you can edit, appears in the `minion-config.yaml` file: diff --git a/docs/modules/reference/pages/configuration/minion-confd/minion-confd.adoc b/docs/modules/reference/pages/configuration/minion-confd/minion-confd.adoc index 8e499ab86d38..ef22dfcce8b9 100644 --- a/docs/modules/reference/pages/configuration/minion-confd/minion-confd.adoc +++ b/docs/modules/reference/pages/configuration/minion-confd/minion-confd.adoc @@ -1,7 +1,7 @@ [[minion-confd]] = Configuring Minion via confd -:description: Learn how to configure the Minion via confd in {page-component-title}: mount, YAML file contents, Kafka sink, and so on. +:description: Learn how to configure the Minion via confd in OpenNMS {page-component-title}: mount, YAML file contents, Kafka sink, and so on. For information on testing confd templates, see xref:configuration/minion-confd/test-confd.adoc#confd-template-test[Test confd templates]. diff --git a/docs/modules/reference/pages/configuration/minion-confd/test-confd.adoc b/docs/modules/reference/pages/configuration/minion-confd/test-confd.adoc index 553748969c91..2bd7a6f4b36b 100644 --- a/docs/modules/reference/pages/configuration/minion-confd/test-confd.adoc +++ b/docs/modules/reference/pages/configuration/minion-confd/test-confd.adoc @@ -1,7 +1,7 @@ [[confd-template-test]] = Test confd Templates -:description: Learn how to test confd template changes locally using a Minion Docker container in {page-component-title}. +:description: Learn how to test confd template changes locally using a Minion Docker container in OpenNMS {page-component-title}. To locally test `confd` template changes, run a Minion container and map the corresponding files into the container. The following procedure, which requires a Minion Docker container, might be useful: diff --git a/docs/modules/reference/pages/configuration/minion-docker.adoc b/docs/modules/reference/pages/configuration/minion-docker.adoc index 70731e94d91c..0a6df9dc919b 100644 --- a/docs/modules/reference/pages/configuration/minion-docker.adoc +++ b/docs/modules/reference/pages/configuration/minion-docker.adoc @@ -1,6 +1,6 @@ [[minion-docker]] = Minion Docker -:description: Learn about startup arguments and environment variables for the Docker with the {page-component-title} Minion. +:description: Learn about startup arguments and environment variables for the Docker with the OpenNMS {page-component-title} Minion. == Startup arguments diff --git a/docs/modules/reference/pages/configuration/receive-snmp-traps.adoc b/docs/modules/reference/pages/configuration/receive-snmp-traps.adoc index d6d3e45e632a..1ef124ed53b1 100644 --- a/docs/modules/reference/pages/configuration/receive-snmp-traps.adoc +++ b/docs/modules/reference/pages/configuration/receive-snmp-traps.adoc @@ -1,6 +1,6 @@ [[receive-snmp-traps]] = Receive SNMP traps/informs -:description: Learn about how to configure a policy that allows {page-component-title} to bind to the ICMP service with SELinux enabled on your OpenNMS server. +:description: Learn about how to configure a policy that lets OpenNMS {page-component-title} bind to the ICMP service with SELinux enabled on your OpenNMS server. {page-component-title} lets you receive and process SNMP traps and informs out of the box. The {page-component-title} services run as an unprivileged user and cannot bind on port numbers below `1024` without escalated privileges. diff --git a/docs/modules/reference/pages/configuration/selinux.adoc b/docs/modules/reference/pages/configuration/selinux.adoc index 805ce860d7ba..d839c7caaeff 100644 --- a/docs/modules/reference/pages/configuration/selinux.adoc +++ b/docs/modules/reference/pages/configuration/selinux.adoc @@ -1,6 +1,6 @@ [[selinux-icmp]] = SELinux and ICMP permissions -:description: Learn how to configure a policy that lets {page-component-title} bind to the ICMP service with SELinux enabled on your OpenNMS server. +:description: Learn how to configure a policy that lets OpenNMS {page-component-title} bind to the ICMP service with SELinux enabled on your OpenNMS server. If you have SELinux enabled on your {page-component-title} server, you must also configure a policy that allows {page-component-title} to bind to the ICMP service. diff --git a/docs/modules/reference/pages/configuration/sentinel-features.adoc b/docs/modules/reference/pages/configuration/sentinel-features.adoc index 948938da3600..ab9fbfe3c55f 100644 --- a/docs/modules/reference/pages/configuration/sentinel-features.adoc +++ b/docs/modules/reference/pages/configuration/sentinel-features.adoc @@ -1,5 +1,5 @@ = Sentinel Features -:description: Discover some of the Sentinel features you can install manually in {page-component-title}: core, Java Message Service (JMS), Kafka, flows, and so on. +:description: Discover some of the Sentinel features you can install manually in OpenNMS {page-component-title}: core, Java Message Service (JMS), Kafka, flows, and so on. The following list contains some features which may be installed manually: diff --git a/docs/modules/reference/pages/configuration/ttl-rpc.adoc b/docs/modules/reference/pages/configuration/ttl-rpc.adoc index 7f5a262632b5..639085a3cbcb 100644 --- a/docs/modules/reference/pages/configuration/ttl-rpc.adoc +++ b/docs/modules/reference/pages/configuration/ttl-rpc.adoc @@ -1,5 +1,5 @@ = Time to Live (TTL) for RPCs -:description: Learn about time-to-live (TTL) with remote procedure calls (RPCs) in {page-component-title}: global, pollerd, collectd, provisiond, and so on. +:description: Learn about time-to-live (TTL) with remote procedure calls (RPCs) in OpenNMS {page-component-title}: global, pollerd, collectd, provisiond, and so on. Remote procedure calls (RPCs) between {page-component-title} Core and Minion include a time limit which, if exceeded, aborts the requests and discards any subsequent responses. We call this limit the time-to-live or TTL. diff --git a/docs/modules/reference/pages/configuration/tuning-activemq.adoc b/docs/modules/reference/pages/configuration/tuning-activemq.adoc index 1a4e50535ced..3f30b59d2d39 100644 --- a/docs/modules/reference/pages/configuration/tuning-activemq.adoc +++ b/docs/modules/reference/pages/configuration/tuning-activemq.adoc @@ -1,5 +1,5 @@ = Tuning ActiveMQ -:description: Learn about default ActiveMQ settings in {page-component-title} and how to change them for better performance. +:description: Learn about default ActiveMQ settings in OpenNMS {page-component-title} and how to change them for better performance. The settings for the embedded ActiveMQ broker are found in `$\{OPENNMS_HOME}/etc/opennms-activemq.xml`. Memory and storage limits are conservative by default and should be tuned to accommodate your workload. diff --git a/docs/modules/reference/pages/configuration/tuning-kafka.adoc b/docs/modules/reference/pages/configuration/tuning-kafka.adoc index 669f5ee50cc1..80b4a2668a3f 100644 --- a/docs/modules/reference/pages/configuration/tuning-kafka.adoc +++ b/docs/modules/reference/pages/configuration/tuning-kafka.adoc @@ -1,5 +1,5 @@ = Tuning Apache Kafka -:description: Learn about default Kafka settings in {page-component-title} and how to change them to meet your system requirements, including multi-tenancy. +:description: Learn about default Kafka settings in OpenNMS {page-component-title} and how to change them to meet your system requirements, including multi-tenancy. The configuration is shipped with some defaults, but depending on the size and network topology you might need to tune the Apache Kafka environment to meet certain needs. Set Apache Kafka options directly in the `org.opennms.core.ipc.rpc.kafka.cfg` and `org.opennms.core.ipc.sink.kafka.cfg` file. diff --git a/docs/modules/reference/pages/daemons/daemon-config-files/event-translator.adoc b/docs/modules/reference/pages/daemons/daemon-config-files/event-translator.adoc index c3d03c2c7f06..bd0b5daeb16c 100644 --- a/docs/modules/reference/pages/daemons/daemon-config-files/event-translator.adoc +++ b/docs/modules/reference/pages/daemons/daemon-config-files/event-translator.adoc @@ -1,7 +1,7 @@ [[ref-daemon-event-translate]] = Event Translator -:description: Learn about the event translator, which transforms and enhances the data from {page-component-title} events that other daemons generate. +:description: Learn about the event translator, which transforms and enhances the data from OpenNMS {page-component-title} events that other daemons generate. The event translator transforms and enhances the data from {page-component-title} events that other daemons generate. It enables better integration with external systems, based on data from sources internal and external to {page-component-title}. diff --git a/docs/modules/reference/pages/daemons/daemon-config-files/eventd.adoc b/docs/modules/reference/pages/daemons/daemon-config-files/eventd.adoc index aa1795c5b6d8..b44a529b56c2 100644 --- a/docs/modules/reference/pages/daemons/daemon-config-files/eventd.adoc +++ b/docs/modules/reference/pages/daemons/daemon-config-files/eventd.adoc @@ -1,7 +1,7 @@ [[ref-daemon-config-files-eventd]] = Eventd -:description: Learn about eventd, a core {page-component-title} process that generates events. +:description: Learn about eventd, a core OpenNMS {page-component-title} process that generates events. Core {page-component-title} process that generates xref:operation:deep-dive/events/introduction.adoc[events]. diff --git a/docs/modules/reference/pages/daemons/daemon-config-files/jettyserver.adoc b/docs/modules/reference/pages/daemons/daemon-config-files/jettyserver.adoc index ebf12b33cf16..9a975dc1e28d 100644 --- a/docs/modules/reference/pages/daemons/daemon-config-files/jettyserver.adoc +++ b/docs/modules/reference/pages/daemons/daemon-config-files/jettyserver.adoc @@ -1,7 +1,7 @@ [[ref-daemon-config-files-jettyserver]] = JettyServer -:description: Learn about the JettyServer in {page-component-title}, which provides and manages the web user interface service. +:description: Learn about the JettyServer in OpenNMS {page-component-title}, which provides and manages the web user interface service. Provides and manages the web user interface service. diff --git a/docs/modules/reference/pages/daemons/daemon-config-files/karaf.adoc b/docs/modules/reference/pages/daemons/daemon-config-files/karaf.adoc index 72cca2310b96..58370ab92a7e 100644 --- a/docs/modules/reference/pages/daemons/daemon-config-files/karaf.adoc +++ b/docs/modules/reference/pages/daemons/daemon-config-files/karaf.adoc @@ -1,7 +1,7 @@ [[ref-daemon-config-files-karaf]] = Karaf -:description: Learn about the Karaf daemon, which is the core runtime module that manages all other daemon services within the {page-component-title} system. +:description: Learn about the Karaf daemon, which is the core runtime module that manages all other daemon services within the OpenNMS {page-component-title} system. The core runtime module that manages all other daemon services running within the {page-component-title} system. diff --git a/docs/modules/reference/pages/daemons/daemon-config-files/karafstartupmonitor.adoc b/docs/modules/reference/pages/daemons/daemon-config-files/karafstartupmonitor.adoc index e45f2f5b9da2..0a2aa46d8ea4 100644 --- a/docs/modules/reference/pages/daemons/daemon-config-files/karafstartupmonitor.adoc +++ b/docs/modules/reference/pages/daemons/daemon-config-files/karafstartupmonitor.adoc @@ -1,7 +1,7 @@ [[ref-daemon-config-files-karafstartupmonitor]] = KarafStartupMonitor -:description: Learn about the {page-component-title} KarafStartupMonitor, which tracks issues with starting the core Karaf runtime. +:description: Learn about the OpenNMS {page-component-title} KarafStartupMonitor, which tracks issues with starting the core Karaf runtime. Tracks issues with starting the core xref:reference:daemons/daemon-config-files/karaf.adoc[Karaf] runtime. diff --git a/docs/modules/reference/pages/daemons/daemon-config-files/notifd.adoc b/docs/modules/reference/pages/daemons/daemon-config-files/notifd.adoc index 6b09ddf3772d..bce818172b6f 100644 --- a/docs/modules/reference/pages/daemons/daemon-config-files/notifd.adoc +++ b/docs/modules/reference/pages/daemons/daemon-config-files/notifd.adoc @@ -1,7 +1,7 @@ [[ref-daemon-config-files-notifd]] = Notifd -:description: Learn about notifd in {page-component-title}, which generates notifications to system operators for desired events. +:description: Learn about notifd in OpenNMS {page-component-title}, which generates notifications to system operators for desired events. Generates xref:operation:deep-dive/notifications/introduction.adoc[notifications] to system operators for desired events. diff --git a/docs/modules/reference/pages/performance-data-collection/collectors/SnmpCollector.adoc b/docs/modules/reference/pages/performance-data-collection/collectors/SnmpCollector.adoc index 00f6d22a6260..81d1fbfa02bd 100644 --- a/docs/modules/reference/pages/performance-data-collection/collectors/SnmpCollector.adoc +++ b/docs/modules/reference/pages/performance-data-collection/collectors/SnmpCollector.adoc @@ -1,6 +1,6 @@ = SnmpCollector -:description: Learn how to configure the SNMPCollector in {page-component-title} to collect performance data through SNMP. +:description: Learn how to configure the SNMPCollector in OpenNMS {page-component-title} to collect performance data through SNMP. The SnmpCollector collects performance data through SNMP. Configure credentials to access SNMP agents in the Web UI (*Admin>Configure SNMP Community Names by IP Address*). diff --git a/docs/modules/reference/pages/performance-data-collection/collectors/http.adoc b/docs/modules/reference/pages/performance-data-collection/collectors/http.adoc index e15bc718cab6..ada7d95d6fe7 100644 --- a/docs/modules/reference/pages/performance-data-collection/collectors/http.adoc +++ b/docs/modules/reference/pages/performance-data-collection/collectors/http.adoc @@ -1,6 +1,6 @@ = HttpCollector -:description: Learn how to configure and use the HttpCollector in {page-component-title} to collect performance data via HTTP and HTTPS. +:description: Learn how to configure and use the HttpCollector in OpenNMS {page-component-title} to collect performance data via HTTP and HTTPS. The HttpCollector collects performance data via HTTP and HTTPS. Attributes are extracted from the HTTP responses using a regular expression. diff --git a/docs/modules/reference/pages/performance-data-collection/collectors/jdbc.adoc b/docs/modules/reference/pages/performance-data-collection/collectors/jdbc.adoc index a3296936b464..9590914cc83d 100644 --- a/docs/modules/reference/pages/performance-data-collection/collectors/jdbc.adoc +++ b/docs/modules/reference/pages/performance-data-collection/collectors/jdbc.adoc @@ -1,6 +1,6 @@ = JDBC Collector -:description: Learn how to configure and use the JDBCCollector in {page-component-title} to collect performance data via JDBC drivers. +:description: Learn how to configure and use the JDBCCollector in OpenNMS {page-component-title} to collect performance data via JDBC drivers. The JDBCCollector collects performance data via JDBC drivers. Attributes are retrieved using SQL queries. diff --git a/docs/modules/reference/pages/performance-data-collection/collectors/jmx.adoc b/docs/modules/reference/pages/performance-data-collection/collectors/jmx.adoc index f35d2e6be161..42e8a043af83 100644 --- a/docs/modules/reference/pages/performance-data-collection/collectors/jmx.adoc +++ b/docs/modules/reference/pages/performance-data-collection/collectors/jmx.adoc @@ -1,7 +1,7 @@ = JmxCollector -:description: Learn how to configure and use the JmxCollector in {page-component-title} to collect performance data via Java Management Extensions (JMX). +:description: Learn how to configure and use the JmxCollector in OpenNMS {page-component-title} to collect performance data via Java Management Extensions (JMX). The JmxCollector collects performance data via Java Management Extensions (JMX). Attributes are extracted from the available MBeans. diff --git a/docs/modules/reference/pages/performance-data-collection/collectors/nsclient.adoc b/docs/modules/reference/pages/performance-data-collection/collectors/nsclient.adoc index 2ecee8ecede3..3fce135383eb 100644 --- a/docs/modules/reference/pages/performance-data-collection/collectors/nsclient.adoc +++ b/docs/modules/reference/pages/performance-data-collection/collectors/nsclient.adoc @@ -1,6 +1,6 @@ = NSClientCollector -:description: Learn how to configure and use the NSClientCollector in {page-component-title} to collect performance data over HTTP from NSClient. +:description: Learn how to configure and use the NSClientCollector in OpenNMS {page-component-title} to collect performance data over HTTP from NSClient. The NSClientCollector collects performance data over HTTP from NSClient. diff --git a/docs/modules/reference/pages/performance-data-collection/collectors/prometheus.adoc b/docs/modules/reference/pages/performance-data-collection/collectors/prometheus.adoc index f4c0e2f896fb..3976397e5f48 100644 --- a/docs/modules/reference/pages/performance-data-collection/collectors/prometheus.adoc +++ b/docs/modules/reference/pages/performance-data-collection/collectors/prometheus.adoc @@ -1,7 +1,7 @@ [[ga-performance-mgmt-collectors-prometheus-collector]] = PrometheusCollector -:description: Learn how to configure the PrometheusCollector in {page-component-title} to collect performance data via HTTP(S) using the Prometheus Exposition format. +:description: Learn how to configure the PrometheusCollector in OpenNMS {page-component-title} to collect performance data via HTTP(S) using the Prometheus Exposition format. The PrometheusCollector collects performance metrics via HTTP(S) using the text-based https://github.com/prometheus/docs/blob/master/content/docs/instrumenting/exposition_formats.md#text-based-format[Prometheus Exposition format]. Many applications have adopted it and it is in the process of being standardized in the https://openmetrics.io/[OpenMetrics] project. diff --git a/docs/modules/reference/pages/performance-data-collection/collectors/tca.adoc b/docs/modules/reference/pages/performance-data-collection/collectors/tca.adoc index 1ca4abac47ce..2c520a76ddc1 100644 --- a/docs/modules/reference/pages/performance-data-collection/collectors/tca.adoc +++ b/docs/modules/reference/pages/performance-data-collection/collectors/tca.adoc @@ -1,6 +1,6 @@ = TcaCollector -:description: Learn how to configure the TcaCollector in {page-component-title} to collect special SNMP data from Juniper TCA devices. +:description: Learn how to configure the TcaCollector in OpenNMS {page-component-title} to collect special SNMP data from Juniper TCA devices. The TcaCollector collects special SNMP data from Juniper TCA devices. diff --git a/docs/modules/reference/pages/performance-data-collection/collectors/vmware-cim.adoc b/docs/modules/reference/pages/performance-data-collection/collectors/vmware-cim.adoc index c1d1a98be306..982986e72faa 100644 --- a/docs/modules/reference/pages/performance-data-collection/collectors/vmware-cim.adoc +++ b/docs/modules/reference/pages/performance-data-collection/collectors/vmware-cim.adoc @@ -1,6 +1,6 @@ = VmwareCimCollector -:description: Learn how to configure the VmwareCimCollector in {page-component-title} to collect ESXi host and sensor metrics from vCenter. +:description: Learn how to configure the VmwareCimCollector in OpenNMS {page-component-title} to collect ESXi host and sensor metrics from vCenter. The VmwareCimCollector collects ESXi host and sensor metrics from vCenter. diff --git a/docs/modules/reference/pages/performance-data-collection/collectors/vmware.adoc b/docs/modules/reference/pages/performance-data-collection/collectors/vmware.adoc index 09e6091e0cb5..dc78ce499b66 100644 --- a/docs/modules/reference/pages/performance-data-collection/collectors/vmware.adoc +++ b/docs/modules/reference/pages/performance-data-collection/collectors/vmware.adoc @@ -1,6 +1,6 @@ = VmwareCollector -:description: Learn how to configure the VmwareCollector in {page-component-title} to collect performance metrics from managed entities from vCenter. +:description: Learn how to configure the VmwareCollector in OpenNMS {page-component-title} to collect performance metrics from managed entities from vCenter. The VmwareCollector collects performance metrics for managed entities from vCenter. diff --git a/docs/modules/reference/pages/performance-data-collection/collectors/wmi.adoc b/docs/modules/reference/pages/performance-data-collection/collectors/wmi.adoc index 2786403c6054..35982cfb6c61 100644 --- a/docs/modules/reference/pages/performance-data-collection/collectors/wmi.adoc +++ b/docs/modules/reference/pages/performance-data-collection/collectors/wmi.adoc @@ -1,6 +1,6 @@ = WmiCollector -:description: Configure the WmiCollector in {page-component-title} to collect performance metrics from Windows systems using Windows Management Instrumentation (WMI). +:description: Configure the WmiCollector in OpenNMS {page-component-title} to collect performance metrics from Windows systems using Windows Management Instrumentation (WMI). The WmiCollector collects performance metrics from Windows systems using Windows Management Instrumentation (WMI). diff --git a/docs/modules/reference/pages/performance-data-collection/collectors/wsman.adoc b/docs/modules/reference/pages/performance-data-collection/collectors/wsman.adoc index 895181a4e2c0..ab7c7896c120 100644 --- a/docs/modules/reference/pages/performance-data-collection/collectors/wsman.adoc +++ b/docs/modules/reference/pages/performance-data-collection/collectors/wsman.adoc @@ -1,7 +1,7 @@ [[ga-performance-mgmt-collectors-wsman-collector]] = WsManCollector -:description: Learn how to configure the WsManCollector in {page-component-title} to collect performance metrics using the Web Services-Management protocol. +:description: Learn how to configure the WsManCollector in OpenNMS {page-component-title} to collect performance metrics using the Web Services-Management protocol. The WsManCollector collects performance metrics using the Web Services-Management (WS-Management) protocol. diff --git a/docs/modules/reference/pages/performance-data-collection/collectors/xml.adoc b/docs/modules/reference/pages/performance-data-collection/collectors/xml.adoc index 71c0ef9d509f..e876b27deb16 100644 --- a/docs/modules/reference/pages/performance-data-collection/collectors/xml.adoc +++ b/docs/modules/reference/pages/performance-data-collection/collectors/xml.adoc @@ -1,6 +1,6 @@ = XmlCollector -:description: Learn how to configure the XmlCollector in {page-component-title} to collect and extract metrics from XML and JSON documents. +:description: Learn how to configure the XmlCollector in OpenNMS {page-component-title} to collect and extract metrics from XML and JSON documents. The XmlCollector collects and extracts metrics from XML and JSON documents. diff --git a/docs/modules/reference/pages/performance-data-collection/introduction.adoc b/docs/modules/reference/pages/performance-data-collection/introduction.adoc index e44bd54b0f22..b1edb95e4182 100644 --- a/docs/modules/reference/pages/performance-data-collection/introduction.adoc +++ b/docs/modules/reference/pages/performance-data-collection/introduction.adoc @@ -1,6 +1,6 @@ [[ref-performance-data-collectors]] = Collectors -:description: Overview of official documentation for collectors in {page-component-title}. +:description: Overview of official documentation for collectors in OpenNMS {page-component-title}. This section describes all available built-in xref:operation:deep-dive/performance-data-collection/introduction.adoc[performance data collectors]. You can configure them to allow complex monitoring to meet the needs of your environment. diff --git a/docs/modules/reference/pages/provisioning/adapters/ddns.adoc b/docs/modules/reference/pages/provisioning/adapters/ddns.adoc index 0e9c7784837f..9e01415c34b3 100644 --- a/docs/modules/reference/pages/provisioning/adapters/ddns.adoc +++ b/docs/modules/reference/pages/provisioning/adapters/ddns.adoc @@ -1,6 +1,6 @@ [[adapter-ddns]] = Dynamic DNS -:description: Learn how the DDNS adapter uses the dynamic DNS protocol to send updated A/AAAA DNS records to your DNS system when {page-component-title} provisions nodes. +:description: Learn how the DDNS adapter uses the dynamic DNS protocol to send updated DNS records to your DNS system when OpenNMS {page-component-title} provisions nodes. The DDNS adapter uses the dynamic DNS protocol to send updated A/AAAA DNS records to your DNS system as nodes are provisioned into {page-component-title}. diff --git a/docs/modules/reference/pages/provisioning/adapters/geoip.adoc b/docs/modules/reference/pages/provisioning/adapters/geoip.adoc index 173513c2f149..c2377ebb5ff4 100644 --- a/docs/modules/reference/pages/provisioning/adapters/geoip.adoc +++ b/docs/modules/reference/pages/provisioning/adapters/geoip.adoc @@ -1,6 +1,6 @@ [[adapter-geoip]] = GeoIP -:description: Learn how the GeoIP provisioning adapter in {page-component-title} enriches node asset data with location information. +:description: Learn how the GeoIP provisioning adapter in OpenNMS {page-component-title} enriches node asset data with location information. Use the GeoIP Provisioning Adapter to enrich a node's asset data with location information. It uses the GeoIP2 Databases from MaxMind to look up longitude/latitude values for a given IP address. diff --git a/docs/modules/reference/pages/provisioning/adapters/hardware-inventory.adoc b/docs/modules/reference/pages/provisioning/adapters/hardware-inventory.adoc index b64c75b5c6ee..e8044ed7654d 100644 --- a/docs/modules/reference/pages/provisioning/adapters/hardware-inventory.adoc +++ b/docs/modules/reference/pages/provisioning/adapters/hardware-inventory.adoc @@ -1,6 +1,6 @@ [[hardware-inventory]] = Hardware Inventory -:description: Learn how to configure {page-component-title} to import Entity-MIB information from SNMP agents and enrich node data. +:description: Learn how to configure OpenNMS {page-component-title} to import Entity-MIB information from SNMP agents and enrich node data. {page-component-title} can be extended to import Entity-MIB information from SNMP agents to enrich node data. There are two types of Entity-MIBs. diff --git a/docs/modules/reference/pages/provisioning/adapters/introduction.adoc b/docs/modules/reference/pages/provisioning/adapters/introduction.adoc index af2176b431a2..57ab5080dbb6 100644 --- a/docs/modules/reference/pages/provisioning/adapters/introduction.adoc +++ b/docs/modules/reference/pages/provisioning/adapters/introduction.adoc @@ -1,6 +1,6 @@ [[adapters]] = Adapters -:description: Overview of provisioning adapters section in the {page-component-title} documentation: requisition node enrichment. +:description: Overview of provisioning adapters section in the OpenNMS {page-component-title} documentation: requisition node enrichment. The {page-component-title} Provisiond API supports xref:operation:deep-dive/provisioning/introduction.adoc[provisioning] adapters (plugins) for integration with external systems during the provisioning import phase. These adapters let OpenNMS exchange data with other systems, allowing the enrichment of node data. diff --git a/docs/modules/reference/pages/provisioning/adapters/rdns.adoc b/docs/modules/reference/pages/provisioning/adapters/rdns.adoc index bcb6eef017d7..0d4e1a56c32c 100644 --- a/docs/modules/reference/pages/provisioning/adapters/rdns.adoc +++ b/docs/modules/reference/pages/provisioning/adapters/rdns.adoc @@ -1,6 +1,6 @@ [[adapter-rdns]] = Reverse DNS -:description: Learn how the RDNS adapter uses the dynamic DNS protocol to send updated PTR DNS records to your DNS system when {page-component-title} provisions nodes. +:description: Learn how the RDNS adapter uses the dynamic DNS protocol to send updated PTR DNS records to your DNS system when OpenNMS {page-component-title} provisions nodes. The RDNS adapter uses the dynamic DNS protocol to send updated PTR DNS records to your DNS system as nodes are provisioned into {page-component-title}. diff --git a/docs/modules/reference/pages/provisioning/adapters/snmp-asset.adoc b/docs/modules/reference/pages/provisioning/adapters/snmp-asset.adoc index c9c530106cb1..9eeb27beac7c 100644 --- a/docs/modules/reference/pages/provisioning/adapters/snmp-asset.adoc +++ b/docs/modules/reference/pages/provisioning/adapters/snmp-asset.adoc @@ -1,6 +1,6 @@ [[adapter-snmp-asset]] = SNMP Asset -:description: Learn how to configure and use the SNMP asset adapter to collect SNMP values and populate asset records for nodes in {page-component-title}. +:description: Learn how to configure and use the SNMP asset adapter to collect SNMP values and populate asset records for nodes in OpenNMS {page-component-title}. The SNMP asset provisioning adapter collects SNMP values to populate asset records for the node. This can be very useful for automatically populating asset fields in a large number of managed systems. diff --git a/docs/modules/reference/pages/provisioning/adapters/snmp-metadata.adoc b/docs/modules/reference/pages/provisioning/adapters/snmp-metadata.adoc index 14cc4574f86d..3b5ad9480c49 100644 --- a/docs/modules/reference/pages/provisioning/adapters/snmp-metadata.adoc +++ b/docs/modules/reference/pages/provisioning/adapters/snmp-metadata.adoc @@ -1,5 +1,5 @@ = SNMP Metadata -:description: Learn how to configure and use the SNMP metadata adapter to enrich nodes with SNMP data in {page-component-title}. +:description: Learn how to configure and use the SNMP metadata adapter to enrich nodes with SNMP data in OpenNMS {page-component-title}. The SNMP Metadata adapter can be used to enrich a node with data gathered from SNMP. This data is stored in the node's metadata context `snmp` and can be displayed in the Web UI and also queried via ReST. diff --git a/docs/modules/reference/pages/provisioning/adapters/wsman-asset.adoc b/docs/modules/reference/pages/provisioning/adapters/wsman-asset.adoc index 2c00757864de..82116b6fa735 100644 --- a/docs/modules/reference/pages/provisioning/adapters/wsman-asset.adoc +++ b/docs/modules/reference/pages/provisioning/adapters/wsman-asset.adoc @@ -1,6 +1,6 @@ [[adapter-wsman-asset]] = WS-Man Asset -:description: Learn how to configure and use the WS-Man asset adapter to perform WS-Man queries and populate asset records for nodes in {page-component-title}. +:description: Learn how to configure and use the WS-Man asset adapter to perform WS-Man queries and populate asset records for nodes in OpenNMS {page-component-title}. The WS-Man asset provisioning adapter performs WS-Man queries to populate asset records for the node. This can be very useful for automatically populating asset fields in a large number of managed systems. diff --git a/docs/modules/reference/pages/provisioning/detectors.adoc b/docs/modules/reference/pages/provisioning/detectors.adoc index 1cd5ef71e2fe..eb6cf65b660b 100644 --- a/docs/modules/reference/pages/provisioning/detectors.adoc +++ b/docs/modules/reference/pages/provisioning/detectors.adoc @@ -1,7 +1,7 @@ [[ref-detectors]] = Detectors -:description: Get an overview of detectors in {page-component-title} and common configuration parameters assocciated with them. +:description: Get an overview of detectors in OpenNMS {page-component-title} and common configuration parameters assocciated with them. This section describes all available built-in xref:operation:deep-dive/provisioning/introduction.adoc[provisioning] detectors. You can configure them to allow complex detection to meet the needs of your environment. diff --git a/docs/modules/reference/pages/provisioning/detectors/ActiveMQDetector.adoc b/docs/modules/reference/pages/provisioning/detectors/ActiveMQDetector.adoc index da47ff92029f..cfb792e74cbd 100644 --- a/docs/modules/reference/pages/provisioning/detectors/ActiveMQDetector.adoc +++ b/docs/modules/reference/pages/provisioning/detectors/ActiveMQDetector.adoc @@ -1,5 +1,5 @@ = ActiveMQ Detector -:description: Learn how the ActiveMQ detector in {page-component-title} finds and assigns services based on the existence of ActiveMQ broker services. +:description: Learn how the ActiveMQ detector in OpenNMS {page-component-title} finds and assigns services based on the existence of ActiveMQ broker services. The ActiveMQDetector finds and assigns services based on the existence of ActiveMQ broker services. diff --git a/docs/modules/reference/pages/provisioning/detectors/BgpSessionDetector.adoc b/docs/modules/reference/pages/provisioning/detectors/BgpSessionDetector.adoc index 57ccce5c62ca..0274804dfa10 100644 --- a/docs/modules/reference/pages/provisioning/detectors/BgpSessionDetector.adoc +++ b/docs/modules/reference/pages/provisioning/detectors/BgpSessionDetector.adoc @@ -1,5 +1,5 @@ = BGP Session Detector -:description: Learn how the BGPSessionDetector in {page-component-title} checks if a BGP Session to a peering partner (peer-ip) is configured. +:description: Learn how the BGPSessionDetector in OpenNMS {page-component-title} checks if a BGP Session to a peering partner (peer-ip) is configured. The BGPSessionDetector checks if a BGP Session to a peering partner (peer-ip) is configured. A BGP peering session is detected when a _bgpPeerEntry_ from the RFC1269 MIB (`.1.3.6.1.2.1.15.3.1`) exists and can be queried using SNMP. diff --git a/docs/modules/reference/pages/provisioning/detectors/BsfDetector.adoc b/docs/modules/reference/pages/provisioning/detectors/BsfDetector.adoc index 7d4edcc29b8d..ac0b03028f0c 100644 --- a/docs/modules/reference/pages/provisioning/detectors/BsfDetector.adoc +++ b/docs/modules/reference/pages/provisioning/detectors/BsfDetector.adoc @@ -1,5 +1,5 @@ = BSF Detector -:description: Learn how the BSFDetector in {page-component-title} lets you run scripts using the Bean Scripting Framework (BSF) to determine if a service exists. +:description: Learn how the BSFDetector in OpenNMS {page-component-title} lets you run scripts using the Bean Scripting Framework (BSF) to determine if a service exists. The BSFDetector lets you run arbitrary scripts using the Bean Scripting Framework (BSF) to determine if a service exists. This can be a script written in any of the languages BSF supports. diff --git a/docs/modules/reference/pages/provisioning/detectors/DnsDetector.adoc b/docs/modules/reference/pages/provisioning/detectors/DnsDetector.adoc index 278177cdc4cd..90254b1b42b7 100644 --- a/docs/modules/reference/pages/provisioning/detectors/DnsDetector.adoc +++ b/docs/modules/reference/pages/provisioning/detectors/DnsDetector.adoc @@ -1,5 +1,5 @@ = DNS Service Detector -:description: Learn how the DNSDetector in {page-component-title} lets you find DNS services for monitoring in your network. +:description: Learn how the DNSDetector in OpenNMS {page-component-title} lets you find DNS services for monitoring in your network. The DNSDetector lets you find DNS services for monitoring in your network. A DNS service is detected when the node responds to a DNS query for an A resource record. diff --git a/docs/modules/reference/pages/provisioning/detectors/FtpDetector.adoc b/docs/modules/reference/pages/provisioning/detectors/FtpDetector.adoc index 2ad44616c434..3ce556d92fb0 100644 --- a/docs/modules/reference/pages/provisioning/detectors/FtpDetector.adoc +++ b/docs/modules/reference/pages/provisioning/detectors/FtpDetector.adoc @@ -1,5 +1,5 @@ = FTP Service Detector -:description: Learn how the FTPDetector in {page-component-title} lets you find FTP services for monitoring in your network. +:description: Learn how the FTPDetector in OpenNMS {page-component-title} lets you find FTP services for monitoring in your network. The FTPDetector lets you find FTP services for monitoring in your network. It finds an FTP server on multiple ports and can use login credentials for service detection. diff --git a/docs/modules/reference/pages/provisioning/detectors/HostResourceSWRunDetector.adoc b/docs/modules/reference/pages/provisioning/detectors/HostResourceSWRunDetector.adoc index 89564575106d..ee5e011db110 100644 --- a/docs/modules/reference/pages/provisioning/detectors/HostResourceSWRunDetector.adoc +++ b/docs/modules/reference/pages/provisioning/detectors/HostResourceSWRunDetector.adoc @@ -1,5 +1,5 @@ = HostResourceSWRun Detector -:description: Learn how the HostResourceSWRun Detector in {page-component-title} tests the running state of one or more processes via SNMP. +:description: Learn how the HostResourceSWRun Detector in OpenNMS {page-component-title} tests the running state of one or more processes via SNMP. This detector tests the running state of one or more processes. It does this via SNMP by inspecting the http://www.ietf.org/rfc/rfc2790[HOST-RESOURCES-MIB] hrSwRunTable. diff --git a/docs/modules/reference/pages/provisioning/detectors/HttpDetector.adoc b/docs/modules/reference/pages/provisioning/detectors/HttpDetector.adoc index 980c3ea6f233..a86cdf025b42 100644 --- a/docs/modules/reference/pages/provisioning/detectors/HttpDetector.adoc +++ b/docs/modules/reference/pages/provisioning/detectors/HttpDetector.adoc @@ -1,5 +1,5 @@ = HTTP Detector -:description: Learn how the HTTPDetector in {page-component-title} finds and assigns services based on HTTP. +:description: Learn how the HTTPDetector in OpenNMS {page-component-title} finds and assigns services based on HTTP. The HTTPDetector finds and assigns services based on HTTP. diff --git a/docs/modules/reference/pages/provisioning/detectors/HttpsDetector.adoc b/docs/modules/reference/pages/provisioning/detectors/HttpsDetector.adoc index f197830faca1..10c00b33379d 100644 --- a/docs/modules/reference/pages/provisioning/detectors/HttpsDetector.adoc +++ b/docs/modules/reference/pages/provisioning/detectors/HttpsDetector.adoc @@ -1,5 +1,5 @@ = HTTPS Detector -:description: Learn how the HTTPSDetector in {page-component-title} finds and assigns services based on HTTPS. +:description: Learn how the HTTPSDetector in OpenNMS {page-component-title} finds and assigns services based on HTTPS. The HTTPSDetector finds and assigns services based on HTTPS. diff --git a/docs/modules/reference/pages/provisioning/detectors/JdbcDetector.adoc b/docs/modules/reference/pages/provisioning/detectors/JdbcDetector.adoc index 8fa1a36eea50..2c08bb9ca156 100644 --- a/docs/modules/reference/pages/provisioning/detectors/JdbcDetector.adoc +++ b/docs/modules/reference/pages/provisioning/detectors/JdbcDetector.adoc @@ -1,6 +1,6 @@ = JDBC Detector -:description: Learn how the JDBCDetector in {page-component-title} connects to a JDBC-enabled database and tries to fetch its catalog to determine its availability. +:description: Learn how the JDBCDetector in OpenNMS {page-component-title} connects to a JDBC-enabled database and tries to fetch its catalog to determine its availability. The JDBCDetector connects to a JDBC-enabled database and tries to fetch its catalog. If the fetch is successful, it returns the `detected` value. diff --git a/docs/modules/reference/pages/provisioning/detectors/JdbcQueryDetector.adoc b/docs/modules/reference/pages/provisioning/detectors/JdbcQueryDetector.adoc index b119418d0e8a..b9cb8e31f4a6 100644 --- a/docs/modules/reference/pages/provisioning/detectors/JdbcQueryDetector.adoc +++ b/docs/modules/reference/pages/provisioning/detectors/JdbcQueryDetector.adoc @@ -1,6 +1,6 @@ = JDBC Query Detector -:description: Learn how the JDBCQueryDetector in {page-component-title} connects to a JDBC-enabled database and checks for any result from a user-specified SQL query. +:description: Learn how the JDBCQueryDetector in OpenNMS {page-component-title} connects to a JDBC-enabled database and checks for any result from a user-specified SQL query. The JDBCQueryDetector connects to a JDBC-enabled database and checks for any result from a user-specified SQL query. If the query returns a result, the detector returns the `detected` value. diff --git a/docs/modules/reference/pages/provisioning/detectors/JdbcStoredProcedureDetector.adoc b/docs/modules/reference/pages/provisioning/detectors/JdbcStoredProcedureDetector.adoc index e481abb5ca17..85a00371209f 100644 --- a/docs/modules/reference/pages/provisioning/detectors/JdbcStoredProcedureDetector.adoc +++ b/docs/modules/reference/pages/provisioning/detectors/JdbcStoredProcedureDetector.adoc @@ -1,6 +1,6 @@ = JDBC Stored Procedure Detector -:description: Learn how the JDBCStoredProcedureDetector in {page-component-title} connects to a JDBC-enabled database and checks the result of a stored procedure. +:description: Learn how the JDBCStoredProcedureDetector in OpenNMS {page-component-title} connects to a JDBC-enabled database and checks the result of a stored procedure. The JDBCStoredProcedureDetector connects to a JDBC-enabled database and checks the result of a stored procedure. The result of the stored procedure must be a Boolean value (representing true or false). diff --git a/docs/modules/reference/pages/provisioning/detectors/LoopDetector.adoc b/docs/modules/reference/pages/provisioning/detectors/LoopDetector.adoc index fede01adfe12..79e929a95a64 100644 --- a/docs/modules/reference/pages/provisioning/detectors/LoopDetector.adoc +++ b/docs/modules/reference/pages/provisioning/detectors/LoopDetector.adoc @@ -1,5 +1,5 @@ = Loop Detector -:description: Learn how the LoopDetector gives {page-component-title} users the ability to force a service onto an interface during service detection. +:description: Learn how the LoopDetector gives OpenNMS {page-component-title} users the ability to force a service onto an interface during service detection. The LoopDetector gives {page-component-title} users the ability to force a service onto an interface during service detection. You can use the LoopDetector to ensure a specific service is added to all nodes without performing a check against the node. diff --git a/docs/modules/reference/pages/provisioning/detectors/ReverseDNSLookupDetector.adoc b/docs/modules/reference/pages/provisioning/detectors/ReverseDNSLookupDetector.adoc index 809ef649aaa1..512c94d872fb 100644 --- a/docs/modules/reference/pages/provisioning/detectors/ReverseDNSLookupDetector.adoc +++ b/docs/modules/reference/pages/provisioning/detectors/ReverseDNSLookupDetector.adoc @@ -1,5 +1,5 @@ = Reverse DNS Lookup Detector -:description: Learn how the ReverseDNSLookupDetector in {page-component-title} tries to detect if a given IP address can be found in PTR records. +:description: Learn how the ReverseDNSLookupDetector in OpenNMS {page-component-title} tries to detect if a given IP address can be found in PTR records. The ReverseDNSLookupDetector tries to detect if a given IP address can be found in PTR records. diff --git a/docs/modules/reference/pages/provisioning/detectors/SnmpDetector.adoc b/docs/modules/reference/pages/provisioning/detectors/SnmpDetector.adoc index 189a52474989..b94e19ecf86e 100644 --- a/docs/modules/reference/pages/provisioning/detectors/SnmpDetector.adoc +++ b/docs/modules/reference/pages/provisioning/detectors/SnmpDetector.adoc @@ -1,5 +1,5 @@ = SNMP Service Detector -:description: Learn how the SNMPDetector in {page-component-title} finds and assigns services based on SNMP. +:description: Learn how the SNMPDetector in OpenNMS {page-component-title} finds and assigns services based on SNMP. The SNMPDetector finds and assigns services based on SNMP. It binds a service with a given name when a particular scalar or table SNMP OID matches defined criteria. diff --git a/docs/modules/reference/pages/provisioning/detectors/TcpDetector.adoc b/docs/modules/reference/pages/provisioning/detectors/TcpDetector.adoc index 750bd28f24c6..7ea050830f30 100644 --- a/docs/modules/reference/pages/provisioning/detectors/TcpDetector.adoc +++ b/docs/modules/reference/pages/provisioning/detectors/TcpDetector.adoc @@ -1,5 +1,5 @@ = TCP Service Detector -:description: Learn how the TCPDetector in {page-component-title} lets you find TCP-based services for monitoring in your network. +:description: Learn how the TCPDetector in OpenNMS {page-component-title} lets you find TCP-based services for monitoring in your network. The TCPDetector lets you find TCP-based services for monitoring in your network. diff --git a/docs/modules/reference/pages/provisioning/detectors/TrivialTimeDetector.adoc b/docs/modules/reference/pages/provisioning/detectors/TrivialTimeDetector.adoc index 4ac7d9efd80c..dec2437f344d 100644 --- a/docs/modules/reference/pages/provisioning/detectors/TrivialTimeDetector.adoc +++ b/docs/modules/reference/pages/provisioning/detectors/TrivialTimeDetector.adoc @@ -1,5 +1,5 @@ = TrivialTimeDetector -:description: Learn how the TrivialTimeDetector in {page-component-title} finds and assigns services based on a timely response from a Trivial Time Service. +:description: Learn how the TrivialTimeDetector in OpenNMS {page-component-title} finds and assigns services based on a timely response from a Trivial Time Service. The TrivialTimeDetector finds and assigns services based on a timely response from a Trivial Time Service. diff --git a/docs/modules/reference/pages/provisioning/detectors/WebDetector.adoc b/docs/modules/reference/pages/provisioning/detectors/WebDetector.adoc index 50b9249b65a9..f16622d88131 100644 --- a/docs/modules/reference/pages/provisioning/detectors/WebDetector.adoc +++ b/docs/modules/reference/pages/provisioning/detectors/WebDetector.adoc @@ -1,5 +1,5 @@ = Web Detector -:description: Learn how the WebDetector in {page-component-title} finds and assigns services based on HTTP. +:description: Learn how the WebDetector in OpenNMS {page-component-title} finds and assigns services based on HTTP. The WebDetector finds and assigns services based on HTTP. diff --git a/docs/modules/reference/pages/provisioning/detectors/Win32ServiceDetector.adoc b/docs/modules/reference/pages/provisioning/detectors/Win32ServiceDetector.adoc index 0545791435db..5a1dc75a9c0f 100644 --- a/docs/modules/reference/pages/provisioning/detectors/Win32ServiceDetector.adoc +++ b/docs/modules/reference/pages/provisioning/detectors/Win32ServiceDetector.adoc @@ -1,5 +1,5 @@ = Win32 Service Detector -:description: Learn how the Win32ServiceDetector in {page-component-title} detects the availability of services on Windows devices that have SNMP enabled. +:description: Learn how the Win32ServiceDetector in OpenNMS {page-component-title} detects the availability of services on Windows devices that have SNMP enabled. The Win32ServiceDetector detects the availability of services on Windows devices that have SNMP enabled. It queries the Microsoft LAN Manager MIB `.1.3.6.1.4.1.77` over SNMP to confirm the service exists and is active. diff --git a/docs/modules/reference/pages/provisioning/detectors/WmiDetector.adoc b/docs/modules/reference/pages/provisioning/detectors/WmiDetector.adoc index 3c6791045dbe..00e8b9260177 100644 --- a/docs/modules/reference/pages/provisioning/detectors/WmiDetector.adoc +++ b/docs/modules/reference/pages/provisioning/detectors/WmiDetector.adoc @@ -1,5 +1,5 @@ = WMI Service Detector -:description: Learn how the WMIDetector in {page-component-title} detects the availability of WMIConfiguration on a device when using Provisiond to scan it. +:description: Learn how the WMIDetector in OpenNMS {page-component-title} detects the availability of WMIConfiguration on a device when using Provisiond to scan it. The WMIDetector detects the availability of WMIConfiguration on a device when using Provisiond to scan it. By default, it expects to make a WMI query to the `Win32_ComputerSystem` class, checking for `OK` from the Status object. diff --git a/docs/modules/reference/pages/provisioning/detectors/WsmanDetector.adoc b/docs/modules/reference/pages/provisioning/detectors/WsmanDetector.adoc index b093a08ab970..e0e899beeb46 100644 --- a/docs/modules/reference/pages/provisioning/detectors/WsmanDetector.adoc +++ b/docs/modules/reference/pages/provisioning/detectors/WsmanDetector.adoc @@ -1,5 +1,5 @@ = WS-Management Detector -:description: Learn how the WSManDetector in {page-component-title} attempts to connect to the agent defined in `wsman-config.xml` and issues an identify command. +:description: Learn how the WSManDetector in OpenNMS {page-component-title} attempts to connect to the agent defined in `wsman-config.xml` and issues an identify command. The WSManDetector attempts to connect to the agent defined in `wsman-config.xml` and issues an identify command. If the identify command is successful, the service is marked as detected, and the product details returned by the command are optionally stored in the asset fields (see details below). diff --git a/docs/modules/reference/pages/provisioning/detectors/WsmanWqlDetector.adoc b/docs/modules/reference/pages/provisioning/detectors/WsmanWqlDetector.adoc index 1168c38a63de..e4b83d7bbdd1 100644 --- a/docs/modules/reference/pages/provisioning/detectors/WsmanWqlDetector.adoc +++ b/docs/modules/reference/pages/provisioning/detectors/WsmanWqlDetector.adoc @@ -1,5 +1,5 @@ = WS-Manangement WQL Detector -:description: Learn how the WSManWQLDetector in {page-component-title} attempts to connect to the agent defined in `wsman-config.xml` and issues a WQL query. +:description: Learn how the WSManWQLDetector in OpenNMS {page-component-title} attempts to connect to the agent defined in `wsman-config.xml` and issues a WQL query. The WSManWQLDetector attempts to connect to the agent defined in `wsman-config.xml` and issues a WQL query. If the query successfully returns one or more items, the service is marked as detected. diff --git a/docs/modules/reference/pages/provisioning/handlers/dns.adoc b/docs/modules/reference/pages/provisioning/handlers/dns.adoc index 5e93261b70a6..8b9495f6c41b 100644 --- a/docs/modules/reference/pages/provisioning/handlers/dns.adoc +++ b/docs/modules/reference/pages/provisioning/handlers/dns.adoc @@ -2,7 +2,7 @@ [[dns-handler]] = DNS Handler -:description: Learn how to configure and use the DNS handler in {page-component-title} to request a zone transfer (AXFR) from a DNS server to retrieve A and AAAA records. +:description: Learn how to configure and use the DNS handler in OpenNMS {page-component-title} to request a zone transfer from a DNS server to retrieve A and AAAA records. The DNS handler requests a zone transfer (AXFR) from a DNS server. The A and AAAA records are retrieved and used to build an import requisition. diff --git a/docs/modules/reference/pages/provisioning/handlers/file.adoc b/docs/modules/reference/pages/provisioning/handlers/file.adoc index 1fe3d384b78f..5d4a1dc7e1f1 100644 --- a/docs/modules/reference/pages/provisioning/handlers/file.adoc +++ b/docs/modules/reference/pages/provisioning/handlers/file.adoc @@ -3,7 +3,7 @@ [[file-handler]] = File Handler -:description: Learn how to use the File handler in {page-component-title} to import a properly formatted requisition definition from a locally stored XML file. +:description: Learn how to use the File handler in OpenNMS {page-component-title} to import a properly formatted requisition definition from a locally stored XML file. The file handler imports a properly formatted requisition definition from an XML file stored locally on the server. diff --git a/docs/modules/reference/pages/provisioning/handlers/http.adoc b/docs/modules/reference/pages/provisioning/handlers/http.adoc index c78df8407d82..91f3793f9110 100644 --- a/docs/modules/reference/pages/provisioning/handlers/http.adoc +++ b/docs/modules/reference/pages/provisioning/handlers/http.adoc @@ -2,7 +2,7 @@ [[http-handler]] = HTTP(S) Handler -:description: Learn how the HTTP(S) handler in {page-component-title} can import a requisition definition from an XML document served by a remote web server. +:description: Learn how the HTTP(S) handler in OpenNMS {page-component-title} can import a requisition definition from an XML document served by a remote web server. The HTTP(S) handler imports a properly formatted requisition definition from an XML document served by a remote web server. diff --git a/docs/modules/reference/pages/provisioning/handlers/introduction.adoc b/docs/modules/reference/pages/provisioning/handlers/introduction.adoc index 18a0bf7723ca..7641753df1b0 100644 --- a/docs/modules/reference/pages/provisioning/handlers/introduction.adoc +++ b/docs/modules/reference/pages/provisioning/handlers/introduction.adoc @@ -3,7 +3,7 @@ [[import-handlers]] = Import Handlers -:description: Learn how {page-component-title} supports import handlers to help provision nodes from external systems into a network inventory requisition. +:description: Learn how OpenNMS {page-component-title} supports import handlers to help provision nodes from external systems into a network inventory requisition. {page-component-title} supports import handlers to help provision nodes from an external system (foreign source) into a requisition. This is done through external requisitions that you specify in the External Requisitions and Thread Pools screen, or that you configure via the xref:development:rest/config_management.adoc[configuration management API]. diff --git a/docs/modules/reference/pages/provisioning/handlers/requisition-plugin.adoc b/docs/modules/reference/pages/provisioning/handlers/requisition-plugin.adoc index 0b611fb7b6aa..973cb57381e4 100644 --- a/docs/modules/reference/pages/provisioning/handlers/requisition-plugin.adoc +++ b/docs/modules/reference/pages/provisioning/handlers/requisition-plugin.adoc @@ -3,7 +3,7 @@ [[requisition-plugin]] = Requisition Plugins -:description: Learn about experimental plugins in {page-component-title} that can provision nodes from other platforms: OpenDaylight, ACI, PRIS. +:description: Learn about experimental plugins in OpenNMS {page-component-title} that can provision nodes from other platforms: OpenDaylight, ACI, PRIS. {page-component-title} provides some experimental plugins that can provision nodes from additional platforms, including software-defined networking, hypervisor, and configuration management database (CMDB) platforms. diff --git a/docs/modules/reference/pages/provisioning/handlers/vmware.adoc b/docs/modules/reference/pages/provisioning/handlers/vmware.adoc index 39e63e258bdd..e3f64110edd8 100644 --- a/docs/modules/reference/pages/provisioning/handlers/vmware.adoc +++ b/docs/modules/reference/pages/provisioning/handlers/vmware.adoc @@ -3,7 +3,7 @@ [[vmware-handler]] = VMWare Handler -:description: Learn how to use and configure the VMware adapter to pull hosts and/or virtual machines from a vCenter server into {page-component-title}. +:description: Learn how to use and configure the VMware adapter to pull hosts and/or virtual machines from a vCenter server into OpenNMS {page-component-title}. The VMware adapter pulls hosts and/or virtual machines from a vCenter server into {page-component-title}. With this adapter, you can automatically add, update, or remove nodes from your {page-component-title} based on the status of the VMware entity. diff --git a/docs/modules/reference/pages/provisioning/policies.adoc b/docs/modules/reference/pages/provisioning/policies.adoc index 43bfc2743d61..d32f1a55a984 100644 --- a/docs/modules/reference/pages/provisioning/policies.adoc +++ b/docs/modules/reference/pages/provisioning/policies.adoc @@ -1,7 +1,7 @@ [[ref-policies]] = Policies -:description: Overview of the provisioning policies section in the {page-component-title} documentation, including common parameters and policy ordering. +:description: Overview of the provisioning policies section in the OpenNMS {page-component-title} documentation, including common parameters and policy ordering. This section describes all available built-in xref:operation:deep-dive/provisioning/introduction.adoc[provisioning] policies. You can configure them to allow node modifications or change provisioning behavior to meet the needs of your environment. diff --git a/docs/modules/reference/pages/provisioning/policies/ip-interface.adoc b/docs/modules/reference/pages/provisioning/policies/ip-interface.adoc index fbb1ffd19809..5db093771ad4 100644 --- a/docs/modules/reference/pages/provisioning/policies/ip-interface.adoc +++ b/docs/modules/reference/pages/provisioning/policies/ip-interface.adoc @@ -1,5 +1,5 @@ = IP Interface Policy -:description: Learn how to configure and use the IP interface policy in {page-component-title} to control the persistence of discovered interfaces. +:description: Learn how to configure and use the IP interface policy in OpenNMS {page-component-title} to control the persistence of discovered interfaces. The `Matching IP Interface` policy controls whether discovered interfaces are persisted and if they are persisted, whether they will be forced to be managed or unmanaged. diff --git a/docs/modules/reference/pages/provisioning/policies/metadata.adoc b/docs/modules/reference/pages/provisioning/policies/metadata.adoc index ff8d937d1fd8..86f278bf4418 100644 --- a/docs/modules/reference/pages/provisioning/policies/metadata.adoc +++ b/docs/modules/reference/pages/provisioning/policies/metadata.adoc @@ -1,5 +1,5 @@ = Metadata Policies -:description: Learn about the node and interface metadata policies in {page-component-title} to set metadata for provisioned nodes and discovered interfaces on them. +:description: Learn about the node and interface metadata policies in OpenNMS {page-component-title} to set metadata for provisioned nodes and discovered interfaces on them. == Node metadata policy diff --git a/docs/modules/reference/pages/provisioning/policies/node-category.adoc b/docs/modules/reference/pages/provisioning/policies/node-category.adoc index 669c6022b1aa..aaed7213c92e 100644 --- a/docs/modules/reference/pages/provisioning/policies/node-category.adoc +++ b/docs/modules/reference/pages/provisioning/policies/node-category.adoc @@ -1,4 +1,4 @@ = Node Categorization Policy -:description: Learn about the Node Categorization policy in {page-component-title} to set categories to assign to provisioned nodes. +:description: Learn about the Node Categorization policy in OpenNMS {page-component-title} to set categories to assign to provisioned nodes. The Node Categorization policy lets you set categories to assign to provisioned nodes. diff --git a/docs/modules/reference/pages/provisioning/policies/script.adoc b/docs/modules/reference/pages/provisioning/policies/script.adoc index e3105cd5d5ee..c0d3abfee507 100644 --- a/docs/modules/reference/pages/provisioning/policies/script.adoc +++ b/docs/modules/reference/pages/provisioning/policies/script.adoc @@ -1,6 +1,6 @@ = Script Policy -:description: Learn about the Script policy in {page-component-title} to use Groovy scripts to modify provisioned node data. +:description: Learn about the Script policy in OpenNMS {page-component-title} to use Groovy scripts to modify provisioned node data. This policy lets you use Groovy scripts to modify provisioned node data. These scripts have to be placed in the `$\{OPENNMS_HOME}/etc/script-policies` directory. diff --git a/docs/modules/reference/pages/provisioning/policies/snmp-interface.adoc b/docs/modules/reference/pages/provisioning/policies/snmp-interface.adoc index ac570f2fedaa..748dd7897097 100644 --- a/docs/modules/reference/pages/provisioning/policies/snmp-interface.adoc +++ b/docs/modules/reference/pages/provisioning/policies/snmp-interface.adoc @@ -1,6 +1,6 @@ [[snmp-interface-policy]] = SNMP Interface Policy -:description: Learn how the SNMP Interface policy controls whether to persist discovered SNMP interface entities in {page-component-title} and SNMP collection parameters. +:description: Learn how the SNMP Interface policy controls persistence discovered SNMP interface entities in OpenNMS {page-component-title} and SNMP collection parameters. This policy controls whether to persist the discovered SNMP interface entities and whether {page-component-title} should collect performance metrics from the SNMP agent for specific SNMP interfaces. diff --git a/docs/modules/reference/pages/service-assurance/monitors/ActiveMQMonitor.adoc b/docs/modules/reference/pages/service-assurance/monitors/ActiveMQMonitor.adoc index df9fc7ec24e3..38561136b1d2 100644 --- a/docs/modules/reference/pages/service-assurance/monitors/ActiveMQMonitor.adoc +++ b/docs/modules/reference/pages/service-assurance/monitors/ActiveMQMonitor.adoc @@ -1,6 +1,6 @@ = ActiveMQMonitor -:description: Learn how to configure and use the ActiveMQMonitor in {page-component-title} to test the availability of an ActiveMQ broker. +:description: Learn how to configure and use the ActiveMQMonitor in OpenNMS {page-component-title} to test the availability of an ActiveMQ broker. This monitor tests the availability of an ActiveMQ broker. The service is considered available if a successful connection is made. diff --git a/docs/modules/reference/pages/service-assurance/monitors/BSFMonitor.adoc b/docs/modules/reference/pages/service-assurance/monitors/BSFMonitor.adoc index 15fc6b8166fc..f49fa49594ac 100644 --- a/docs/modules/reference/pages/service-assurance/monitors/BSFMonitor.adoc +++ b/docs/modules/reference/pages/service-assurance/monitors/BSFMonitor.adoc @@ -1,6 +1,6 @@ = BSFMonitor -:description: Learn how to configure and use the BSFMonitor in {page-component-title} to determine the status of a service through a Bean Scripting Framework. +:description: Learn how to configure and use the BSFMonitor in OpenNMS {page-component-title} to determine the status of a service through a Bean Scripting Framework. This monitor runs a Bean Scripting Framework (http://commons.apache.org/proper/commons-bsf/[BSF])-compatible script to determine the status of a service. Users can write scripts to perform highly customized service checks. diff --git a/docs/modules/reference/pages/service-assurance/monitors/BgpSessionMonitor.adoc b/docs/modules/reference/pages/service-assurance/monitors/BgpSessionMonitor.adoc index 4bcc7f123c5f..158a9073e423 100644 --- a/docs/modules/reference/pages/service-assurance/monitors/BgpSessionMonitor.adoc +++ b/docs/modules/reference/pages/service-assurance/monitors/BgpSessionMonitor.adoc @@ -1,6 +1,6 @@ = BgpSessionMonitor -:description: Learn how to configure and use the BgpSessionMonitor in {page-component-title} to check if a BGP session to a peering partner (peer-ip) is functional. +:description: Learn how to configure the BgpSessionMonitor in OpenNMS {page-component-title} to check if a BGP session to a peering partner (peer-ip) is functional. This monitor checks if a BGP session to a peering partner (peer-ip) is functional. The monitor uses the link:https://datatracker.ietf.org/doc/html/rfc1269[RFC1269 SNMP MIB] to monitor the BGP-Session, and uses the following OIDs to test the session status: diff --git a/docs/modules/reference/pages/service-assurance/monitors/CiscoIpSlaMonitor.adoc b/docs/modules/reference/pages/service-assurance/monitors/CiscoIpSlaMonitor.adoc index 7da161227e76..ce5f141dda8e 100644 --- a/docs/modules/reference/pages/service-assurance/monitors/CiscoIpSlaMonitor.adoc +++ b/docs/modules/reference/pages/service-assurance/monitors/CiscoIpSlaMonitor.adoc @@ -1,6 +1,6 @@ = CiscoIpSlaMonitor -:description: Learn how to configure and use the CiscoIpSlaMonitor in {page-component-title} to monitor IP SLA configurations on your Cisco devices. +:description: Learn how to configure and use the CiscoIpSlaMonitor in OpenNMS {page-component-title} to monitor IP SLA configurations on your Cisco devices. Use this monitor to monitor IP SLA configurations on your Cisco devices. This monitor supports the following SNMP OIDS from http://www.circitor.fr/Mibs/Html/C/CISCO-RTTMON-MIB.php[CISCO-RTT-MON-MIB]: diff --git a/docs/modules/reference/pages/service-assurance/monitors/CiscoPingMibMonitor.adoc b/docs/modules/reference/pages/service-assurance/monitors/CiscoPingMibMonitor.adoc index 8d0ccba081db..a9a56152df36 100644 --- a/docs/modules/reference/pages/service-assurance/monitors/CiscoPingMibMonitor.adoc +++ b/docs/modules/reference/pages/service-assurance/monitors/CiscoPingMibMonitor.adoc @@ -1,5 +1,5 @@ = CiscoPingMibMonitor -:description: Learn about the CiscoPingMibMonitor in {page-component-title} that supports the CISCO-PING-MIB. +:description: Learn about the CiscoPingMibMonitor in OpenNMS {page-component-title} that supports the CISCO-PING-MIB. This monitor creates conceptual rows (entries) in the ciscoPingTable on Cisco IOS devices that support the http://www.circitor.fr/Mibs/Html/C/CISCO-PING-MIB.php[CISCO-PING-MIB]. These entries direct the remote IOS device to ping an IPv4 or IPv6 address with a configurable set of parameters. diff --git a/docs/modules/reference/pages/service-assurance/monitors/CitrixMonitor.adoc b/docs/modules/reference/pages/service-assurance/monitors/CitrixMonitor.adoc index b25d8c9c60c8..38f9272a1c41 100644 --- a/docs/modules/reference/pages/service-assurance/monitors/CitrixMonitor.adoc +++ b/docs/modules/reference/pages/service-assurance/monitors/CitrixMonitor.adoc @@ -1,6 +1,6 @@ = CitrixMonitor -:description: Learn about the CitrixMonitor in {page-component-title} that tests if a Citrix or XenApp server is providing the ICA protocol on TCP 1494. +:description: Learn about the CitrixMonitor in OpenNMS {page-component-title} that tests if a Citrix or XenApp server is providing the ICA protocol on TCP 1494. This monitor tests if a Citrix(R) Server or XenApp Server(R) is providing the Independent Computing Architecture (ICA) protocol on TCP 1494. diff --git a/docs/modules/reference/pages/service-assurance/monitors/DNSResolutionMonitor.adoc b/docs/modules/reference/pages/service-assurance/monitors/DNSResolutionMonitor.adoc index 63db408f0d08..f967315af7e2 100644 --- a/docs/modules/reference/pages/service-assurance/monitors/DNSResolutionMonitor.adoc +++ b/docs/modules/reference/pages/service-assurance/monitors/DNSResolutionMonitor.adoc @@ -1,7 +1,7 @@ [[poller-dns-resolution-monitor]] = DNSResolutionMonitor -:description: Learn about the DNSResolutionMonitor in {page-component-title} that tests if the node label of a node can be resolved via a DNS lookup. +:description: Learn about the DNSResolutionMonitor in OpenNMS {page-component-title} that tests if the node label of a node can be resolved via a DNS lookup. The DNS resolution monitor tests if the node label of a node can be resolved via a DNS lookup. This monitor uses the name resolver configuration from the poller configuration or from the operating system where {page-component-title} is running. diff --git a/docs/modules/reference/pages/service-assurance/monitors/DeviceConfigMonitor.adoc b/docs/modules/reference/pages/service-assurance/monitors/DeviceConfigMonitor.adoc index 945b72755d1c..cba07f049f3c 100644 --- a/docs/modules/reference/pages/service-assurance/monitors/DeviceConfigMonitor.adoc +++ b/docs/modules/reference/pages/service-assurance/monitors/DeviceConfigMonitor.adoc @@ -1,6 +1,6 @@ = DeviceConfigMonitor -:description: Learn about the DeviceConfigMonitor in {page-component-title} that tries to retrieve configuration from network devices and shows retrieval status. +:description: Learn about the DeviceConfigMonitor in OpenNMS {page-component-title} that tries to retrieve configuration from network devices and shows retrieval status. This monitor tries to retrieve configuration from the network device and shows the status of that retrieval (success, failed, and so on). diff --git a/docs/modules/reference/pages/service-assurance/monitors/DhcpMonitor.adoc b/docs/modules/reference/pages/service-assurance/monitors/DhcpMonitor.adoc index 479cd64f0a71..dcc8c56607a6 100644 --- a/docs/modules/reference/pages/service-assurance/monitors/DhcpMonitor.adoc +++ b/docs/modules/reference/pages/service-assurance/monitors/DhcpMonitor.adoc @@ -1,6 +1,6 @@ = DhcpMonitor -:description: Learn about the DHCPMonitor in {page-component-title} that checks the availability and functionality of DHCP servers. +:description: Learn about the DHCPMonitor in OpenNMS {page-component-title} that checks the availability and functionality of DHCP servers. Use this monitor to check the availability and functionality of DHCP servers. The DhcpMonitor is run by Pollerd and opens a background process to listen for incoming DHCP responses. diff --git a/docs/modules/reference/pages/service-assurance/monitors/DiskUsageMonitor.adoc b/docs/modules/reference/pages/service-assurance/monitors/DiskUsageMonitor.adoc index 7b18f4b276af..13fc701cb2e5 100644 --- a/docs/modules/reference/pages/service-assurance/monitors/DiskUsageMonitor.adoc +++ b/docs/modules/reference/pages/service-assurance/monitors/DiskUsageMonitor.adoc @@ -1,6 +1,6 @@ = DiskUsageMonitor -:description: Learn about the DiskUsageMonitor in {page-component-title} that tests the free space available on the specified storage disk of a monitored node. +:description: Learn about the DiskUsageMonitor in OpenNMS {page-component-title} that tests the free space available on the specified storage disk of a monitored node. The DiskUsageMonitor tests the amount of free space available on the specified storage disk of a monitored node. The monitor inspects the http://tools.ietf.org/html/rfc1514[HOST-RESOURCES-MIB] hrStorageTable to get information about the available free storage space. diff --git a/docs/modules/reference/pages/service-assurance/monitors/DnsMonitor.adoc b/docs/modules/reference/pages/service-assurance/monitors/DnsMonitor.adoc index 14f237cd16ee..efbf8b4eebe2 100644 --- a/docs/modules/reference/pages/service-assurance/monitors/DnsMonitor.adoc +++ b/docs/modules/reference/pages/service-assurance/monitors/DnsMonitor.adoc @@ -1,7 +1,7 @@ [[poller-dns-resolution-monitor]] = DnsMonitor -:description: Learn about the DnsMonitor in {page-component-title} that tests the availability of the DNS service on remote IP interfaces. +:description: Learn about the DnsMonitor in OpenNMS {page-component-title} that tests the availability of the DNS service on remote IP interfaces. This monitor tests the availability of the DNS service on remote IP interfaces. A DNS query is sent to check for a response of either an A or AAAA resource record. diff --git a/docs/modules/reference/pages/service-assurance/monitors/DskTableMonitor.adoc b/docs/modules/reference/pages/service-assurance/monitors/DskTableMonitor.adoc index 0a7a383c26c5..f5721a36248f 100644 --- a/docs/modules/reference/pages/service-assurance/monitors/DskTableMonitor.adoc +++ b/docs/modules/reference/pages/service-assurance/monitors/DskTableMonitor.adoc @@ -1,6 +1,6 @@ = DskTableMonitor -:description: Learn about the DskTableMonitor in {page-component-title} that tests if a disk or partition is under the minimum required space configured for it. +:description: Learn about the DskTableMonitor in OpenNMS {page-component-title} that tests if a disk or partition is under the minimum required space configured for it. The DskTableMonitor tests the `dskErrorFlag` signaling that the disk or partition is under the minimum required space configured for it. The monitor expects the value `1` to fail and provides the content of `dskErrorMsg` as event reason. diff --git a/docs/modules/reference/pages/service-assurance/monitors/FtpMonitor.adoc b/docs/modules/reference/pages/service-assurance/monitors/FtpMonitor.adoc index e1e6e8925ce7..1514f8fc21c0 100644 --- a/docs/modules/reference/pages/service-assurance/monitors/FtpMonitor.adoc +++ b/docs/modules/reference/pages/service-assurance/monitors/FtpMonitor.adoc @@ -1,6 +1,6 @@ = FtpMonitor -:description: Learn about the FtpMonitor in {page-component-title} that validates an FTP connection's login processes. +:description: Learn about the FtpMonitor in OpenNMS {page-component-title} that validates an FTP connection's login processes. The FtpMonitor validates an FTP connection's login processes. The monitor can test the FTP server on multiple ports with specific login data. diff --git a/docs/modules/reference/pages/service-assurance/monitors/HostResourceSwRunMonitor.adoc b/docs/modules/reference/pages/service-assurance/monitors/HostResourceSwRunMonitor.adoc index 1399cc900a17..9fcef23cdf45 100644 --- a/docs/modules/reference/pages/service-assurance/monitors/HostResourceSwRunMonitor.adoc +++ b/docs/modules/reference/pages/service-assurance/monitors/HostResourceSwRunMonitor.adoc @@ -1,6 +1,6 @@ = HostResourceSwRunMonitor -:description: Learn about the HostResourceSwRunMonitor in {page-component-title} that tests the running state of one or more processes, via SNMP. +:description: Learn about the HostResourceSwRunMonitor in OpenNMS {page-component-title} that tests the running state of one or more processes, via SNMP. This monitor tests the running state of one or more processes. It does this via SNMP by inspecting the http://www.ietf.org/rfc/rfc2790[HOST-RESOURCES-MIB] hrSwRunTable. diff --git a/docs/modules/reference/pages/service-assurance/monitors/HttpMonitor.adoc b/docs/modules/reference/pages/service-assurance/monitors/HttpMonitor.adoc index d4dd5df8cfef..dcbf87b8166c 100644 --- a/docs/modules/reference/pages/service-assurance/monitors/HttpMonitor.adoc +++ b/docs/modules/reference/pages/service-assurance/monitors/HttpMonitor.adoc @@ -1,7 +1,7 @@ [[poller-http-monitor]] = HttpMonitor -:description: Learn about the HttpMonitor in {page-component-title} that tests the response of an HTTP server on a specific HTTP GET command. +:description: Learn about the HttpMonitor in OpenNMS {page-component-title} that tests the response of an HTTP server on a specific HTTP GET command. The HTTP monitor tests the response of an HTTP server on a specific HTTP GET command. During the poll, the monitor attempts to connect on the specified port(s). diff --git a/docs/modules/reference/pages/service-assurance/monitors/HttpPostMonitor.adoc b/docs/modules/reference/pages/service-assurance/monitors/HttpPostMonitor.adoc index 5ef653323867..573d3e4aecde 100644 --- a/docs/modules/reference/pages/service-assurance/monitors/HttpPostMonitor.adoc +++ b/docs/modules/reference/pages/service-assurance/monitors/HttpPostMonitor.adoc @@ -1,6 +1,6 @@ = HttpPostMonitor -:description: Learn about the HttpPostMonitor in {page-component-title} that lets you to HTTP Post any content to a remote URI. +:description: Learn about the HttpPostMonitor in OpenNMS {page-component-title} that lets you to HTTP Post any content to a remote URI. If you need to HTTP POST any arbitrary content to a remote URI (for example, HTTP POST to a web API endpoint), use the HttpPostMonitor. diff --git a/docs/modules/reference/pages/service-assurance/monitors/HttpsMonitor.adoc b/docs/modules/reference/pages/service-assurance/monitors/HttpsMonitor.adoc index 5dcfb8b210a3..3270b36e3816 100644 --- a/docs/modules/reference/pages/service-assurance/monitors/HttpsMonitor.adoc +++ b/docs/modules/reference/pages/service-assurance/monitors/HttpsMonitor.adoc @@ -1,6 +1,6 @@ = HttpsMonitor -:description: Learn about the HttpsMonitor in {page-component-title} that tests the response of an SSL-enabled HTTP server. +:description: Learn about the HttpsMonitor in OpenNMS {page-component-title} that tests the response of an SSL-enabled HTTP server. The HTTPS monitor tests the response of an SSL-enabled HTTP server. It is an SSL-enabled extension of the HTTP monitor with a default TCP port value of 443. diff --git a/docs/modules/reference/pages/service-assurance/monitors/IcmpMonitor.adoc b/docs/modules/reference/pages/service-assurance/monitors/IcmpMonitor.adoc index e8324c31a6a0..1c797dc83dd9 100644 --- a/docs/modules/reference/pages/service-assurance/monitors/IcmpMonitor.adoc +++ b/docs/modules/reference/pages/service-assurance/monitors/IcmpMonitor.adoc @@ -1,7 +1,7 @@ [[poller-icmp-monitor]] = IcmpMonitor -:description: Learn about the IcmpMonitor in {page-component-title} that tests for ICMP service availability by sending echo-request ICMP messages. +:description: Learn about the IcmpMonitor in OpenNMS {page-component-title} that tests for ICMP service availability by sending echo-request ICMP messages. The ICMP monitor tests for ICMP service availability by sending echo-request ICMP messages. The service is considered available when the node sends back an echo-reply ICMP message within the specified amount of time. diff --git a/docs/modules/reference/pages/service-assurance/monitors/ImapMonitor.adoc b/docs/modules/reference/pages/service-assurance/monitors/ImapMonitor.adoc index 3bee0ceea261..1ae007f18f17 100644 --- a/docs/modules/reference/pages/service-assurance/monitors/ImapMonitor.adoc +++ b/docs/modules/reference/pages/service-assurance/monitors/ImapMonitor.adoc @@ -1,7 +1,7 @@ [[poller-imap-monitor]] = ImapMonitor -:description: Learn about the ImapMonitor in {page-component-title} that checks if an IMAP server is functional. +:description: Learn about the ImapMonitor in OpenNMS {page-component-title} that checks if an IMAP server is functional. This monitor checks if an IMAP server is functional. The test initializes an IMAP connection to send a logout command and verify server response. diff --git a/docs/modules/reference/pages/service-assurance/monitors/ImapsMonitor.adoc b/docs/modules/reference/pages/service-assurance/monitors/ImapsMonitor.adoc index 2a88204be7ba..bbbfd13b7d8a 100644 --- a/docs/modules/reference/pages/service-assurance/monitors/ImapsMonitor.adoc +++ b/docs/modules/reference/pages/service-assurance/monitors/ImapsMonitor.adoc @@ -1,6 +1,6 @@ = ImapsMonitor -:description: Learn about the ImapsMonitor in {page-component-title} that tests the response of an SSL-enabled IMAP server. +:description: Learn about the ImapsMonitor in OpenNMS {page-component-title} that tests the response of an SSL-enabled IMAP server. The IMAPS monitor tests the response of an SSL-enabled IMAP server. The IMAPS monitor is an SSL-enabled extension of the IMAP monitor with a default TCP port value of 993. diff --git a/docs/modules/reference/pages/service-assurance/monitors/JCifsMonitor.adoc b/docs/modules/reference/pages/service-assurance/monitors/JCifsMonitor.adoc index 0121a03d9612..2ad5b5d1000b 100644 --- a/docs/modules/reference/pages/service-assurance/monitors/JCifsMonitor.adoc +++ b/docs/modules/reference/pages/service-assurance/monitors/JCifsMonitor.adoc @@ -1,7 +1,7 @@ [[poller-jcifs-monitor]] = JCifsMonitor -:description: Learn about the JCifsMonitor in {page-component-title} that tests a file-sharing service based on the CIFS/SMB protocol. +:description: Learn about the JCifsMonitor in OpenNMS {page-component-title} that tests a file-sharing service based on the CIFS/SMB protocol. This monitor tests a file-sharing service based on the CIFS/SMB protocol. diff --git a/docs/modules/reference/pages/service-assurance/monitors/JDBCMonitor.adoc b/docs/modules/reference/pages/service-assurance/monitors/JDBCMonitor.adoc index 8bc11c73432a..b7ad22ff1587 100644 --- a/docs/modules/reference/pages/service-assurance/monitors/JDBCMonitor.adoc +++ b/docs/modules/reference/pages/service-assurance/monitors/JDBCMonitor.adoc @@ -1,6 +1,6 @@ = JDBCMonitor -:description: Learn about the JDBCMonitor in {page-component-title} that checks if it can connect to a database and get the catalog from the DB management system (DBMS). +:description: Learn about the JDBCMonitor in OpenNMS {page-component-title} that checks if it can connect to a database and get the catalog from the DB management system. The JDBCMonitor checks that it is able to connect to a database and if it can get the database catalog from that database management system (DBMS). It is based on the http://www.oracle.com/technetwork/java/javase/jdbc/index.html[JDBC] technology to connect and communicate with the database. diff --git a/docs/modules/reference/pages/service-assurance/monitors/JDBCQueryMonitor.adoc b/docs/modules/reference/pages/service-assurance/monitors/JDBCQueryMonitor.adoc index 815fa932f32b..b2b1cfbb4d6c 100644 --- a/docs/modules/reference/pages/service-assurance/monitors/JDBCQueryMonitor.adoc +++ b/docs/modules/reference/pages/service-assurance/monitors/JDBCQueryMonitor.adoc @@ -1,6 +1,6 @@ = JDBCQueryMonitor -:description: Learn about the JDBCQueryMonitor in {page-component-title} that runs a SQL query against a database and verifies the result of the query. +:description: Learn about the JDBCQueryMonitor in OpenNMS {page-component-title} that runs a SQL query against a database and verifies the result of the query. The JDBCQueryMonitor runs an SQL query against a database and is able to verify the result of the query. A read-only connection is made, preventing the monitor from being able to alter data. diff --git a/docs/modules/reference/pages/service-assurance/monitors/JDBCStoredProcedureMonitor.adoc b/docs/modules/reference/pages/service-assurance/monitors/JDBCStoredProcedureMonitor.adoc index 33484fbb125f..816033f88cba 100644 --- a/docs/modules/reference/pages/service-assurance/monitors/JDBCStoredProcedureMonitor.adoc +++ b/docs/modules/reference/pages/service-assurance/monitors/JDBCStoredProcedureMonitor.adoc @@ -1,6 +1,6 @@ = JDBCStoredProcedureMonitor -:description: Learn about the JDBCStoredProcedureMonitor in {page-component-title} that checks the result of a stored procedure in a remote database. +:description: Learn about the JDBCStoredProcedureMonitor in OpenNMS {page-component-title} that checks the result of a stored procedure in a remote database. The JDBCStoredProcedureMonitor checks the result of a stored procedure in a remote database. The result of the stored procedure has to be a boolean value (representing true or false). diff --git a/docs/modules/reference/pages/service-assurance/monitors/JmxMonitor.adoc b/docs/modules/reference/pages/service-assurance/monitors/JmxMonitor.adoc index 1782079f2e42..2b76516fcd5a 100644 --- a/docs/modules/reference/pages/service-assurance/monitors/JmxMonitor.adoc +++ b/docs/modules/reference/pages/service-assurance/monitors/JmxMonitor.adoc @@ -1,6 +1,6 @@ [[poller-jmx-monitor]] = JmxMonitor -:description: Learn about the JmxMonitor in {page-component-title} that lets you test the service availability of Java applications. +:description: Learn about the JmxMonitor in OpenNMS {page-component-title} that lets you test the service availability of Java applications. The JMX monitor lets you test the service availability of Java applications. The monitor offers the following functionalities: diff --git a/docs/modules/reference/pages/service-assurance/monitors/JolokiaBeanMonitor.adoc b/docs/modules/reference/pages/service-assurance/monitors/JolokiaBeanMonitor.adoc index b7d27877a935..30c5b1335a88 100644 --- a/docs/modules/reference/pages/service-assurance/monitors/JolokiaBeanMonitor.adoc +++ b/docs/modules/reference/pages/service-assurance/monitors/JolokiaBeanMonitor.adoc @@ -1,6 +1,6 @@ = JolokiaBeanMonitor -:description: Learn about the JolokiaBeanMonitor in {page-component-title} that lets you run a method or poll an attribute via JMX using the Jolokia framework. +:description: Learn about the JolokiaBeanMonitor in OpenNMS {page-component-title} that lets you run a method or poll an attribute via JMX using the Jolokia framework. The JolokiaBeanMonitor is a JMX monitor specialized for the use with the link:http://www.jolokia.org[Jolokia framework]. Use the JolokiaBeanMonitor when you need to run a method via JMX or poll an attribute via JMX. diff --git a/docs/modules/reference/pages/service-assurance/monitors/LdapMonitor.adoc b/docs/modules/reference/pages/service-assurance/monitors/LdapMonitor.adoc index 578016ffc9e1..da8cec215eba 100644 --- a/docs/modules/reference/pages/service-assurance/monitors/LdapMonitor.adoc +++ b/docs/modules/reference/pages/service-assurance/monitors/LdapMonitor.adoc @@ -1,7 +1,7 @@ [[poller-ldap-monitor]] = LdapMonitor -:description: Learn about the LdapMonitor in {page-component-title} that tests for LDAP service availability. +:description: Learn about the LdapMonitor in OpenNMS {page-component-title} that tests for LDAP service availability. The LDAP monitor tests for LDAP service availability. The LDAP monitor first tries to establish a TCP connection on the specified port. diff --git a/docs/modules/reference/pages/service-assurance/monitors/LdapsMonitor.adoc b/docs/modules/reference/pages/service-assurance/monitors/LdapsMonitor.adoc index 9308dd7fadb3..caeb667f9c18 100644 --- a/docs/modules/reference/pages/service-assurance/monitors/LdapsMonitor.adoc +++ b/docs/modules/reference/pages/service-assurance/monitors/LdapsMonitor.adoc @@ -1,6 +1,6 @@ = LdapsMonitor -:description: Learn about the LdapsMonitor in {page-component-title} that tests the response of an SSL-enabled LDAP server. +:description: Learn about the LdapsMonitor in OpenNMS {page-component-title} that tests the response of an SSL-enabled LDAP server. The LDAPS monitor tests the response of an SSL-enabled LDAP server. The LDAPS monitor is an SSL-enabled extension of the LDAP monitor with a default TCP port value of 636. diff --git a/docs/modules/reference/pages/service-assurance/monitors/MailTransportMonitor.adoc b/docs/modules/reference/pages/service-assurance/monitors/MailTransportMonitor.adoc index f5ea32567449..1a9f8b24a698 100644 --- a/docs/modules/reference/pages/service-assurance/monitors/MailTransportMonitor.adoc +++ b/docs/modules/reference/pages/service-assurance/monitors/MailTransportMonitor.adoc @@ -1,6 +1,6 @@ = MailTransportMonitor -:description: Learn about the {page-component-title} MailTransportMonitor that runs a synthetic test of a full email transaction from sending to delivery confirmation. +:description: Learn about the OpenNMS {page-component-title} MailTransportMonitor that runs a synthetic test of a full email transaction (sending to delivery confirmation). The MailTransportMonitor runs a synthetic test of a complete email transaction, including sending a mail and determining that it has been delivered. It can also use both sendmail-test and readmail-test independently to determine whether an email can be sent or a mailbox can be read. diff --git a/docs/modules/reference/pages/service-assurance/monitors/MemcachedMonitor.adoc b/docs/modules/reference/pages/service-assurance/monitors/MemcachedMonitor.adoc index 43a441d8cc59..13c985e39e16 100644 --- a/docs/modules/reference/pages/service-assurance/monitors/MemcachedMonitor.adoc +++ b/docs/modules/reference/pages/service-assurance/monitors/MemcachedMonitor.adoc @@ -1,6 +1,6 @@ = MemcachedMonitor -:description: Learn about the MemcachedMonitor in {page-component-title} that monitors Memcached, a distributed memory object caching system. +:description: Learn about the MemcachedMonitor in OpenNMS {page-component-title} that monitors Memcached, a distributed memory object caching system. Monitors link:http://memcached.org[Memcached], a distributed memory object caching system. To monitor the service availability, the monitor tests if it can request the Memcached statistics. diff --git a/docs/modules/reference/pages/service-assurance/monitors/NetScalerGroupHealthMonitor.adoc b/docs/modules/reference/pages/service-assurance/monitors/NetScalerGroupHealthMonitor.adoc index ccb0b1ae2d29..4d3050373356 100644 --- a/docs/modules/reference/pages/service-assurance/monitors/NetScalerGroupHealthMonitor.adoc +++ b/docs/modules/reference/pages/service-assurance/monitors/NetScalerGroupHealthMonitor.adoc @@ -1,6 +1,6 @@ = NetScalerGroupHealthMonitor -:description: Learn about the NetScalerGroupHealthMonitor in {page-component-title} that performs Citrix and NetScaler load-balancing checks. +:description: Learn about the NetScalerGroupHealthMonitor in OpenNMS {page-component-title} that performs Citrix and NetScaler load-balancing checks. This monitor is designed for Citrix(R) NetScaler(R) load-balancing checks. It checks if more than x percent of the servers assigned to a specific group on a load-balanced service are active. diff --git a/docs/modules/reference/pages/service-assurance/monitors/NrpeMonitor.adoc b/docs/modules/reference/pages/service-assurance/monitors/NrpeMonitor.adoc index a15b1d57f900..d9d3962ed1eb 100644 --- a/docs/modules/reference/pages/service-assurance/monitors/NrpeMonitor.adoc +++ b/docs/modules/reference/pages/service-assurance/monitors/NrpeMonitor.adoc @@ -1,6 +1,6 @@ = NrpeMonitor -:description: Learn about the NrpeMonitor in {page-component-title} that lets you test plugins and checks running on the Nagios Remote Plugin Executor (NRPE) framework. +:description: Learn about the NrpeMonitor in OpenNMS {page-component-title} that lets you test plugins and checks running on the Nagios Remote Plugin Executor framework. The NrpeMonitor lets you test plugins and checks running on the link:https://exchange.nagios.org/directory/Addons/Monitoring-Agents/[Nagios Remote Plugin Executor] (NRPE) framework. diff --git a/docs/modules/reference/pages/service-assurance/monitors/NtpMonitor.adoc b/docs/modules/reference/pages/service-assurance/monitors/NtpMonitor.adoc index 8da506cc10cf..5ba550afef71 100644 --- a/docs/modules/reference/pages/service-assurance/monitors/NtpMonitor.adoc +++ b/docs/modules/reference/pages/service-assurance/monitors/NtpMonitor.adoc @@ -1,6 +1,6 @@ = NtpMonitor -:description: Learn about the NtpMonitor in {page-component-title} that tests for NTP service availability. +:description: Learn about the NtpMonitor in OpenNMS {page-component-title} that tests for NTP service availability. The NTP monitor tests for NTP service availability. During the poll, an NTP request query packet is generated. diff --git a/docs/modules/reference/pages/service-assurance/monitors/OmsaStorageMonitor.adoc b/docs/modules/reference/pages/service-assurance/monitors/OmsaStorageMonitor.adoc index 5e423503cf99..83cc4a14cd38 100644 --- a/docs/modules/reference/pages/service-assurance/monitors/OmsaStorageMonitor.adoc +++ b/docs/modules/reference/pages/service-assurance/monitors/OmsaStorageMonitor.adoc @@ -1,7 +1,7 @@ [[OmsaStorageMonitor]] = OmsaStorageMonitor -:description: Learn about the OmsaStorageMonitor in {page-component-title} that lets you monitor your Dell OpenManaged server RAID array status. +:description: Learn about the OmsaStorageMonitor in OpenNMS {page-component-title} that lets you monitor your Dell OpenManaged server RAID array status. The OmsaStorageMonitor lets you monitor your https://www.dell.com/support/kbdoc/en-ca/000126778/how-to-dell-server-manage-multiple-servers-with-omsa-and-ome[Dell OpenManaged] server RAID array status. This monitor supports the following OIDs from the https://www.dell.com/support/manuals/en-ca/dell-openmanage-software-9.1/snmp_om_9.1_reference%20guide/server-administrator-storage-management-mib?guid=guid-a067ce36-3019-4bf6-8ce4-d92ad428194d&lang=en-us[STORAGEMANAGEMENT-MIB]: diff --git a/docs/modules/reference/pages/service-assurance/monitors/OpenManageChassisMonitor.adoc b/docs/modules/reference/pages/service-assurance/monitors/OpenManageChassisMonitor.adoc index 45dfe40b4cb5..bd6da5360e3f 100644 --- a/docs/modules/reference/pages/service-assurance/monitors/OpenManageChassisMonitor.adoc +++ b/docs/modules/reference/pages/service-assurance/monitors/OpenManageChassisMonitor.adoc @@ -1,6 +1,6 @@ = OpenManageChassisMonitor -:description: Learn about the OpenManageChassisMonitor in {page-component-title} that tests the status of a Dell chassis by querying its SNMP agent. +:description: Learn about the OpenManageChassisMonitor in OpenNMS {page-component-title} that tests the status of a Dell chassis by querying its SNMP agent. The OpenManageChassis monitor tests the status of a Dell chassis by querying its SNMP agent. The monitor polls the value of the node's SNMP OID .1.3.6.1.4.1.674.10892.1.300.10.1.4.1 (MIB-Dell-10892::chassisStatus). diff --git a/docs/modules/reference/pages/service-assurance/monitors/PassiveStatusMonitor.adoc b/docs/modules/reference/pages/service-assurance/monitors/PassiveStatusMonitor.adoc index 5c9a8ccfe68b..4012e2fe61eb 100644 --- a/docs/modules/reference/pages/service-assurance/monitors/PassiveStatusMonitor.adoc +++ b/docs/modules/reference/pages/service-assurance/monitors/PassiveStatusMonitor.adoc @@ -1,6 +1,6 @@ = PassiveStatusMonitor -:description: Learn how to configure and use the PassiveStatusMonitor in {page-component-title} to maintain the status of passive services in memory with a hash table. +:description: Learn how to configure the PassiveStatusMonitor in OpenNMS {page-component-title} to maintain the status of passive services in memory with a hash table. Passive nodes are nodes that {page-component-title} is unable to directly communicate with because either they are 'not real' or because there is no network path directly to the device. They are termed 'Passive' because {page-component-title} cannot actively poll them and instead passively relies on information sent from somewhere else. diff --git a/docs/modules/reference/pages/service-assurance/monitors/PercMonitor.adoc b/docs/modules/reference/pages/service-assurance/monitors/PercMonitor.adoc index f8d75d42af69..4231a026f59e 100644 --- a/docs/modules/reference/pages/service-assurance/monitors/PercMonitor.adoc +++ b/docs/modules/reference/pages/service-assurance/monitors/PercMonitor.adoc @@ -1,6 +1,6 @@ = PercMonitor -:description: Learn how to configure and use the PercMonitor in {page-component-title} to test the status of a PowerEdge Expandable RAID Controller (PERC) RAID array. +:description: Learn how to configure the PercMonitor in OpenNMS {page-component-title} to test the status of a PowerEdge Expandable RAID Controller (PERC) RAID array. This monitor tests the status of a PERC RAID array. diff --git a/docs/modules/reference/pages/service-assurance/monitors/Pop3Monitor.adoc b/docs/modules/reference/pages/service-assurance/monitors/Pop3Monitor.adoc index 52aaa650153a..3ce381aa093e 100644 --- a/docs/modules/reference/pages/service-assurance/monitors/Pop3Monitor.adoc +++ b/docs/modules/reference/pages/service-assurance/monitors/Pop3Monitor.adoc @@ -1,6 +1,6 @@ = Pop3Monitor -:description: Learn how to configure and use the Pop3Monitor in {page-component-title} to test for POP3 service availability on a node. +:description: Learn how to configure and use the Pop3Monitor in OpenNMS {page-component-title} to test for POP3 service availability on a node. The POP3 monitor tests for POP3 service availability on a node. The monitor first tries to establish a TCP connection on the specified port. diff --git a/docs/modules/reference/pages/service-assurance/monitors/PrTableMonitor.adoc b/docs/modules/reference/pages/service-assurance/monitors/PrTableMonitor.adoc index aa4539b00fb7..fa1fadaf73a2 100644 --- a/docs/modules/reference/pages/service-assurance/monitors/PrTableMonitor.adoc +++ b/docs/modules/reference/pages/service-assurance/monitors/PrTableMonitor.adoc @@ -1,6 +1,6 @@ = PrTableMonitor -:description: Learn how to configure and use the PrTableMonitor in {page-component-title} to test the prTable of a Net-SNMP agent. +:description: Learn how to configure and use the PrTableMonitor in OpenNMS {page-component-title} to test the prTable of a Net-SNMP agent. The PrTableMonitor monitor tests the link:http://www.net-snmp.org/docs/mibs/ucdavis.html#prTable[prTable] of a Net-SNMP agent. diff --git a/docs/modules/reference/pages/service-assurance/monitors/RadiusAuthMonitor.adoc b/docs/modules/reference/pages/service-assurance/monitors/RadiusAuthMonitor.adoc index b27c3e8cd8f1..98f20a3ab1f3 100644 --- a/docs/modules/reference/pages/service-assurance/monitors/RadiusAuthMonitor.adoc +++ b/docs/modules/reference/pages/service-assurance/monitors/RadiusAuthMonitor.adoc @@ -1,6 +1,6 @@ = RadiusAuthMonitor -:description: Learn how to configure and use the RadiusAuthMonitor in {page-component-title} to test the functionality of the RADIUS authentication system. +:description: Learn how to configure and use the RadiusAuthMonitor in OpenNMS {page-component-title} to test the functionality of the RADIUS authentication system. This monitor lets you test the functionality of the link:http://freeradius.org/rfc/rfc2865.html[RADIUS] authentication system. The availability is tested by sending an AUTH packet to the RADIUS server. diff --git a/docs/modules/reference/pages/service-assurance/monitors/SSLCertMonitor.adoc b/docs/modules/reference/pages/service-assurance/monitors/SSLCertMonitor.adoc index 63e827f7d514..74373561c909 100644 --- a/docs/modules/reference/pages/service-assurance/monitors/SSLCertMonitor.adoc +++ b/docs/modules/reference/pages/service-assurance/monitors/SSLCertMonitor.adoc @@ -1,6 +1,6 @@ = SSLCertMonitor -:description: Learn how to configure and use the SSLCertMonitor in {page-component-title} to test if an SSL certificate a remote network server presents is valid. +:description: Learn how to configure and use the SSLCertMonitor in OpenNMS {page-component-title} to test if an SSL certificate a remote network server presents is valid. This monitor tests if an SSL certificate a remote network server presents is valid. A certificate is invalid if its initial time is prior to the current time, if the current time is within the configured number of days before the expiration time, or if the common name is valid. diff --git a/docs/modules/reference/pages/service-assurance/monitors/SmbMonitor.adoc b/docs/modules/reference/pages/service-assurance/monitors/SmbMonitor.adoc index 3fa76d0033b8..d2369da45e0d 100644 --- a/docs/modules/reference/pages/service-assurance/monitors/SmbMonitor.adoc +++ b/docs/modules/reference/pages/service-assurance/monitors/SmbMonitor.adoc @@ -1,6 +1,6 @@ = SmbMonitor -:description: Learn how to configure and use the SmbMonitor in {page-component-title} to test the NetBIOS over TCP/IP name resolution in Microsoft Windows environments. +:description: Learn how to configure and use the SmbMonitor in OpenNMS {page-component-title} to test the NetBIOS over TCP/IP name resolution in Microsoft Windows environments. This monitor tests the NetBIOS over TCP/IP name resolution in Microsoft Windows environments. The monitor tries to retrieve a NetBIOS name for the IP address of the interface. diff --git a/docs/modules/reference/pages/service-assurance/monitors/SmtpMonitor.adoc b/docs/modules/reference/pages/service-assurance/monitors/SmtpMonitor.adoc index d25bbeceabac..515562eac376 100644 --- a/docs/modules/reference/pages/service-assurance/monitors/SmtpMonitor.adoc +++ b/docs/modules/reference/pages/service-assurance/monitors/SmtpMonitor.adoc @@ -1,6 +1,6 @@ = SmtpMonitor -:description: Learn how to configure and use the SmtpMonitor in {page-component-title} to test for SMTP service availability on a node. +:description: Learn how to configure and use the SmtpMonitor in OpenNMS {page-component-title} to test for SMTP service availability on a node. The SMTP monitor tests for SMTP service availability on a node. The monitor first tries to establish a TCP connection on the specified port. diff --git a/docs/modules/reference/pages/service-assurance/monitors/SnmpMonitor.adoc b/docs/modules/reference/pages/service-assurance/monitors/SnmpMonitor.adoc index 57fec41b6029..203a56c82dd1 100644 --- a/docs/modules/reference/pages/service-assurance/monitors/SnmpMonitor.adoc +++ b/docs/modules/reference/pages/service-assurance/monitors/SnmpMonitor.adoc @@ -1,6 +1,6 @@ = SnmpMonitor -:description: Learn how to configure and use the SnmpMonitor in {page-component-title} to provide a common platform to monitor states and results from SNMP agents. +:description: Learn how to configure and use the SnmpMonitor in OpenNMS {page-component-title} to provide a common platform to monitor states and results from SNMP agents. The SNMP monitor provides a common platform to monitor states and results from SNMP agents. diff --git a/docs/modules/reference/pages/service-assurance/monitors/SshMonitor.adoc b/docs/modules/reference/pages/service-assurance/monitors/SshMonitor.adoc index 68cf61c34e8f..22932a403963 100644 --- a/docs/modules/reference/pages/service-assurance/monitors/SshMonitor.adoc +++ b/docs/modules/reference/pages/service-assurance/monitors/SshMonitor.adoc @@ -1,6 +1,6 @@ = SshMonitor -:description: Learn how to configure and use the SshMonitor in {page-component-title} to test the availability of an SSH service. +:description: Learn how to configure and use the SshMonitor in OpenNMS {page-component-title} to test the availability of an SSH service. The SshMonitor tests the availability of an SSH service. During the poll, it attempts to connect on the specified port. diff --git a/docs/modules/reference/pages/service-assurance/monitors/StrafePingMonitor.adoc b/docs/modules/reference/pages/service-assurance/monitors/StrafePingMonitor.adoc index 8a8b15a5478c..9be4142f1272 100644 --- a/docs/modules/reference/pages/service-assurance/monitors/StrafePingMonitor.adoc +++ b/docs/modules/reference/pages/service-assurance/monitors/StrafePingMonitor.adoc @@ -1,5 +1,5 @@ = StrafePingMonitor -:description: Learn how to configure and use the StrafePingMonitor in {page-component-title} to use ICMP to monitor a specific endpoint and visualize packet loss. +:description: Learn how to configure and use the StrafePingMonitor in OpenNMS {page-component-title} to use ICMP to monitor a specific endpoint and visualize packet loss. This monitor uses ICMP to monitor http://en.wikipedia.org/wiki/Packet_delay_variation[packet delay variation] to a specific endpoint. The main use case is to monitor a WAN endpoint and visualize packet loss and ICMP packet round-trip time deviation. diff --git a/docs/modules/reference/pages/service-assurance/monitors/SystemExecuteMonitor.adoc b/docs/modules/reference/pages/service-assurance/monitors/SystemExecuteMonitor.adoc index bc1e0fe447e8..1c5b3c11dbec 100644 --- a/docs/modules/reference/pages/service-assurance/monitors/SystemExecuteMonitor.adoc +++ b/docs/modules/reference/pages/service-assurance/monitors/SystemExecuteMonitor.adoc @@ -1,6 +1,6 @@ = SystemExecuteMonitor -:description: Learn how to configure and use the SystemExecuteMonitor in {page-component-title} to run a system call or a script to determine a service status. +:description: Learn how to configure and use the SystemExecuteMonitor in OpenNMS {page-component-title} to run a system call or a script to determine a service status. If you need to run a system call or a script to determine a service status, use the SystemExecuteMonitor. The monitor calls a script or system command and determines service status based on the return of a `0` or a `non-0` exit code. diff --git a/docs/modules/reference/pages/service-assurance/monitors/TcpMonitor.adoc b/docs/modules/reference/pages/service-assurance/monitors/TcpMonitor.adoc index ddad0059c4b9..89359758072f 100644 --- a/docs/modules/reference/pages/service-assurance/monitors/TcpMonitor.adoc +++ b/docs/modules/reference/pages/service-assurance/monitors/TcpMonitor.adoc @@ -1,6 +1,6 @@ = TcpMonitor -:description: Learn how to configure and use the TcpMonitor in {page-component-title} to use TCP to test OSI Layer 4 connectivity. +:description: Learn how to configure and use the TcpMonitor in OpenNMS {page-component-title} to use TCP to test OSI Layer 4 connectivity. This monitor uses TCP to test OSI Layer 4 connectivity. The monitor establishes a TCP connection to a specific port. diff --git a/docs/modules/reference/pages/service-assurance/monitors/TrivialTimeMonitor.adoc b/docs/modules/reference/pages/service-assurance/monitors/TrivialTimeMonitor.adoc index f8a227abb57c..ccb1f6e06017 100644 --- a/docs/modules/reference/pages/service-assurance/monitors/TrivialTimeMonitor.adoc +++ b/docs/modules/reference/pages/service-assurance/monitors/TrivialTimeMonitor.adoc @@ -1,6 +1,6 @@ = TrivialTimeMonitor -:description: Learn about the TrivialTimeMonitor in {page-component-title} to send the time as a 32-bit unsigned integer in binary format, in network byte order. +:description: Learn about the TrivialTimeMonitor in OpenNMS {page-component-title} to send the time as a 32-bit unsigned integer in binary format, in network byte order. TrivialTimeMonitor connects to a server that supports the Time Protocol and sends the time as a 32-bit unsigned integer in binary format and in network byte order, representing the number of seconds since 00:00 (midnight) 1 January, 1900 GMT, and fails if the defined clock skew is too large. NOTE: This detector uses the Time Protocol, not NTP. diff --git a/docs/modules/reference/pages/service-assurance/monitors/VmwareCimMonitor.adoc b/docs/modules/reference/pages/service-assurance/monitors/VmwareCimMonitor.adoc index 93e7a99b09fe..f6897a3cdfe5 100644 --- a/docs/modules/reference/pages/service-assurance/monitors/VmwareCimMonitor.adoc +++ b/docs/modules/reference/pages/service-assurance/monitors/VmwareCimMonitor.adoc @@ -1,6 +1,6 @@ = VmwareCimMonitor -:description: Learn how to configure and use the VmwareCimMonitor in {page-component-title} to test the health status provided from all host system (host) sensor data. +:description: Learn how to configure and use the VmwareCimMonitor in OpenNMS {page-component-title} to test the health status from all host system (host) sensor data. This monitor is part of the VMware integration provided by Provisiond. The monitor is specialized to test the health status provided from all host system (host) sensor data. diff --git a/docs/modules/reference/pages/service-assurance/monitors/VmwareMonitor.adoc b/docs/modules/reference/pages/service-assurance/monitors/VmwareMonitor.adoc index fccce4b0a897..d06f3e7cebbd 100644 --- a/docs/modules/reference/pages/service-assurance/monitors/VmwareMonitor.adoc +++ b/docs/modules/reference/pages/service-assurance/monitors/VmwareMonitor.adoc @@ -1,6 +1,6 @@ = VmwareMonitor -:description: Learn how to configure and use the VmwareMonitor in {page-component-title} to test the power state of a virtual machine or host system. +:description: Learn how to configure and use the VmwareMonitor in OpenNMS {page-component-title} to test the power state of a virtual machine or host system. This monitor is part of the VMWare integration that provisiond provides. It tests the power state of a virtual machine or host system. diff --git a/docs/modules/reference/pages/service-assurance/monitors/WebMonitor.adoc b/docs/modules/reference/pages/service-assurance/monitors/WebMonitor.adoc index e73f56b3f224..676bd9bf563b 100644 --- a/docs/modules/reference/pages/service-assurance/monitors/WebMonitor.adoc +++ b/docs/modules/reference/pages/service-assurance/monitors/WebMonitor.adoc @@ -1,6 +1,6 @@ = WebMonitor -:description: Learn how to configure and use the WebMonitor in {page-component-title} for performing HTTP connections using Apache HttpClient. +:description: Learn how to configure and use the WebMonitor in OpenNMS {page-component-title} for performing HTTP connections using Apache HttpClient. WebMonitor is a clone of <>, that uses a different underlying library for doing HTTP connections. WebMonitor uses Apache HttpClient, which acts more like a real browser (follows redirects, and so on) than HttpMonitor. diff --git a/docs/modules/reference/pages/service-assurance/monitors/WmiMonitor.adoc b/docs/modules/reference/pages/service-assurance/monitors/WmiMonitor.adoc index 02112f505072..fb89e70bddde 100644 --- a/docs/modules/reference/pages/service-assurance/monitors/WmiMonitor.adoc +++ b/docs/modules/reference/pages/service-assurance/monitors/WmiMonitor.adoc @@ -1,6 +1,6 @@ = WmiMonitor -:description: Learn how to configure and use the WmiMonitor in {page-component-title} to test the availability of WMI services on remote interfaces. +:description: Learn how to configure and use the WmiMonitor in OpenNMS {page-component-title} to test the availability of WMI services on remote interfaces. The WMI monitor tests the availability of WMI services on remote interfaces. diff --git a/docs/modules/reference/pages/service-assurance/monitors/WsManMonitor.adoc b/docs/modules/reference/pages/service-assurance/monitors/WsManMonitor.adoc index 1d618ba890db..646f0e9a730e 100644 --- a/docs/modules/reference/pages/service-assurance/monitors/WsManMonitor.adoc +++ b/docs/modules/reference/pages/service-assurance/monitors/WsManMonitor.adoc @@ -1,6 +1,6 @@ = WsManMonitor -:description: Learn about the WsManMonitor in {page-component-title} to issue a WS-Man GET command and validate the results using a Spring language expression (SPEL). +:description: Learn about the WsManMonitor in OpenNMS {page-component-title} to issue a WS-Man GET command and validate the results using a Spring language expression. Use this monitor to issue a WS-Man GET command and validate the results using a link:http://docs.spring.io/spring/docs/current/spring-framework-reference/html/expressions.html[SPEL] expression. diff --git a/docs/modules/reference/pages/telemetryd/introduction.adoc b/docs/modules/reference/pages/telemetryd/introduction.adoc index b26c2655731b..3e3eb92cc57d 100644 --- a/docs/modules/reference/pages/telemetryd/introduction.adoc +++ b/docs/modules/reference/pages/telemetryd/introduction.adoc @@ -1,6 +1,6 @@ [[ref-telemetryd]] = Telemetryd -:description: Overview of telemetryd documentation in {page-component-title}. +:description: Overview of telemetryd documentation in OpenNMS {page-component-title}. The xref:operation:deep-dive/telemetryd/introduction.adoc[Telemetryd] service collects sensor data sent from nodes to {page-component-title}. You can configure Listeners and Protocols to configure the service to accept data from the specific types of devices on your network. \ No newline at end of file diff --git a/docs/modules/reference/pages/telemetryd/listeners/introduction.adoc b/docs/modules/reference/pages/telemetryd/listeners/introduction.adoc index ddab548f2ee7..d8ca8e02ba5d 100644 --- a/docs/modules/reference/pages/telemetryd/listeners/introduction.adoc +++ b/docs/modules/reference/pages/telemetryd/listeners/introduction.adoc @@ -1,6 +1,6 @@ [[ref-listener]] = Listener Reference -:description: Overview of telemetryd listener documentation in {page-component-title}. +:description: Overview of telemetryd listener documentation in OpenNMS {page-component-title}. This section describes the available telemetryd listeners. diff --git a/docs/modules/reference/pages/telemetryd/listeners/tcp.adoc b/docs/modules/reference/pages/telemetryd/listeners/tcp.adoc index f508c7df2d43..9c4f8be00197 100644 --- a/docs/modules/reference/pages/telemetryd/listeners/tcp.adoc +++ b/docs/modules/reference/pages/telemetryd/listeners/tcp.adoc @@ -1,7 +1,7 @@ [[telemetryd-listener-tcp]] = TCP Listener -:description: Learn how the TCP listener in {page-component-title} accepts incoming TCP connections and forwards the TCP stream to a single parser. +:description: Learn how the TCP listener in OpenNMS {page-component-title} accepts incoming TCP connections and forwards the TCP stream to a single parser. The TCP Listener accepts incoming TCP connections and forwards the TCP stream to a single parser. diff --git a/docs/modules/reference/pages/telemetryd/listeners/udp.adoc b/docs/modules/reference/pages/telemetryd/listeners/udp.adoc index 92aa7cc8cbe2..b78cb27cc255 100644 --- a/docs/modules/reference/pages/telemetryd/listeners/udp.adoc +++ b/docs/modules/reference/pages/telemetryd/listeners/udp.adoc @@ -1,7 +1,7 @@ [[telemetryd-listener-udp]] = UDP Listener -:description: Learn how to configure and use the UDP listener in {page-component-title} to open a UDP socket and forward the received packets to a parser. +:description: Learn how to configure and use the UDP listener in OpenNMS {page-component-title} to open a UDP socket and forward the received packets to a parser. Use the UDP listener to open a UDP socket and forward the received packets to a parser. diff --git a/docs/modules/reference/pages/telemetryd/protocols/bmp/adapter.adoc b/docs/modules/reference/pages/telemetryd/protocols/bmp/adapter.adoc index c31c5686d9ce..9c2fce5a55d0 100644 --- a/docs/modules/reference/pages/telemetryd/protocols/bmp/adapter.adoc +++ b/docs/modules/reference/pages/telemetryd/protocols/bmp/adapter.adoc @@ -1,7 +1,7 @@ [[telemetryd-bmp-statistics-adapter]] = BMP Telemetry Adapter -:description: Learn about the BMP telemetry adapter in {page-component-title} that handles BMP statistics that the BMP parser receives and parses. +:description: Learn about the BMP telemetry adapter in OpenNMS {page-component-title} that handles BMP statistics that the BMP parser receives and parses. The BMP telemetry adapter handles BMP statistics that the xref:telemetryd/protocols/bmp/parser.adoc[BMP parser] receives and parses. Statistics received from the router are associated as performance data with that router. diff --git a/docs/modules/reference/pages/telemetryd/protocols/bmp/bmp.adoc b/docs/modules/reference/pages/telemetryd/protocols/bmp/bmp.adoc index 1681d1aa3106..199f4447b771 100644 --- a/docs/modules/reference/pages/telemetryd/protocols/bmp/bmp.adoc +++ b/docs/modules/reference/pages/telemetryd/protocols/bmp/bmp.adoc @@ -1,6 +1,6 @@ = BGP Monitoring Protocol -:description: Learn how the BGP Monitoring Protocol (BMP) integration in {page-component-title} helps you to see what the Border Gateway Protocol is doing. +:description: Learn how the BGP Monitoring Protocol (BMP) integration in OpenNMS {page-component-title} helps you to see what the Border Gateway Protocol is doing. The https://datatracker.ietf.org/doc/html/rfc7854[BGP Monitoring Protocol] (BMP) monitors Border Gateway Protocol (BGP) sessions and provides a convenient interface to monitor BGP routing information on the routing device. diff --git a/docs/modules/reference/pages/telemetryd/protocols/bmp/integration-adapter.adoc b/docs/modules/reference/pages/telemetryd/protocols/bmp/integration-adapter.adoc index 2a5548aa0795..f13617e10857 100644 --- a/docs/modules/reference/pages/telemetryd/protocols/bmp/integration-adapter.adoc +++ b/docs/modules/reference/pages/telemetryd/protocols/bmp/integration-adapter.adoc @@ -1,7 +1,7 @@ [[telemetryd-openbmp-integration-adapter]] = OpenBMP Integration Adapter -:description: Learn about the OpenBMP integration adapter in {page-component-title} that handles BMP statistics that the BMP parser receives and parses. +:description: Learn about the OpenBMP integration adapter in OpenNMS {page-component-title} that handles BMP statistics the BMP parser receives and parses. The OpenBMP integration adapter can integrate with an existing https://github.com/OpenBMP[OpenBMP] installation. It handles BMP messages the xref:telemetryd/protocols/bmp/parser.adoc[BMP parser] receives and parses, and creates OpenBMP-compatible messages, which are then passed to the OpenBMP Kafka cluster. diff --git a/docs/modules/reference/pages/telemetryd/protocols/bmp/parser.adoc b/docs/modules/reference/pages/telemetryd/protocols/bmp/parser.adoc index 143f0631cb22..ebcd6ca4f648 100644 --- a/docs/modules/reference/pages/telemetryd/protocols/bmp/parser.adoc +++ b/docs/modules/reference/pages/telemetryd/protocols/bmp/parser.adoc @@ -2,6 +2,7 @@ [[telemetryd-bmp-parser]] = BMP TCP Parser +:description: Learn about the BMP parser in OpenNMS {page-component-title} that accepts BMP connections from router packets using a TCP listener. The BMP parser accepts BMP connections from router packets using a <>. diff --git a/docs/modules/reference/pages/telemetryd/protocols/bmp/peer-status.adoc b/docs/modules/reference/pages/telemetryd/protocols/bmp/peer-status.adoc index aa62e46d3b0b..7c4a15e56145 100644 --- a/docs/modules/reference/pages/telemetryd/protocols/bmp/peer-status.adoc +++ b/docs/modules/reference/pages/telemetryd/protocols/bmp/peer-status.adoc @@ -1,6 +1,7 @@ [[telemetryd-bmp-peer-status-adapter]] = BMP Peer Status Adapter +:description: Learn about the BMP Peer Status adapter in OpenNMS {page-component-title} that creates events for peer status changes. The BMP peer status adapter creates events for peer status changes. It handles BMP Peer Up and Down messages that the xref:telemetryd/protocols/bmp/parser.adoc[BMP parser] receives and parses, and converts them to {page-component-title} events. diff --git a/docs/modules/reference/pages/telemetryd/protocols/bmp/persisting-adapter.adoc b/docs/modules/reference/pages/telemetryd/protocols/bmp/persisting-adapter.adoc index 7359cf201859..68678c07e5cf 100644 --- a/docs/modules/reference/pages/telemetryd/protocols/bmp/persisting-adapter.adoc +++ b/docs/modules/reference/pages/telemetryd/protocols/bmp/persisting-adapter.adoc @@ -1,6 +1,7 @@ [[telemetryd-bmp-persisting-adapter]] = BMP Persisting Adapter +:description: Learn about the BMP Persisting adapter in OpenNMS {page-component-title} that persists OpenBMP messages received without the need for additional OpenBMP components. The BMP persisting adapter persists OpenBMP messages received without the need for any additional OpenBMP components. It handles BMP messages the xref:telemetryd/protocols/bmp/parser.adoc[BMP parser] receives and parses, and creates OpenBMP-compatible messages, which are then diff --git a/docs/modules/reference/pages/telemetryd/protocols/graphite.adoc b/docs/modules/reference/pages/telemetryd/protocols/graphite.adoc index c368b3b3a2dc..855b10fb0346 100644 --- a/docs/modules/reference/pages/telemetryd/protocols/graphite.adoc +++ b/docs/modules/reference/pages/telemetryd/protocols/graphite.adoc @@ -1,6 +1,6 @@ = Graphite Telemetry -:description: Learn how the Graphite telemetry adapter uses the plaintext protocol push telemetry data over UDP to {page-component-title}. +:description: Learn how the Graphite telemetry adapter uses the plaintext protocol push telemetry data over UDP to OpenNMS {page-component-title}. The Graphite telemetry adapter lets you push telemetry data over UDP to {page-component-title} using the link:https://graphite.readthedocs.io/en/latest/feeding-carbon.html#the-plaintext-protocol[plaintext protocol]. diff --git a/docs/modules/reference/pages/telemetryd/protocols/introduction.adoc b/docs/modules/reference/pages/telemetryd/protocols/introduction.adoc index f9870b314bf4..42977d1488e5 100644 --- a/docs/modules/reference/pages/telemetryd/protocols/introduction.adoc +++ b/docs/modules/reference/pages/telemetryd/protocols/introduction.adoc @@ -1,6 +1,6 @@ [[ref-protocol]] = Protocol Reference -:description: Overview of the telemetryd protocol adapters section in the {page-component-title} documentation for parsing flow and/or telemetry data. +:description: Overview of the telemetryd protocol adapters section in the OpenNMS {page-component-title} documentation for parsing flow and/or telemetry data. This section describes the available telemetryd protocol adapters for parsing flow and/or telemetry data. diff --git a/docs/modules/reference/pages/telemetryd/protocols/ipfix.adoc b/docs/modules/reference/pages/telemetryd/protocols/ipfix.adoc index ecef0853bdd3..0211f0a5722a 100644 --- a/docs/modules/reference/pages/telemetryd/protocols/ipfix.adoc +++ b/docs/modules/reference/pages/telemetryd/protocols/ipfix.adoc @@ -1,6 +1,6 @@ = IPFIX -:description: Learn how the IPFIX UDP and TCP parsers in {page-component-title} accept packets from UDP/TCP listeners and forward them to an IPFIX adapter. +:description: Learn how the IPFIX UDP and TCP parsers in OpenNMS {page-component-title} accept packets from UDP/TCP listeners and forward them to an IPFIX adapter. The IP Flow Information Export (IPFIX) protocol is a vendor-neutral standard for transmitting traffic flow information. See <> for details on flow support in {page-component-title}. diff --git a/docs/modules/reference/pages/telemetryd/protocols/jti.adoc b/docs/modules/reference/pages/telemetryd/protocols/jti.adoc index 972f9bc2fbc7..c9048790b552 100644 --- a/docs/modules/reference/pages/telemetryd/protocols/jti.adoc +++ b/docs/modules/reference/pages/telemetryd/protocols/jti.adoc @@ -1,6 +1,6 @@ = Junos Telemetry Interface -:description: Learn how to the Junos Telemetry Interface (JTI) lets you push operational statistics asynchronously to {page-component-title}. +:description: Learn how to the Junos Telemetry Interface (JTI) lets you push operational statistics asynchronously to OpenNMS {page-component-title}. The Junos Telemetry Interface (JTI) lets you push operational statistics asynchronously to {page-component-title}. {page-component-title} sends a request to stream periodic updates once to the device. diff --git a/docs/modules/reference/pages/telemetryd/protocols/netflow5.adoc b/docs/modules/reference/pages/telemetryd/protocols/netflow5.adoc index 01ae3be19c96..c727d80a0e90 100644 --- a/docs/modules/reference/pages/telemetryd/protocols/netflow5.adoc +++ b/docs/modules/reference/pages/telemetryd/protocols/netflow5.adoc @@ -1,6 +1,6 @@ = NetFlow v5 -:description: Learn how to use and configure NetFLow v5 UDP parser and adapter in {page-component-title}. +:description: Learn how to use and configure NetFLow v5 UDP parser and adapter in OpenNMS {page-component-title}. See <> for details on flow support in {page-component-title}. diff --git a/docs/modules/reference/pages/telemetryd/protocols/netflow9.adoc b/docs/modules/reference/pages/telemetryd/protocols/netflow9.adoc index 8829a842d4a6..6d978c62286e 100644 --- a/docs/modules/reference/pages/telemetryd/protocols/netflow9.adoc +++ b/docs/modules/reference/pages/telemetryd/protocols/netflow9.adoc @@ -1,6 +1,6 @@ = NetFlow v9 -:description: Learn how to use and configure NetFLow v9 UDP parser and adapter in {page-component-title}. +:description: Learn how to use and configure NetFLow v9 UDP parser and adapter in OpenNMS {page-component-title}. See <> for details on flow support in {page-component-title}. diff --git a/docs/modules/reference/pages/telemetryd/protocols/nxos.adoc b/docs/modules/reference/pages/telemetryd/protocols/nxos.adoc index 5f3e76730583..fa17dae8fa2e 100644 --- a/docs/modules/reference/pages/telemetryd/protocols/nxos.adoc +++ b/docs/modules/reference/pages/telemetryd/protocols/nxos.adoc @@ -1,6 +1,6 @@ = Cisco NX-OS Telemetry -:description: Learn how to enable support for Cisco NX-OS telemetry to push operational statistic asynchronously in {page-component-title}. +:description: Learn how to enable support for Cisco NX-OS telemetry to push operational statistic asynchronously in OpenNMS {page-component-title}. The Cisco NX-OS Telemetry lets you push operational statistics asynchronously to {page-component-title}. {page-component-title} sends a request to stream periodic updates once to the device. diff --git a/docs/modules/reference/pages/telemetryd/protocols/openconfig.adoc b/docs/modules/reference/pages/telemetryd/protocols/openconfig.adoc index 728e2f866ac8..7ed9decbc9c5 100644 --- a/docs/modules/reference/pages/telemetryd/protocols/openconfig.adoc +++ b/docs/modules/reference/pages/telemetryd/protocols/openconfig.adoc @@ -1,6 +1,6 @@ = OpenConfig Telemetry -:description: Learn how to stream OpenConfig telemetry data over gRPC to {page-component-title}. +:description: Learn how to stream OpenConfig telemetry data over gRPC to OpenNMS {page-component-title}. https://www.openconfig.net/[OpenConfig] is an open-source initiative by network operators to develop vendor-neutral data models, programmatic interfaces, and tools for managing networks. diff --git a/docs/modules/reference/pages/telemetryd/protocols/sflow.adoc b/docs/modules/reference/pages/telemetryd/protocols/sflow.adoc index 919dd4578702..7aded8f1f485 100644 --- a/docs/modules/reference/pages/telemetryd/protocols/sflow.adoc +++ b/docs/modules/reference/pages/telemetryd/protocols/sflow.adoc @@ -1,6 +1,6 @@ = sFlow -:description: Learn how to use and configure the sFlow UDP parser, adapter, and telemetry adapter in {page-component-title}. +:description: Learn how to use and configure the sFlow UDP parser, adapter, and telemetry adapter in OpenNMS {page-component-title}. sFlow is capable of transporting both telemetry data and flow information. {page-component-title} can use both data types and extract and persist accordingly. diff --git a/docs/modules/reference/pages/ticketing/introduction.adoc b/docs/modules/reference/pages/ticketing/introduction.adoc index 37c2fb8a1d45..11d66bd1f896 100644 --- a/docs/modules/reference/pages/ticketing/introduction.adoc +++ b/docs/modules/reference/pages/ticketing/introduction.adoc @@ -1,6 +1,6 @@ [[ref-ticketer]] = Ticketer -:description: Overview of the ticketing section in the {page-component-title} documentation. +:description: Overview of the ticketing section in the OpenNMS {page-component-title} documentation. This section describes all available built-in ticketers for use with our xref:operation:deep-dive/ticketing/introduction.adoc[ticketing] service. diff --git a/docs/modules/troubleshooting/pages/log-information.adoc b/docs/modules/troubleshooting/pages/log-information.adoc index 0383b277d86b..d57423edf2de 100644 --- a/docs/modules/troubleshooting/pages/log-information.adoc +++ b/docs/modules/troubleshooting/pages/log-information.adoc @@ -1,5 +1,6 @@ = {page-component-title} Log Files +:description: Learn how to use log files in OpenNMS {page-component-title} to help with troubleshooting, and how to set the debugging level. This section describes common log files to look at when troubleshooting. diff --git a/docs/modules/troubleshooting/pages/other-issues.adoc b/docs/modules/troubleshooting/pages/other-issues.adoc index 6c4822bb24ec..8b32fb38939d 100644 --- a/docs/modules/troubleshooting/pages/other-issues.adoc +++ b/docs/modules/troubleshooting/pages/other-issues.adoc @@ -1,5 +1,6 @@ = Other Errors +:description: Read about errors you may encounter if OpenNMS {page-component-title} does not start as expected, and how to fix them. This section describes other errors that you may encounter when {page-component-title} does not start as expected. diff --git a/docs/modules/troubleshooting/pages/overview.adoc b/docs/modules/troubleshooting/pages/overview.adoc index 11f0145b275d..a1f6f639d62e 100644 --- a/docs/modules/troubleshooting/pages/overview.adoc +++ b/docs/modules/troubleshooting/pages/overview.adoc @@ -1,4 +1,5 @@ = Troubleshooting and Support +:description: Overview of troubleshooting section in the OpenNMS {page-component-title} documentation. This section describes common troubleshooting strategies and how to get support with various {page-component-title} issues. diff --git a/docs/modules/troubleshooting/pages/startup-issues.adoc b/docs/modules/troubleshooting/pages/startup-issues.adoc index f7b1245ad0e5..16f6f59e9599 100644 --- a/docs/modules/troubleshooting/pages/startup-issues.adoc +++ b/docs/modules/troubleshooting/pages/startup-issues.adoc @@ -1,5 +1,6 @@ = {page-component-title} Startup +:description: Learn how to troubleshoot problems you may encounter while OpenNMS {page-component-title} starts. This section describes troubleshooting steps for problems encountered while {page-component-title} starts. diff --git a/docs/modules/write-the-docs/pages/build-docs.adoc b/docs/modules/write-the-docs/pages/build-docs.adoc index 252048d0790c..0cbe3e1a5210 100644 --- a/docs/modules/write-the-docs/pages/build-docs.adoc +++ b/docs/modules/write-the-docs/pages/build-docs.adoc @@ -1,5 +1,6 @@ = Build the Documentation +:description: Learn how to build the OpenNMS {page-component-title} documentation locally: install Antora, run in Docker. This section describes how to build the OpenNMS documentation locally. We recommend that you do this to test major changes, particularly if adding a lot of new content or making significant revisions to existing content. diff --git a/docs/modules/write-the-docs/pages/develop-docs.adoc b/docs/modules/write-the-docs/pages/develop-docs.adoc index 24b44c5755b3..2490d035d9b5 100644 --- a/docs/modules/write-the-docs/pages/develop-docs.adoc +++ b/docs/modules/write-the-docs/pages/develop-docs.adoc @@ -1,5 +1,6 @@ = Develop Documentation +:description: Learn about how to write and contribute to the OpenNMS {page-component-title} documentation. We value your contribution. There are different ways to contribute documentation, each suitable for different use cases: diff --git a/docs/modules/write-the-docs/pages/glossary.adoc b/docs/modules/write-the-docs/pages/glossary.adoc index 26194b6283ed..0bda5a513283 100644 --- a/docs/modules/write-the-docs/pages/glossary.adoc +++ b/docs/modules/write-the-docs/pages/glossary.adoc @@ -1,5 +1,6 @@ = Glossary +:description: Read the glossary of terms associated with the OpenNMS {page-component-title} editorial style guide, including language best practices. This glossary supplements the OpenNMS Group Editorial Style Guide. While it might be useful to consult when writing or editing documentation, it is for reference only. diff --git a/docs/modules/write-the-docs/pages/overview.adoc b/docs/modules/write-the-docs/pages/overview.adoc index d15c0fe69050..0eed5bcdf0a5 100644 --- a/docs/modules/write-the-docs/pages/overview.adoc +++ b/docs/modules/write-the-docs/pages/overview.adoc @@ -1,5 +1,6 @@ = Write the Docs +:description: Read the OpenNMS {page-component-title} technical writing style guide for the standards and best practices for writing content for us. All contributions welcome! The OpenNMS Group Technical Writing Style Guide is the set of standards for writing our content, to make it consistent and intuitive. The OpenNMS software is free and open source, and we welcome any kind of contribution. diff --git a/docs/modules/write-the-docs/pages/write-docs.adoc b/docs/modules/write-the-docs/pages/write-docs.adoc index f03c3adfc526..1731607323f6 100644 --- a/docs/modules/write-the-docs/pages/write-docs.adoc +++ b/docs/modules/write-the-docs/pages/write-docs.adoc @@ -2,6 +2,7 @@ :imagesdir: write-the-docs:images = Write the Documentation +:description: Learn the best practices for writing and editing the OpenNMS {page-component-title} documentation. All contributions welcome! When writing documentation, place a single sentence on each line. This makes it easy to move content around, and to spot long or fragmented sentences.