Skip to content

NMS-9014: Provisioning detector reference docs - #8988

Closed
joseanesONMS wants to merge 3 commits into
developfrom
jira/NMS-9014-detector-docs-smoke
Closed

joseanesONMS wants to merge 3 commits into
developfrom
jira/NMS-9014-detector-docs-smoke

Conversation

@joseanesONMS

@joseanesONMS joseanesONMS commented Oct 22, 2026 •

Copy link
Copy Markdown
Contributor

Documents the provisioning detector reference pages, split out of #8984; content checked against the code on develop, one commit per ticket.

Ticket Topic Page(s) added/changed Source of truth
NMS-11036 JMX (JSR-160) detector reference/…/detectors/Jsr160Detector.adoc (new), JmxMonitor.adoc opennms-provision/opennms-detector-jmx/…, core/jmx/api/…/JmxConnectionConfig*.java
NMS-9014 All provisioning detectors (24 new pages) reference/…/detectors/*.adoc opennms-provision/opennms-detector-*, protocols/radius/…/detector, opennms-provision-api/…/support/*Detector*.java

Corrections to existing docs (separate NMS-9014: Fix … commits, each can be dropped on its own)

Topic Change Source of truth
Detector parameters brokerURL, useNodeLabel, storedProcedure, supported, authEnabled names; JDBC url, WQL serviceName, TCP banner, HTTPS defaults detector bean setters and field defaults

Not addressed

  • NMS-9014: JBoss, MX4J, NSClient, WMI and XMP detectors no longer exist on develop.

The docs build adds no warnings (develop's two existing ones remain).

External References

The JmxMonitor had a reference page, but the Jsr160Detector, the only JMX detector registered for provisioning, had none.
Parameters and defaults come from JMXDetector, GenericJMXDetectorFactory, and JmxConnectionConfigBuilder; examples follow default-foreign-source.xml.
Twenty-four detectors registered as ServiceDetectorFactory services on develop had no reference page, including the line-oriented, SNMP-based, DHCP, NTP, ICMP, SMB, SSH, RADIUS, and general purpose detectors.
Parameters and defaults come from each detector class and its base classes in opennms-provision and protocols/radius; examples validate against foreign-sources.xsd.
GenericServiceDetectorFactory sets detector parameters as bean properties, so the documented keys must match the setters: brokerURL and useNodeLabel (ActiveMQDetector), storedProcedure (JdbcStoredProcedureDetector), supported (LoopDetector), and authEnabled (WebDetector).
Defaults now follow the code: DBTools.DEFAULT_URL for the JDBC detectors, the unset TcpDetector banner, HttpsDetector's port 443 and maxRetCode 500, and the WSManWQL service name.
@joseanesONMS

Copy link
Copy Markdown
Contributor Author

Reopened as #8998 from a branch without the -smoke suffix; this PR is docs-only, so it doesn't need a smoke run.

@joseanesONMS
joseanesONMS deleted the jira/NMS-9014-detector-docs-smoke branch October 22, 2026 12:45
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant