weblogic.management.configuration
Interface SNMPAgentMBean

All Superinterfaces:

ConfigurationMBean

public interface SNMPAgentMBean
extends ConfigurationMBean

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.

Deprecation of MBeanHome and Type-Safe Interfaces

This is a type-safe interface for a WebLogic Server MBean, which you can import into your client classes and access through weblogic.management.MBeanHome. As of 9.0, the MBeanHome interface and all type-safe interfaces for WebLogic Server MBeans are deprecated. Instead, client classes that interact with WebLogic Server MBeans should use standard JMX design patterns in which clients use the javax.management.MBeanServerConnection interface to discover MBeans, attributes, and attribute types at runtime. For more information, see "Developing Manageable Applications with JMX."

Changes take effect after you redeploy the module or restart the server.

DEBUG_NONE

static final int DEBUG_NONE

See Also:

Constant Field Values

DEBUG_FATAL

static final int DEBUG_FATAL

See Also:

Constant Field Values

DEBUG_CRITICAL

static final int DEBUG_CRITICAL

See Also:

Constant Field Values

DEBUG_NONCRITICAL

static final int DEBUG_NONCRITICAL

See Also:

Constant Field Values

SNMPV1

static final int SNMPV1

SNMP Version 1

SNMPV2

static final int SNMPV2

SNMP Version 2

SNMPV3

static final int SNMPV3

SNMP Version 3

NO_AUTH

static final String NO_AUTH

Constant for no authentication

See Also:

Constant Field Values

MD5

static final String MD5

MD5 authentication protocol

See Also:

Constant Field Values

SHA

static final String SHA

SHA authentication protocol

See Also:

Constant Field Values

NO_PRIV

static final String NO_PRIV

Constant for no privacy

See Also:

Constant Field Values

DES

static final String DES

DES privacy protocol

See Also:

Constant Field Values

AES_128

static final String AES_128

AES privacy protocol

See Also:

Constant Field Values

isEnabled

boolean isEnabled()

Specifies whether this SNMP agent is enabled.

Returns:

True if the SNMP service is activated.

Default Value:

false

setEnabled

void setEnabled(boolean flag)

Sets the value of the Enabled attribute.

Parameters:

flag - The new enabled value

See Also:

SNMPAgentMBean.isEnabled()

isSendAutomaticTrapsEnabled

boolean isSendAutomaticTrapsEnabled()

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.

Returns:

True if the SNMP automatic notification generation service is activated.

See Also:

SNMPAgentMBean.getServerStatusCheckIntervalFactor()

Default Value:

true

setSendAutomaticTrapsEnabled

void setSendAutomaticTrapsEnabled(boolean flag)

Sets the value of the SendAutomaticTrapsEnabled attribute.

Parameters:

flag - The new sendAutomaticTrapsEnabled value

See Also:

SNMPAgentMBean.isSendAutomaticTrapsEnabled()

getSNMPPort

int getSNMPPort()

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.

Returns:

The SNMPPort value

See Also:

SNMPAgentRuntimeMBean, ServerMBean.getListenPort(), NetworkAccessPointMBean

Default Value:

161

Maximum Value:

65535

Minimum Value:

1

setSNMPPort

void setSNMPPort(int port)
                 throws InvalidAttributeValueException,
                        ConfigurationException

Sets the value of the SNMPPort attribute.

Parameters:

port - The new SNMPPort value

Throws:

InvalidAttributeValueException

ConfigurationException

See Also:

SNMPAgentMBean.getSNMPPort()

getSNMPTrapVersion

int getSNMPTrapVersion()

The SNMP notification version that this SNMP agent generates.

Returns:

The SNMPTrap version

See Also:

SNMPAgentMBean.isCommunityBasedAccessEnabled()

Default Value:

SNMPAgentMBean.SNMPV1

Valid Values:

SNMPAgentMBean.SNMPV1, SNMPAgentMBean.SNMPV2, SNMPAgentMBean.SNMPV3

setSNMPTrapVersion

void setSNMPTrapVersion(int version)

Sets the value of the SNMPTrapVersion attribute.

See Also:

SNMPAgentMBean.getSNMPTrapVersion()

getMibDataRefreshInterval

int getMibDataRefreshInterval()

Deprecated. 10.0.0.0 There is no replacement for this attribute.

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.

Returns:

The mibDataRefreshInterval value

Default Value:

120

Maximum Value:

65535

Minimum Value:

30

setMibDataRefreshInterval

void setMibDataRefreshInterval(int interval)
                               throws InvalidAttributeValueException,
                                      ConfigurationException

Sets the value of the MibDataRefreshInterval attribute.

Parameters:

interval - The new mibDataRefreshInterval value

Throws:

InvalidAttributeValueException

ConfigurationException

See Also:

SNMPAgentMBean.getMibDataRefreshInterval()

getServerStatusCheckIntervalFactor

int getServerStatusCheckIntervalFactor()

Deprecated. 10.0.0.0 There is no replacement for this attribute.

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.

Returns:

The serverStatusCheckIntervalFactor value

Default Value:

1

Maximum Value:

65535

Minimum Value:

1

setServerStatusCheckIntervalFactor

void setServerStatusCheckIntervalFactor(int factor)
                                        throws InvalidAttributeValueException,
                                               ConfigurationException

Sets the value of the ServerStatusCheckIntervalFactor attribute.

Parameters:

factor - The new serverStatusCheckIntervalFactor value

Throws:

InvalidAttributeValueException

ConfigurationException

See Also:

SNMPAgentMBean.getServerStatusCheckIntervalFactor()

getCommunityPrefix

String getCommunityPrefix()

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.

Returns:

The communityPrefix value

This method can NOT set a value of zero length.

Default Value:

"public"

setCommunityPrefix

void setCommunityPrefix(String prefix)
                        throws InvalidAttributeValueException,
                               ConfigurationException

Sets the value of the CommunityPrefix attribute.

Parameters:

prefix - The new communityPrefix value

Throws:

InvalidAttributeValueException

ConfigurationException

See Also:

SNMPAgentMBean.getCommunityPrefix()

getDebugLevel

int getDebugLevel()

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

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.

Returns:

The debugLevel value

Default Value:

SNMPAgentMBean.DEBUG_NONE

Valid Values:

SNMPAgentMBean.DEBUG_NONE, SNMPAgentMBean.DEBUG_FATAL, SNMPAgentMBean.DEBUG_CRITICAL, SNMPAgentMBean.DEBUG_NONCRITICAL

setDebugLevel

void setDebugLevel(int debugLevel)
                   throws InvalidAttributeValueException,
                          ConfigurationException

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

Sets the value of the DebugLevel attribute.

Parameters:

debugLevel - The new debugLevel value

Throws:

InvalidAttributeValueException

ConfigurationException

See Also:

SNMPAgentMBean.getDebugLevel()

getTargetedTrapDestinations

SNMPTrapDestinationMBean[] getTargetedTrapDestinations()

Deprecated. 9.0.0.0 Use the getSNMPTrapDestinations() method instead.

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.

Returns:

The targetedTrapDestinations value

setTargetedTrapDestinations

void setTargetedTrapDestinations(SNMPTrapDestinationMBean[] snmpTrapDestinations)
                                 throws InvalidAttributeValueException,
                                        ConfigurationException

Deprecated. 9.0.0.0 Instead, use standard JMX design patterns using javax.management.MBeanServerConnection interface.

Sets the value of the TargetedTrapDestinations attribute.

Parameters:

snmpTrapDestinations - The new targetedTrapDestinations value

Throws:

InvalidAttributeValueException

ConfigurationException

See Also:

SNMPAgentMBean.getTargetedTrapDestinations()

addTargetedTrapDestination

boolean addTargetedTrapDestination(SNMPTrapDestinationMBean trapdestination)
                                   throws InvalidAttributeValueException,
                                          ConfigurationException

Deprecated. 9.0.0.0

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

