SNMPAgentMBean

Overview

This singleton MBean represents an SNMP agent that is scoped to a WebLogic Server domain.

This MBean is provided to support domains that were created with WebLogic Server release 9.2 and earlier. For new domains, create an instance of SNMPAgentDeploymentMBean and target it to the domain's Administration Server.

Related MBeans

This section describes attributes that provide access to other MBeans.

SNMPAttributeChanges

The SNMPAttributeChangeMBeans which describe the MBean type and Attribute name for which attribute change notification should be sent when an attribute change is observed.

For more information, see:

• SNMPAttributeChangeMBean

SNMPCounterMonitors

The SNMPCounterMonitorMBeans which describe the criteria for generating notifications based on JMX CounterMonitor.

For more information, see:

• SNMPCounterMonitorMBean

SNMPGaugeMonitors

The SNMPGaugeMonitorMBeans which describe the criteria for generating notifications based on JMX GaugeMonitor.

For more information, see:

• SNMPGaugeMonitorMBean

SNMPLogFilters

The SNMPLogFilterMBeans which describe filters for generating notifications based on server log messages.

For more information, see:

• SNMPLogFilterMBean

SNMPProxies

The SNMP agents for which this SNMP agent is a proxy. SNMPProxyMBeans describe settings for SNMP agents to be proxied by this SNMP agent.

For more information, see:

• SNMPProxyMBean

SNMPStringMonitors

The SNMPStringMonitorMBeans which describe the criteria for generating notifications based on JMX StringMonitor.

For more information, see:

• SNMPStringMonitorMBean

SNMPTrapDestinations

WebLogic Server uses a trap destination to specify the SNMP management station and the community name used by the SNMP agent to send notifications. Select which trap destination(s) should be used in this WebLogic Server domain from the list of available trap destinations.

TargetedTrapDestinations

WebLogic Server uses a trap destination to specify the SNMP management station and the community name used by the SNMP agent to send trap notifications.

This attribute contains the collection of trap destinations that have been configured for this SNMP agent.

Deprecated. 9.0.0.0 Use the getSNMPTrapDestinations() method instead.

Attributes

This section describes the following attributes:

AuthenticationProtocol

The protocol that this SNMP agent uses to ensure that only authorized users can request or receive information about your WebLogic Server domain. Applicable only with SNMPv3.

The protocol also ensures message integrity and prevents masquerading and reordered, delayed, or replayed messages.

To use this protocol when receiving requests from SNMP managers, you must configure credential mapping in the WebLogic Server security realm. To use this protocol when sending responses or notifications, you must configure the security level of your trap destinations.

If you do not choose an authentication protocol, then the SNMP agent does not authenticate incoming SNMPv3 requests; anyone can use SNMPv3 to retrieve information about your WebLogic Server domain.

CachingDisabled

Private property that disables caching in proxies.

CommunityBasedAccessEnabled

Specifies whether this SNMP agent supports SNMPv1 and v2.

SNMPv1 and v2 use community strings for authentication. If you disable community strings for this SNMP agent, the agent will process only SNMPv3 requests. If an SNMP manager sends a v1 or v2 message, the agent discards the message and returns an error code to the manager.

CommunityPrefix

The password (community name) that you want this SNMP agent to use to secure SNMPv1 or v2 communication with SNMP managers. Requires you to enable community based access for this agent.

SNMPv3 does not use community names. Instead, it encrypts user names and passwords in its PDUs.

When you use SNMPv1 or v2, there are two community names that are needed when the WebLogic SNMP agent and SNMP managers interact:

• The name that you specify in this community prefix. All SNMP managers must send this name when connecting to this SNMP agent.

• The community name that the SNMP manager defines. The SNMP agent must send this name when connecting to the manager. (You supply this community name when you configure a trap destination.)

In addition to using the community prefix as a password, an SNMP agent on an Administration Server uses the prefix to qualify requests from SNMP managers. Because the Administration Server can access data for all WebLogic Server instances in a domain, a request that specifies only an attribute name is potentially ambiguous. For example, the attribute serverUptime exists for each WebLogic Server instance in a domain. To clarify requests that you send to SNMP agents on Administration Servers, use the community prefix as follows:

• To request the value of an attribute on a specific Managed Server, when you send a request from an SNMP manager, append the name of the server instance to the community prefix: community_prefix@server_name.

• To request the value of an attribute for all server instances in a domain, send a community name with the following form: community_prefix

To secure access to the values of the WebLogic attributes when using the SNMPv1 or v2 protocols, it is recommended that you set community prefix to a value other than public.

