SNMPCounterMonitorMBean


Overview  |   Related MBeans  |   Attributes  |   Operations

Overview

This class describes the criteria for a Counter-based Monitor. A trap will be generated when this criteria is satisfied.

   
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.configuration.SNMPCounterMonitorMBean
Factory Methods


Related MBeans

This section describes attributes that provide access to other MBeans. For more information about the MBean hierarchy, refer to WebLogic Server MBean Data Model.


    EnabledServers

    The list of target servers for trap generation. If no server is specified, no trap will be generated.

           
    Privileges Read/Write
    TypeServerMBean[]
    Relationship type: Reference.
    Redeploy or Restart required Changes take effect after you redeploy the module or restart the server.


    Attributes

    This section describes the following attributes:


    Modulus

    An integer value to be subtracted from the threshold value when the threshold value is crossed.

    If Modulus is 0, a trap is generated each time the agent polls the monitored attribute and its value still exceeds or equals the threshold value.

    If Modulus is larger than 0, the value of the modulus is subtracted from the threshold each time the threshold is crossed.

           
    Privileges Read/Write
    Typeint
    Minimum value0

    MonitoredAttributeName

    The name of an MBean attribute to monitor. This attribute must be in the WebLogic Server MIB.

           
    Privileges Read/Write
    Typejava.lang.String

    MonitoredMBeanName

    The name of the MBean instance that you want to monitor. If you leave the name undefined, WebLogic Server monitors all instances of the MBean type that you specify in Monitored MBean Type.

    Do not enter the full JMX object name of the MBean instance. Instead, enter only the value of the object name's Name=name name-value pair. To create unique MBean object names, WebLogic Server encodes several name-value pairs into each object name. One of these pairs is Name=name. For example:
    "MedRec:Name=MedRecServer,
    Type=ServerRuntime"

    In the previous example, specify MedRecServer as the name of the MBean instance.

           
    Privileges Read/Write
    Typejava.lang.String

    MonitoredMBeanType

    The MBean type that defines the attribute you want to monitor. Do not include the MBean suffix. For example, ServerRuntime.

           
    Privileges Read/Write
    Typejava.lang.String

    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

           
    Privileges Read/Write
    Typejava.lang.String

    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 &lt;. 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.

           
    Privileges Read/Write
    Typejava.lang.String

    Offset

    An integer value to be added to the threshold value when the threshold is crossed.

    If Offset is 0, a trap is generated each time the agent polls the monitored attribute and its value still exceeds or equals the value in the Threshold.

    If Offset is larger than 0, the value of the offset is added to the threshold each time the threshold is crossed.

    For example, if you set Threshold to 1000 and Offset to 2000, when the observed attribute exceeds 1000, the Counter Monitor sends a notification and increases the threshold to 3000. When the observed attribute exceeds 3000, the Counter Monitor sends a notification and increases the threshold again to 5000.

           
    Privileges Read/Write
    Typeint
    Minimum value0

    Parent

    Return the immediate parent for this MBean

           
    Privileges Read/Write
    Type

    PollingInterval

    The frequency (in seconds) that WebLogic Server checks the attribute value.

           
    Privileges Read/Write
    Typeint
    Default Value1
    Minimum value1
    Maximum value65535

    Threshold

    Specifies a value that triggers the Counter Monitor to generate a trap.

    The Counter Monitor generates a trap each time it polls the value and determines that the value has transitioned from below the threshold to at or above the threshold. While the value remains at or above the threshold, the Counter Monitor does not generate additional traps.

    If the threshold is 0, the counter monitor to generates a trap each time it polls the value, unless the value is negative.

           
    Privileges Read/Write
    Typeint
    Minimum value0

    Type

    Returns the type of the MBean.

           
    Privileges Read only
    Typejava.lang.String
    Redeploy or Restart required Changes take effect after you redeploy the module or restart the server.


    Operations

    This section describes the following operations:


    addEnabledServer

    Adds a feature to the EnabledServer attribute of the SNMPTrapSourceMBean object

       
    Operation Name"addEnabledServer"
    ParametersObject [] {  server }

    where:

    • server is an object of type weblogic.management.configuration.ServerMBean that specifies:

      The feature to be added to the EnabledServer attribute

    SignatureString [] { "weblogic.management.configuration.ServerMBean" }
    Returns boolean
    Exceptions
    • javax.management.InvalidAttributeValueException
    • weblogic.management.configuration.ConfigurationException

    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

       
    Operation Name"freezeCurrentValue"
    ParametersObject [] {  attributeName }

    where:

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

      attributeName

    SignatureString [] { "java.lang.String" }
    Returns void
    Exceptions
    • javax.management.AttributeNotFoundException
    • javax.management.MBeanException

    isSet

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

       
    Operation Name"isSet"
    ParametersObject [] {  propertyName }

    where:

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

      property to check

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

    removeEnabledServer

       
    Operation Name"removeEnabledServer"
    ParametersObject [] {  server }

    where:

    • server is an object of type weblogic.management.configuration.ServerMBean that specifies:

      server

    SignatureString [] { "weblogic.management.configuration.ServerMBean" }
    Returns boolean
    Exceptions
    • javax.management.InvalidAttributeValueException
    • weblogic.management.configuration.ConfigurationException

    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

       
    Operation Name"restoreDefaultValue"
    ParametersObject [] {  attributeName }

    where:

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

      attributeName

    SignatureString [] { "java.lang.String" }
    Returns void
    Exceptions
    • javax.management.AttributeNotFoundException

    unSet

    Restore the given property to its default value.

       
    Operation Name"unSet"
    ParametersObject [] {  propertyName }

    where:

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

      property to restore

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