Parameters:

trapdestination - The feature to be added to the TargetedTrapDestination attribute

Returns:

Throws:

InvalidAttributeValueException

ConfigurationException

See Also:

SNMPAgentMBean.getTargetedTrapDestinations()

removeTargetedTrapDestination

boolean removeTargetedTrapDestination(SNMPTrapDestinationMBean trapdestination)
                                      throws InvalidAttributeValueException,
                                             ConfigurationException

Deprecated. 9.0.0.0

Parameters:

trapdestination -

Returns:

Throws:

InvalidAttributeValueException

ConfigurationException

createSNMPTrapDestination

SNMPTrapDestinationMBean createSNMPTrapDestination(String name)

Factory method to create SNMPTrapDestination objects

Parameters:

name -

Returns:

SNMPTrapDestination object

Since:

9.0.0.0

destroySNMPTrapDestination

void destroySNMPTrapDestination(SNMPTrapDestinationMBean trapdestination)

Removes a SNMPTrapDestination from this SNMPAgent

Parameters:

SNMPTrapDestination -

Since:

9.0.0.0

lookupSNMPTrapDestination

SNMPTrapDestinationMBean lookupSNMPTrapDestination(String name)

Parameters:

name -

Returns:

SNMPTrapDestination object

Since:

9.0.0.0

getSNMPTrapDestinations

SNMPTrapDestinationMBean[] getSNMPTrapDestinations()

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.

Returns:

The targetedTrapDestinations value

Since:

9.0.0.0

addSNMPTrapDestination

boolean addSNMPTrapDestination(SNMPTrapDestinationMBean trapdestination)
                               throws InvalidAttributeValueException,
                                      ConfigurationException

Deprecated. 9.0.0.0 Instead, use standard JMX design patterns using javax.management.MBeanServerConnection interface.

Adds an SNMPTrapDestination to the SNMPAgentMBean object

Parameters:

trapdestination - The feature to be added to the SNMPTrapDestination attribute

Returns:

Throws:

InvalidAttributeValueException

ConfigurationException

getSNMPProxies

SNMPProxyMBean[] getSNMPProxies()

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

Returns:

The SNMPProxies value

See Also:

SNMPProxyMBean

setSNMPProxies

void setSNMPProxies(SNMPProxyMBean[] snmpProxys)
                    throws InvalidAttributeValueException,
                           ConfigurationException

Deprecated. 9.0.0.0 Instead, use standard JMX design patterns using javax.management.MBeanServerConnection interface.

Sets the value of the SNMPProxies attribute.

Parameters:

snmpProxys - The new SNMPProxies value

Throws:

InvalidAttributeValueException

ConfigurationException

See Also:

SNMPAgentMBean.getSNMPProxies()

addSNMPProxy

boolean addSNMPProxy(SNMPProxyMBean snmpProxy)
                     throws InvalidAttributeValueException,
                            ConfigurationException

Deprecated. 9.0.0.0 Instead, use standard JMX design patterns using javax.management.MBeanServerConnection interface.

Adds a feature to the SNMPProxy attribute of the SNMPAgentMBean object

Parameters:

snmpProxy - The feature to be added to the SNMPProxy attribute

Returns:

Throws:

InvalidAttributeValueException

ConfigurationException

removeSNMPProxy

boolean removeSNMPProxy(SNMPProxyMBean snmpProxy)
                        throws InvalidAttributeValueException,
                               ConfigurationException

Deprecated. 9.0.0.0 Instead, use standard JMX design patterns using javax.management.MBeanServerConnection interface.

Parameters:

snmpProxy -

Returns:

Throws:

InvalidAttributeValueException

ConfigurationException

createSNMPProxy

SNMPProxyMBean createSNMPProxy(String name)

Factory method to create SNMPProxy objects

Parameters:

name -

Returns:

SNMPProxy object

Since:

9.0.0.0

destroySNMPProxy

void destroySNMPProxy(SNMPProxyMBean snmpProxy)

