The SNMP Connection Handler can be used to process SNMP requests to retrieve monitoring information described by the MIB 2605. Supported protocol are SNMP V1, V2c and V3.
The SNMP connection handler will process SNMP requests sent by SNMP Managers to retrieve information described the MIB 2605. To enable the SNMP Connection Handler, the ds-cfg-opendmk-jarfile parameter has to be set to the OpenDMK jar files location.
Parent Component
The SNMP Connection Handler component inherits from the Connection Handler
Specifies a set of host names or address masks that determine the clients that are allowed to establish connections to this Connection Handler. Valid values include a host name, a fully qualified domain name, a domain name, an IP address, or a subnetwork with subnetwork mask.
Default Value
All clients with addresses that do not match an address on the deny list are allowed. If there is no deny list, then all clients are allowed.
Allowed Values
An IP address mask
Multi-valued
Yes
Required
No
Admin Action Required
None. Changes to this property take effect immediately and do not interfere with connections that may have already been established.
Advanced Property
No
Read-only
No
allowed-manager
Description
Specifies the hosts of the managers to be granted the access rights. This property is required for SNMP v1 and v2 security configuration. An asterisk (*) opens access to all managers.
Default Value
*
Allowed Values
A String
Multi-valued
Yes
Required
No
Admin Action Required
The SNMP Connection Handler must be disabled and re-enabled for changes to this setting to take effect
Advanced Property
No
Read-only
No
allowed-user
Description
Specifies the users to be granted the access rights. This property is required for SNMP v3 security configuration. An asterisk (*) opens access to all users.
Default Value
*
Allowed Values
A String
Multi-valued
Yes
Required
No
Admin Action Required
The SNMP Connection Handler must be disabled and re-enabled for changes to this setting to take effect
Advanced Property
No
Read-only
No
community
Description
Specifies the v1,v2 community or the v3 context name allowed to access the MIB 2605 monitoring information or the USM MIB. The mapping between "community" and "context name" is set.
Default Value
OpenDJ
Allowed Values
A String
Multi-valued
No
Required
No
Admin Action Required
The SNMP Connection Handler must be disabled and re-enabled for changes to this setting to take effect
Advanced Property
No
Read-only
No
denied-client
Description
Specifies a set of host names or address masks that determine the clients that are not allowed to establish connections to this Connection Handler. Valid values include a host name, a fully qualified domain name, a domain name, an IP address, or a subnetwork with subnetwork mask. If both allowed and denied client masks are defined and a client connection matches one or more masks in both lists, then the connection is denied. If only a denied list is specified, then any client not matching a mask in that list is allowed.
Default Value
If an allow list is specified, then only clients with addresses on the allow list are allowed. Otherwise, all clients are allowed.
Allowed Values
An IP address mask
Multi-valued
Yes
Required
No
Admin Action Required
None. Changes to this property take effect immediately and do not interfere with connections that may have already been established.
Advanced Property
No
Read-only
No
enabled
Description
Indicates whether the Connection Handler is enabled.
Default Value
None
Allowed Values
true
false
Multi-valued
No
Required
Yes
Admin Action Required
None
Advanced Property
No
Read-only
No
listen-address
Description
Specifies the address or set of addresses on which this SNMP Connection Handler should listen for connections from SNMP clients. Multiple addresses may be provided as separate values for this attribute. If no values are provided, then the SNMP Connection Handler listens on all interfaces.
Default Value
0.0.0.0
Allowed Values
An IP address
Multi-valued
Yes
Required
No
Admin Action Required
Restart the server
Advanced Property
No
Read-only
Yes
listen-port
Description
Specifies the port number on which the SNMP Connection Handler will listen for connections from clients. Only a single port number may be provided.
Default Value
None
Allowed Values
An integer value. Lower value is 1. Upper value is 65535 .
Multi-valued
No
Required
Yes
Admin Action Required
The SNMP Connection Handler must be disabled and re-enabled for changes to this setting to take effect
Advanced Property
No
Read-only
No
opendmk-jarfile
Description
Indicates the OpenDMK runtime jar file location
Default Value
None
Allowed Values
A String
Multi-valued
No
Required
No
Admin Action Required
The SNMP Connection Handler must be disabled and re-enabled for changes to this setting to take effect
Advanced Property
No
Read-only
No
registered-mbean
Description
Indicates whether the SNMP objects have to be registered in the directory server MBeanServer or not allowing to access SNMP Objects with RMI connector if enabled.
Default Value
false
Allowed Values
true
false
Multi-valued
No
Required
No
Admin Action Required
The SNMP Connection Handler must be disabled and re-enabled for changes to this setting to take effect
Advanced Property
No
Read-only
No
security-agent-file
Description
Specifies the USM security configuration to receive authenticated only SNMP requests.
Default Value
config/snmp/security/opendj-snmp.security
Allowed Values
A String
Multi-valued
No
Required
No
Admin Action Required
The SNMP Connection Handler must be disabled and re-enabled for changes to this setting to take effect
Advanced Property
No
Read-only
No
security-level
Description
Specifies the type of security level : NoAuthNoPriv : No security mechanisms activated, AuthNoPriv : Authentication activated with no privacy, AuthPriv : Authentication with privacy activated. This property is required for SNMP V3 security configuration.
Default Value
authnopriv
Allowed Values
authnopriv - Authentication activated with no privacy.
authpriv - Authentication with privacy activated.
noauthnopriv - No security mechanisms activated.
Multi-valued
No
Required
No
Admin Action Required
The SNMP Connection Handler must be disabled and re-enabled for changes to this setting to take effect
Advanced Property
No
Read-only
No
trap-port
Description
Specifies the port to use to send SNMP Traps.
Default Value
None
Allowed Values
An integer value. Lower value is 0.
Multi-valued
No
Required
Yes
Admin Action Required
The SNMP Connection Handler must be disabled and re-enabled for changes to this setting to take effect
Advanced Property
No
Read-only
No
traps-community
Description
Specifies the community string that must be included in the traps sent to define managers (trap-destinations). This property is used in the context of SNMP v1, v2 and v3.
Default Value
OpenDJ
Allowed Values
A String
Multi-valued
No
Required
No
Admin Action Required
The SNMP Connection Handler must be disabled and re-enabled for changes to this setting to take effect
Advanced Property
No
Read-only
No
traps-destination
Description
Specifies the hosts to which V1 traps will be sent. V1 Traps are sent to every host listed. If this list is empty, V1 traps are sent to "localhost". Each host in the list must be identifed by its name or complete IP Addess.
Default Value
If the list is empty, V1 traps are sent to "localhost".
Allowed Values
A String
Multi-valued
Yes
Required
No
Admin Action Required
The SNMP Connection Handler must be disabled and re-enabled for changes to this setting to take effect
Advanced Property
No
Read-only
No
Advanced Properties
java-class
Description
Specifies the fully-qualified name of the Java class that provides the SNMP Connection Handler implementation.
Default Value
org.opends.server.snmp.SNMPConnectionHandler
Allowed Values
A java class that implements or extends the class(es) :
org.opends.server.api.ConnectionHandler
Multi-valued
No
Required
Yes
Admin Action Required
The SNMP Connection Handler must be disabled and re-enabled for changes to this setting to take effect