SNMPAgentRuntimeMBean


Overview  |   Related MBeans  |   Attributes  |   Operations

Overview

Runtime information for an SNMP agent that is running in the current WebLogic Server domain.

       
Since9.0.0.0
Fully Qualified Interface NameIf you use the getMBeanInfo operation in MBeanTypeServiceMBean, supply the following value as this MBean's fully qualified interface name:
weblogic.management.runtime.SNMPAgentRuntimeMBean

For more information, see:

Factory Methods No factory methods. Instances of this MBean are created automatically.
Access Points You can access this MBean from the following MBean attributes:


    Attributes

    This section describes the following attributes:


    AttributeChangeTrapCount

    The number of attribute change notifications that this SNMP agent has sent to all trap destinations since the agent's host server was started.

           
    Available Since Release 10.0.0.0
    Privileges Read only
    Typelong

    CachingDisabled

    Private property that disables caching in proxies.

           
    Privileges Read only
    Typeboolean

    CounterMonitorTrapCount

    The number of counter monitor notifications that this SNMP agent has sent to all trap destinations since the agent's host server was started.

           
    Available Since Release 10.0.0.0
    Privileges Read only
    Typelong

    FailedAuthenticationCount

    The number of requests that this agent has rejected because of incorrect user credentials.

           
    Available Since Release 10.0.0.0
    Privileges Read only
    Typeint

    FailedAuthorizationCount

    The number of requests that this agent has rejected because an authenticated user does not have sufficient privileges to view the requested information. You use the WebLogic Server security realm to assign privileges to users.

           
    Available Since Release 10.0.0.0
    Privileges Read only
    Typeint

    FailedEncryptionCount

    The number of requests that this agent has rejected because of incorrect privacy (encryption) credentials

           
    Available Since Release 10.0.0.0
    Privileges Read only
    Typeint

    GaugeMonitorTrapCount

    The number of gauge monitor notifications that this SNMP agent has sent to all trap destinations since the agent's host server was started.

           
    Available Since Release 10.0.0.0
    Privileges Read only
    Typelong

    LogMessageTrapCount

    The number of log message notifications that this SNMP agent has sent to all trap destinations since the agent's host server was started.

           
    Available Since Release 10.0.0.0
    Privileges Read only
    Typelong

    MasterAgentXPort

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

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

           
    Available Since Release 10.0.0.0
    Privileges Read only
    Typeint

    MBeanInfo

    Returns the MBean info for this MBean.

    Deprecated.

           
    Privileges Read only
    Typejavax.management.MBeanInfo

    MonitorTrapCount

    The total number of all notifications that this SNMP agent has sent to all trap destinations since the agent's host server was started.

           
    Available Since Release 10.0.0.0
    Privileges Read only
    Typelong

    Name

    The name of this configuration. WebLogic Server uses an MBean to implement and persist the configuration.

           
    Privileges Read only
    Typejava.lang.String

    ObjectName

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

    Deprecated.

           
    Privileges Read only
    Typeweblogic.management.WebLogicObjectName

    Parent

    Return the immediate parent for this MBean

           
    Privileges Read/Write
    Type

    Registered

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

    Deprecated.

           
    Privileges Read only
    Typeboolean

    Running

    Indicates whether this SNMP agent is running.

           
    Available Since Release 10.0.0.0
    Privileges Read only
    Typeboolean

    ServerStartTrapCount

    The number of serverStart notifications that this SNMP agent has sent to all trap destinations since the agent's host server was started.

           
    Available Since Release 10.0.0.0
    Privileges Read only
    Typelong

    ServerStopTrapCount

    The number of serverShutdown notifications that this SNMP agent has sent to all trap destinations since the agent's host server was started.

           
    Available Since Release 10.0.0.0
    Privileges Read only
    Typelong

    SNMPAgentName

           
    Available Since Release 10.0.0.0
    Privileges Read only
    Typejava.lang.String

    StringMonitorTrapCount

    The number of string monitor notifications that this SNMP agent has sent to all trap destinations since the agent's host server was started.

           
    Available Since Release 10.0.0.0
    Privileges Read only
    Typelong

    Type

    Returns the type of the MBean.

           
    Privileges Read only
    Typejava.lang.String

    UDPListenPort

    The UDP port on which this SNMP agent is listening for incoming requests from SNMP managers.

    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:

           
    Available Since Release 10.0.0.0
    Privileges Read only
    Typeint


    Operations

    This section describes the following operations:


    invalidateLocalizedKeyCache

    Immediately invalidates the cached security keys for the specified WebLogic Server user.

    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.

    Instead of waiting for WebLogic Server to invalidate the cached entry for a key, you can invalidate it immediately.

    For more information, see:

       
    Operation Name"invalidateLocalizedKeyCache"
    ParametersObject [] {  username }

    where:

    • username is an object of type java.lang.String that specifies:

      Name of the user

    SignatureString [] { "java.lang.String" }
    Returns void

    outputCustomMBeansMIBModule

    Returns WebLogic Server's MIB module for custom MBeans as a java.lang.String. You can save the String to a file and then load the file into a MIB browser.

    When you register custom MBeans in the WebLogic Server Runtime MBean Server, WebLogic Server adds entries to a runtime MIB module that it 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 module as a file or other data structure, the OIDs in the module remain constant across server sessions.

       
    Operation Name"outputCustomMBeansMIBModule"
    Parametersnull
    Signaturenull
    ReturnsString
    Exceptions
    • weblogic.management.ManagementException
      ManagementException

    preDeregister

       
    Operation Name"preDeregister"
    Parametersnull
    Signaturenull
    Returns void
    Exceptions
    • java.lang.Exception