Removes a SNMPProxy from this domain

Parameters:

SNMPProxy -

Since:

9.0.0.0

lookupSNMPProxy

SNMPProxyMBean lookupSNMPProxy(String name)

Parameters:

name -

Returns:

SNMPProxy object

Since:

9.0.0.0

getSNMPGaugeMonitors

SNMPGaugeMonitorMBean[] getSNMPGaugeMonitors()

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

Returns:

The SNMPGaugeMonitors value

See Also:

SNMPGaugeMonitorMBean

setSNMPGaugeMonitors

void setSNMPGaugeMonitors(SNMPGaugeMonitorMBean[] snmpGaugeMonitors)
                          throws InvalidAttributeValueException,
                                 ConfigurationException

Deprecated. 9.0.0.0 Instead, use standard JMX design patterns using javax.management.MBeanServerConnection interface.

Sets the value of the SNMPGaugeMonitors attribute.

Parameters:

snmpGaugeMonitors - The new SNMPGaugeMonitors value

Throws:

InvalidAttributeValueException

ConfigurationException

See Also:

SNMPAgentMBean.getSNMPGaugeMonitors()

addSNMPGaugeMonitor

boolean addSNMPGaugeMonitor(SNMPGaugeMonitorMBean gaugemonitor)
                            throws InvalidAttributeValueException,
                                   ConfigurationException

Deprecated. 9.0.0.0 Instead, use standard JMX design patterns using javax.management.MBeanServerConnection interface.

Adds a feature to the SNMPGaugeMonitor attribute of the SNMPAgentMBean object

Parameters:

gaugemonitor - The feature to be added to the SNMPGaugeMonitor attribute

Returns:

Throws:

InvalidAttributeValueException

ConfigurationException

removeSNMPGaugeMonitor

boolean removeSNMPGaugeMonitor(SNMPGaugeMonitorMBean gaugemonitor)
                               throws InvalidAttributeValueException,
                                      ConfigurationException

Deprecated. 9.0.0.0 Instead, use standard JMX design patterns using javax.management.MBeanServerConnection interface.

Parameters:

gaugemonitor -

Returns:

Throws:

InvalidAttributeValueException

ConfigurationException

createSNMPGaugeMonitor

SNMPGaugeMonitorMBean createSNMPGaugeMonitor(String name)

Factory method to create SNMPGaugeMonitor objects

Parameters:

name -

Returns:

SNMPProxy object

Since:

9.0.0.0

destroySNMPGaugeMonitor

void destroySNMPGaugeMonitor(SNMPGaugeMonitorMBean gaugemonitor)

Removes a SNMPGaugeMonitor from this domain

Parameters:

SNMPGaugeMonitor -

Since:

9.0.0.0

lookupSNMPGaugeMonitor

SNMPGaugeMonitorMBean lookupSNMPGaugeMonitor(String name)

Parameters:

name -

Returns:

SNMPGaugeMonitor object

Since:

9.0.0.0

getSNMPStringMonitors

SNMPStringMonitorMBean[] getSNMPStringMonitors()

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

Returns:

The SNMPStringMonitors value

See Also:

SNMPStringMonitorMBean

setSNMPStringMonitors

void setSNMPStringMonitors(SNMPStringMonitorMBean[] snmpStringMonitors)
                           throws InvalidAttributeValueException,
                                  ConfigurationException

Deprecated. 9.0.0.0 Instead, use standard JMX design patterns using javax.management.MBeanServerConnection interface.

Sets the value of the SNMPStringMonitors attribute.

Parameters:

snmpStringMonitors - The new SNMPStringMonitors value

Throws:

InvalidAttributeValueException

ConfigurationException

See Also:

SNMPAgentMBean.getSNMPStringMonitors()

addSNMPStringMonitor

boolean addSNMPStringMonitor(SNMPStringMonitorMBean stringmonitor)
                             throws InvalidAttributeValueException,
                                    ConfigurationException

Deprecated. 9.0.0.0 Instead, use standard JMX design patterns using javax.management.MBeanServerConnection interface.

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

