Repository navigation
NMS-12873: SNMP configuration docs - #8991
Closed
joseanesONMS wants to merge 5 commits into
Closed
joseanesONMS wants to merge 5 commits into
joseanesONMS wants to merge 5 commits into
Conversation
There was no operator page describing the SNMP agent configuration: its structure, how an IP address is matched to a definition, or each attribute and its default. The new SNMP Configuration page is based on snmp-config.xsd, the JAXB Configuration and Definition classes, AddressSnmpConfigVisitor, and SnmpConfiguration defaults, and the quick start, profile, and XML sample pages now link to it.
The proxy-host attribute was listed without any explanation of its effect. SnmpPeerFactory replaces the request address with the proxy and keeps the agent as ProxyForAddress, and the SNMP4J strategy sends only to the proxy; the new section describes this, which settings apply to the proxy, and how to verify it.
Operators had no guidance on checking the effective SNMP configuration, testing requests, or tuning timeouts and PDU sizes for slow agents. The new section uses the snmp-show-config, snmp-get, snmp-walk, and snmp-fit Karaf commands and the matching, security level, and profile fitting rules in AddressSnmpConfigVisitor and NodeInfoScan.
… defaults The /api/v2/snmp-config resource serializes org.opennms.netmgt.config.snmp.Configuration, whose @JsonProperty names are retry, authPassphrase, privacyPassphrase, and privacyProtocol; AddressSnmpConfigVisitor sets no default for either passphrase.
DefaultSnmpConfigDao reads the SNMP configuration from the database through the configuration management store, not from snmp-config.xml, and SnmpPeerFactory.getAgentConfig() interpolates only the security name, community strings, and passphrases with the secure credentials vault scope.
Contributor
Author
|
Reopened as #9001 from a branch without the |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Documents the SNMP agent configuration, split out of #8984; content checked against the code on develop, one commit per ticket.
operation/…/provisioning/snmp-configuration.adoc(new)snmp-config.xsd,SnmpConfiguration.java,SnmpConfigManager.javaproxy-hostsnmp-configuration.adocSnmpPeerFactory.java,Snmp4JAgentConfig.javasnmp-configuration.adoccore/snmp/commands/*,NodeInfoScan.javaThe SNMP sample namespace in
xml-samples.adocis also corrected.Corrections to existing docs (separate
NMS-12873: Fix …commits, each can be dropped on its own)Configuration.java,AddressSnmpConfigVisitor.javaDefaultSnmpConfigDao.java,SnmpPeerFactory.javaThe docs build adds no warnings (develop's two existing ones remain).
External References