You cannot specify a null (empty) value for the community prefix. If you delete the prefix value, WebLogic Server resets the value to public. If you do not want this agent to receive SNMPv1 or v2 requests, instead of trying to set the community prefix to a null value, disable community based access. With community based access disabled, WebLogic Server ignores the community prefix value.

DebugLevel

The minimum severity of debug messages that this SNMP agent generates.

The SNMP agent writes all debug messages to standard out; they are not written to the WebLogic Server log files. Debug messages provide a detailed description of the SNMP agent's actions. For example, the agent outputs a noncritical message each time it generates a notification.

Valid values are:

• 0

  No debug messages.

• 1

  Fatal messages only.

• 2

  Critical and fatal messages.

• 3

  Non-critical, critical, and, fatal messages.

Deprecated. 10.0.0.0 Use the ServerDebugMBean.DebugSNMPToolkit attribute to configure the SNMP Toolkit debug

Enabled

Specifies whether this SNMP agent is enabled.

InformEnabled

Configures this SNMP agent to send notifications as an INFORM instead of a TRAP. Requires you to specify the agent's SNMPTrapVersion as SNMPv2 or SNMPv3.

When an agent sends an INFORM notification, it waits for a confirmation response from the SNMP manager. If it does not receive a response, it resends the INFORM notification.

For more information, see:

• getSNMPTrapVersion()

InformRetryInterval

The number of milliseconds that this SNMP agent will wait for a response to an INFORM notification.

If the agent does not receive a response within the specified interval, it will resend the notification.

LocalizedKeyCacheInvalidationInterval

The number of milliseconds after which WebLogic Server invalidates its cache of SNMP security keys. Setting a high value creates a risk that users whose credentials have been removed can still access SNMP data.

An SNMP security key is an encrypted version of an SNMP agent's engine ID and an authentication password or privacy password. WebLogic Server generates one security key for each entry that you create in the SNMP credential map. When a WebLogic Server SNMP agent receives an SNMPv3 request, it compares the key that is in the request with its WebLogic Server keys. If it finds a match, it processes the request. The SNMP agent also encodes these keys in its responses and notifications. (You configure which keys are encoded when you create a trap destination.)

Instead of regenerating the keys for each SNMPv3 communication, WebLogic Server caches the keys. To make sure that the cache contains the latest set of SNMP credentials, WebLogic Server periodically invalidates the cache. After the cache is invalidated, the next time an SNMP agent requests credentials, WebLogic Server regenerates the cache.

Note that making a change to the credential map does not automatically update the cache. Instead, the cache is updated only after it has been invalidated.

For example, if you update a privacy password in an existing entry in the SNMP credential map, the SNMP agent is not aware of the new password until the key cache is invalidated and regenerated. An SNMP user with the old security password can still access WebLogic Server data until the cache is invalidated.

You can invalidate a key immediately instead of waiting for this invalidation interval to expire.

For more information, see:

• SNMPAgentRuntimeMBean#invalidateLocalizedKeyCache(String)
• SNMPTrapDestinationMBean

MasterAgentXPort

The port that this SNMP agent uses to communicate with its subagents.

The agent uses subagents to provide access to custom MBeans (MBeans that you create and register) and to other software components. WebLogic Server SNMP agents do not enable users to register their own subagents.

MaxInformRetryCount

The maximum number of times that this SNMP agent will resend INFORM notifications for which it has not received a response.

MBeanInfo

Returns the MBean info for this MBean.

Deprecated.

MibDataRefreshInterval

The minimum number of seconds that this SNMP agent caches OIDs before checking if new ones have been added to the Management Information Base (MIB).

A MIB is a database of all objects that can be managed through SNMP. When you create a new WebLogic Server resource, the SNMP agent assigns a unique OID to the resource and adds it to the MIB. For example, when you create a new server, the SNMP agent adds an OID to the MIB.

This attribute is not used by the SNMP Agent anymore. The SNMP Agent retrieves internal notifications about MBean registrations in the WLS MBeanServers.

Deprecated. 10.0.0.0 There is no replacement for this attribute.

Name

The user-specified name of this MBean instance.

This name is included as one of the key properties in the MBean's javax.management.ObjectName:
Name=user-specified-name

Notes

Optional information that you can include to describe this configuration.

WebLogic Sever saves this note in the domain's configuration file (config.xml) as XML PCDATA. All left angle brackets (<) are converted to the XML entity <. Carriage returns/line feeds are preserved.

Note:

If you create or edit a note from the Administration Console, the Administration Console does not preserve carriage returns/line feeds.

ObjectName

Returns the ObjectName under which this MBean is registered in the MBean server.

Deprecated.

Parent

Return the immediate parent for this MBean

PrivacyProtocol

The protocol that this SNMP agent uses to encrypt and unencrypt messages. Applicable only with SNMPv3. Requires you to also use an authentication protocol.

To use this protocol when sending responses or notifications, you must also configure the security level of your trap destinations.

If you do not choose a privacy protocol, then communication between this agent and managers can be viewed (but not altered) by unauthorized users.

For more information, see:

• SNMPTrapDestinationMBean#getSecurityLevel()

Registered

Returns false if the MBean represented by this object has been unregistered.

Deprecated.

SendAutomaticTrapsEnabled

Specifies whether this SNMP agent sends automatically generated notifications to SNMP managers.

The SNMP agent generates automatic notifications when any of the following events occur:

• The WebLogic Server instance that is hosting the SNMP agent starts.

  This type of notification (coldStart) has no variable bindings.

• A server instance starts or stops.

  An SNMP agent on a Managed Server generates these notifications only when its host Managed Server starts or stops. An SNMP agent on an Administration Server generates these notifications when any server in the domain starts or stops.

  These notification types (serverStart and serverShutdown) contain variable bindings to identify the server that started or stopped and the time at which the notification was generated.

For more information, see:

• SNMPAgentMBean#getServerStatusCheckIntervalFactor

ServerStatusCheckIntervalFactor

The multiplier used to calculate the interval at which this SNMP agent checks for newly started or shut down server instances.

You can enable the SNMP agent to automatically generate serverStartup and serverShutdown notifications when servers start or shut down. See SNMPAgentMBean#isSendAutomaticTrapsEnabled .

This status check value is multiplied by the MIB Data Refresh Interval to determine the interval:
interval = n * MibDataRefreshInterval

The SNMP Agent uses internal notifications to update itself when a server is restarted so there is no need to poll the server for their status.

For the most frequent interval, specify 1 as the multiplier value.

Deprecated. 10.0.0.0 There is no replacement for this attribute.

SNMPAccessForUserMBeansEnabled

Configures this SNMP agent to provide read-only access to MBean types that you have created and registered (custom MBeans).

If you enable this access, when you register a custom MBean in a WebLogic Server MBeanServer, this SNMP agent dynamically updates a runtime MIB module that WebLogic Server maintains for custom MBeans.

For each custom MBean type, WebLogic Server adds a table to the MIB module. For each instance of the custom MBean, it adds a table row. While WebLogic Server does not persist the MIB as a file or other data structure, the OIDs in the MIB remain constant across server sessions.

The MIB module for custom MBeans is managed by a subAgent. Its master agent is this WebLogic Server SNMP agent and it communicates with the master agent through the AgentX port.

For more information, see:

• getMasterAgentXPort()

SNMPEngineId

An identifier for this SNMP agent that is unique amongst all other SNMP agents in the current WebLogic Server domain.

If you use SNMPv3 to send messages to this SNMP agent, you must specify the SNMP engine ID when you configure the SNMP manager.

For an SNMP agent on an Administration Server, the default value is the name of the WebLogic Server domain. For an agent on a Managed Server, the default is the name of the server.

SNMPPort

The port on which you want this SNMP agent to listen for incoming requests from SNMP managers that use the UDP protocol.

SNMP managers can use this port to ping the SNMP agent and request the status of specific attributes.

If you target this SNMP agent to multiple server instances, and if two or more servers are running on the same computer, WebLogic Server will automatically increment this UDP port value by 1 for each agent. WebLogic Server never assigns port 162 because it is the default port that an agent uses to send notifications. In addition, if any port is already in use, WebLogic Server skips the port and assigns the next available port.

For example, if you use the default value of this attribute and then target this agent to ManagedServer1 and ManagedServer2, and if both servers are running on the same computer, then the agent on ManagedServer1 will listen on UDP port 161 and the agent on ManagedServer2 will listen on UDP port 163.

The incremented port number is not persisted in the domain's configuration; when WebLogic Server increments port numbers, it does so in the order in which servers are started on the same computer.

If WebLogic Server re-assigns the UDP port for an SNMP agent, look in the agent's SNMPAgentRuntimeMBean to see the agent's runtime UDP port.

SNMP agents can also communicate through the host server's TCP listen port (7001 by default) or through a TCP port that is configured by a custom network channel.

For more information, see:

• SNMPAgentRuntimeMBean
• ServerMBean#getListenPort()
• NetworkAccessPointMBean

SNMPTrapVersion

The SNMP notification version that this SNMP agent generates.

For more information, see:

• SNMPAgentMBean#isCommunityBasedAccessEnabled

Type

Returns the type of the MBean.

Operations

This section describes the following operations:

addSNMPAttributeChange

Adds a feature to the SNMPAttributeChange attribute of the SNMPAgentMBean object

Deprecated. 9.0.0.0 Instead, use standard JMX design patterns using <code>javax.management.MBeanServerConnection</code> interface.

addSNMPCounterMonitor

Adds a feature to the SNMPCounterMonitor attribute of the SNMPAgentMBean object

Deprecated. 9.0.0.0 Instead, use standard JMX design patterns using <code>javax.management.MBeanServerConnection</code> interface.

addSNMPGaugeMonitor

Adds a feature to the SNMPGaugeMonitor attribute of the SNMPAgentMBean object

Deprecated. 9.0.0.0 Instead, use standard JMX design patterns using <code>javax.management.MBeanServerConnection</code> interface.

addSNMPLogFilter

Adds a feature to the SNMPLogFilter attribute of the SNMPAgentMBean object

Deprecated. 9.0.0.0 Instead, use standard JMX design patterns using <code>javax.management.MBeanServerConnection</code> interface.

addSNMPProxy

Adds a feature to the SNMPProxy attribute of the SNMPAgentMBean object

Deprecated. 9.0.0.0 Instead, use standard JMX design patterns using <code>javax.management.MBeanServerConnection</code> interface.

addSNMPStringMonitor

Adds a single SNMPStringMonitorMBeans to this SNMP agent's collection.

Deprecated. 9.0.0.0 Instead, use standard JMX design patterns using <code>javax.management.MBeanServerConnection</code> interface.

For more information, see:

• getSNMPStringMonitors()

addSNMPTrapDestination

Adds an SNMPTrapDestination to the SNMPAgentMBean object

Deprecated. 9.0.0.0 Instead, use standard JMX design patterns using <code>javax.management.MBeanServerConnection</code> interface.

addTargetedTrapDestination

Adds a single trap destination to this SNMP agent's list of targeted trap destinations.

Deprecated. 9.0.0.0

For more information, see:

• getTargetedTrapDestinations

freezeCurrentValue

If the specified attribute has not been set explicitly, and if the attribute has a default value, this operation forces the MBean to persist the default value.

Unless you use this operation, the default value is not saved and is subject to change if you update to a newer release of WebLogic Server. Invoking this operation isolates this MBean from the effects of such changes.

Note:

To insure that you are freezing the default value, invoke the restoreDefaultValue operation before you invoke this.

This operation has no effect if you invoke it on an attribute that does not provide a default value or on an attribute for which some other value has been set.

Deprecated. 9.0.0.0

isSet

Returns true if the specified attribute has been set explicitly in this MBean instance.

removeSNMPAttributeChange

Deprecated. 9.0.0.0 Instead, use standard JMX design patterns using <code>javax.management.MBeanServerConnection</code> interface.

removeSNMPCounterMonitor

Deprecated. 9.0.0.0 Instead, use standard JMX design patterns using <code>javax.management.MBeanServerConnection</code> interface.

removeSNMPGaugeMonitor

Deprecated. 9.0.0.0 Instead, use standard JMX design patterns using <code>javax.management.MBeanServerConnection</code> interface.

removeSNMPLogFilter

Deprecated. 9.0.0.0 Instead, use standard JMX design patterns using <code>javax.management.MBeanServerConnection</code> interface.

removeSNMPProxy

Deprecated. 9.0.0.0 Instead, use standard JMX design patterns using <code>javax.management.MBeanServerConnection</code> interface.

removeSNMPStringMonitor

Deprecated. 9.0.0.0 Instead, use standard JMX design patterns using <code>javax.management.MBeanServerConnection</code> interface.

removeTargetedTrapDestination

Deprecated. 9.0.0.0

restoreDefaultValue

If the specified attribute has a default value, this operation removes any value that has been set explicitly and causes the attribute to use the default value.

Default values are subject to change if you update to a newer release of WebLogic Server. To prevent the value from changing if you update to a newer release, invoke the freezeCurrentValue operation.

This operation has no effect if you invoke it on an attribute that does not provide a default value or on an attribute that is already using the default.

Deprecated. 9.0.0.0

unSet

Restore the given property to its default value.

Version: 10.3.3.0