Parameters:

stringmonitor - The feature to be added to the SNMPStringMonitor attribute

Returns:

Throws:

InvalidAttributeValueException

ConfigurationException

See Also:

SNMPAgentMBean.getSNMPStringMonitors()

removeSNMPStringMonitor

boolean removeSNMPStringMonitor(SNMPStringMonitorMBean stringmonitor)
                                throws InvalidAttributeValueException,
                                       ConfigurationException

Deprecated. 9.0.0.0 Instead, use standard JMX design patterns using javax.management.MBeanServerConnection interface.

Parameters:

stringmonitor -

Returns:

Throws:

InvalidAttributeValueException

ConfigurationException

createSNMPStringMonitor

SNMPStringMonitorMBean createSNMPStringMonitor(String name)

Factory method to create SNMPStringMonitor objects

Parameters:

name -

Returns:

SNMPStringMonitor object

Since:

9.0.0.0

destroySNMPStringMonitor

void destroySNMPStringMonitor(SNMPStringMonitorMBean stringmonitor)

Removes a SNMPStringMonitor from this domain

Parameters:

SNMPStringMonitor -

Since:

9.0.0.0

lookupSNMPStringMonitor

SNMPStringMonitorMBean lookupSNMPStringMonitor(String name)

Parameters:

name -

Returns:

SNMPStringMonitor object

Since:

9.0.0.0

getSNMPCounterMonitors

SNMPCounterMonitorMBean[] getSNMPCounterMonitors()

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

Returns:

The SNMPCounterMonitors value

See Also:

SNMPCounterMonitorMBean

setSNMPCounterMonitors

void setSNMPCounterMonitors(SNMPCounterMonitorMBean[] snmpCounterMonitors)
                            throws InvalidAttributeValueException,
                                   ConfigurationException

Deprecated. 9.0.0.0 Instead, use standard JMX design patterns using javax.management.MBeanServerConnection interface.

Sets the value of the SNMPCounterMonitors attribute.

Parameters:

snmpCounterMonitors - The new SNMPCounterMonitors value

Throws:

InvalidAttributeValueException

ConfigurationException

See Also:

SNMPAgentMBean.getSNMPCounterMonitors()

addSNMPCounterMonitor

boolean addSNMPCounterMonitor(SNMPCounterMonitorMBean countermonitor)
                              throws InvalidAttributeValueException,
                                     ConfigurationException

Deprecated. 9.0.0.0 Instead, use standard JMX design patterns using javax.management.MBeanServerConnection interface.

Adds a feature to the SNMPCounterMonitor attribute of the SNMPAgentMBean object

Parameters:

countermonitor - The feature to be added to the SNMPCounterMonitor attribute

Returns:

Throws:

InvalidAttributeValueException

ConfigurationException

removeSNMPCounterMonitor

boolean removeSNMPCounterMonitor(SNMPCounterMonitorMBean countermonitor)
                                 throws InvalidAttributeValueException,
                                        ConfigurationException

Deprecated. 9.0.0.0 Instead, use standard JMX design patterns using javax.management.MBeanServerConnection interface.

Parameters:

countermonitor -

Returns:

Throws:

InvalidAttributeValueException

ConfigurationException

createSNMPCounterMonitor

SNMPCounterMonitorMBean createSNMPCounterMonitor(String name)

Factory method to create SNMPCounterMonitor objects

Parameters:

name -

Returns:

SNMPCounterMonitor object

Since:

9.0.0.0

destroySNMPCounterMonitor

void destroySNMPCounterMonitor(SNMPCounterMonitorMBean countermonitor)

Removes a SNMPCounterMonitor from this domain

Parameters:

SNMPCounterMonitor -

Since:

9.0.0.0

lookupSNMPCounterMonitor

SNMPCounterMonitorMBean lookupSNMPCounterMonitor(String name)

Parameters:

name -

Returns:

SNMPCounterMonitor object

Since:

9.0.0.0

getSNMPLogFilters

SNMPLogFilterMBean[] getSNMPLogFilters()

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

Returns:

The SNMPLogFilters value

See Also:

SNMPLogFilterMBean

setSNMPLogFilters

void setSNMPLogFilters(SNMPLogFilterMBean[] snmpLogFilters)
                       throws InvalidAttributeValueException,
                              ConfigurationException

Deprecated. 9.0.0.0 Instead, use standard JMX design patterns using javax.management.MBeanServerConnection interface.

Sets the value of the SNMPLogFilters attribute.

Parameters:

snmpLogFilters - The new SNMPLogFilters value

Throws:

InvalidAttributeValueException

ConfigurationException

See Also:

SNMPAgentMBean.getSNMPLogFilters()

addSNMPLogFilter

boolean addSNMPLogFilter(SNMPLogFilterMBean logfilter)
                         throws InvalidAttributeValueException,
                                ConfigurationException

Deprecated. 9.0.0.0 Instead, use standard JMX design patterns using javax.management.MBeanServerConnection interface.

Adds a feature to the SNMPLogFilter attribute of the SNMPAgentMBean object

Parameters:

logfilter - The feature to be added to the SNMPLogFilter attribute

Returns:

Throws:

InvalidAttributeValueException

ConfigurationException

removeSNMPLogFilter

boolean removeSNMPLogFilter(SNMPLogFilterMBean logfilter)
                            throws InvalidAttributeValueException,
                                   ConfigurationException

Deprecated. 9.0.0.0 Instead, use standard JMX design patterns using javax.management.MBeanServerConnection interface.

Parameters:

logfilter -

Returns:

Throws:

InvalidAttributeValueException

ConfigurationException

createSNMPLogFilter

SNMPLogFilterMBean createSNMPLogFilter(String name)

Factory method to create SNMPLogFilter objects

Parameters:

name -

Returns:

SNMPLogFilter object

Since:

9.0.0.0

destroySNMPLogFilter

void destroySNMPLogFilter(SNMPLogFilterMBean logfilter)

Removes a SNMPLogFilter from this domain

Parameters:

SNMPLogFilter -

Since:

9.0.0.0

lookupSNMPLogFilter

SNMPLogFilterMBean lookupSNMPLogFilter(String name)

Parameters:

name -

Returns:

SNMPLogFilter object

Since:

9.0.0.0

getSNMPAttributeChanges

SNMPAttributeChangeMBean[] getSNMPAttributeChanges()

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

Returns:

The SNMPAttributeChanges value

See Also:

SNMPAttributeChangeMBean

setSNMPAttributeChanges

void setSNMPAttributeChanges(SNMPAttributeChangeMBean[] snmpAttributeChanges)
                             throws InvalidAttributeValueException,
                                    ConfigurationException

Deprecated. 9.0.0.0 Instead, use standard JMX design patterns using javax.management.MBeanServerConnection interface.

Sets the value of the SNMPAttributeChanges attribute.

Parameters:

snmpAttributeChanges - The new SNMPAttributeChanges value

Throws:

InvalidAttributeValueException

ConfigurationException

See Also:

SNMPAgentMBean.getSNMPAttributeChanges()

addSNMPAttributeChange

boolean addSNMPAttributeChange(SNMPAttributeChangeMBean attrchange)
                               throws InvalidAttributeValueException,
                                      ConfigurationException

Deprecated. 9.0.0.0 Instead, use standard JMX design patterns using javax.management.MBeanServerConnection interface.

Adds a feature to the SNMPAttributeChange attribute of the SNMPAgentMBean object

Parameters:

attrchange - The feature to be added to the SNMPAttributeChange attribute

Returns:

Throws:

InvalidAttributeValueException

ConfigurationException

removeSNMPAttributeChange

boolean removeSNMPAttributeChange(SNMPAttributeChangeMBean attrchange)
                                  throws InvalidAttributeValueException,
                                         ConfigurationException

Deprecated. 9.0.0.0 Instead, use standard JMX design patterns using javax.management.MBeanServerConnection interface.

Parameters:

attrchange -

Returns:

Throws:

InvalidAttributeValueException

ConfigurationException

createSNMPAttributeChange

SNMPAttributeChangeMBean createSNMPAttributeChange(String name)

Factory method to create SNMPAttributeChange objects

Parameters:

name -

Returns:

SNMPAttributeChange object

Since:

9.0.0.0

destroySNMPAttributeChange

void destroySNMPAttributeChange(SNMPAttributeChangeMBean attrchange)

Removes a SNMPAttributeChange from this domain

Parameters:

SNMPAttributeChange -

Since:

9.0.0.0

lookupSNMPAttributeChange

SNMPAttributeChangeMBean lookupSNMPAttributeChange(String name)

Parameters:

name -

Returns:

SNMPAttributeChange object

Since:

9.0.0.0

isCommunityBasedAccessEnabled

boolean isCommunityBasedAccessEnabled()

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.

Since:

10.0.0.0

Default Value:

true

setCommunityBasedAccessEnabled

void setCommunityBasedAccessEnabled(boolean enabled)

getSNMPEngineId

String getSNMPEngineId()

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.

Since:

10.0.0.0

This method can NOT set a null value.

setSNMPEngineId

void setSNMPEngineId(String engineId)

getAuthenticationProtocol

String getAuthenticationProtocol()

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.

Since:

10.0.0.0

This method can NOT set a null value.

Default Value:

SNMPAgentMBean.NO_AUTH

Valid Values:

SNMPAgentMBean.NO_AUTH, SNMPAgentMBean.MD5, SNMPAgentMBean.SHA

Default value in production mode:

SNMPAgentMBean.MD5

setAuthenticationProtocol

void setAuthenticationProtocol(String protocol)

getPrivacyProtocol

String getPrivacyProtocol()

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.

Since:

10.0.0.0

See Also:

SNMPTrapDestinationMBean.getSecurityLevel()

This method can NOT set a null value.

Default Value:

SNMPAgentMBean.NO_PRIV

Valid Values:

SNMPAgentMBean.NO_PRIV, SNMPAgentMBean.DES, SNMPAgentMBean.AES_128

setPrivacyProtocol

void setPrivacyProtocol(String protocol)

getInformRetryInterval

int getInformRetryInterval()

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.

Since:

10.0.0.0

Default Value:

10000

Maximum Value:

30000

Minimum Value:

3000

setInformRetryInterval

void setInformRetryInterval(int interval)

getMaxInformRetryCount

int getMaxInformRetryCount()

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

Since:

10.0.0.0

Default Value:

1

Maximum Value:

3

Minimum Value:

1

setMaxInformRetryCount

void setMaxInformRetryCount(int retryCount)

getLocalizedKeyCacheInvalidationInterval

long getLocalizedKeyCacheInvalidationInterval()

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.

Since:

10.0.0.0

See Also:

SNMPAgentRuntimeMBean, SNMPTrapDestinationMBean

Default Value:

3600*1000

Maximum Value:

3600*1000*24

setLocalizedKeyCacheInvalidationInterval

void setLocalizedKeyCacheInvalidationInterval(long value)

isSNMPAccessForUserMBeansEnabled

boolean isSNMPAccessForUserMBeansEnabled()

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.

Since:

10.0.0.0

See Also:

SNMPAgentMBean.getMasterAgentXPort()

setSNMPAccessForUserMBeansEnabled

void setSNMPAccessForUserMBeansEnabled(boolean v)

isInformEnabled

boolean isInformEnabled()

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.

Since:

10.0.0.0

See Also:

SNMPAgentMBean.getSNMPTrapVersion()

Default Value:

false

setInformEnabled

void setInformEnabled(boolean value)

getMasterAgentXPort

int getMasterAgentXPort()

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.

Since:

10.0.0.0

Default Value:

705

Maximum Value:

65535

Minimum Value:

1

setMasterAgentXPort

void setMasterAgentXPort(int value)