SNMPTrapDestinationMBean


Overview  |   Related MBeans  |   Attributes  |   Operations

Overview

This MBean describes a destination to which an SNMP agent sends SNMP TRAP and INFORM notifications.

   
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.SNMPTrapDestinationMBean
Factory Methods
Additional Access Points In addition to accessing this MBean by invoking a factory method, you can also access this MBean from the following MBean attributes:


    Attributes

    This section describes the following attributes:


    CachingDisabled

    Private property that disables caching in proxies.

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

    Community

    The password (community name) that a WebLogic Server SNMP agent sends to the SNMP manager when the agent generates SNMPv1 or SNMPv2 notifications.

    The community name that you enter in this trap destination must match the name that the SNMP manager defines.

           
    Privileges Read/Write
    Typejava.lang.String
    Default Valuepublic

    Host

    The DNS name or IP address of the computer on which the SNMP manager is running.

    The WebLogic SNMP agent sends trap notifications to the host and port that you specify.

           
    Privileges Read/Write
    Typejava.lang.String
    Default Valuelocalhost
    Secure value127.0.0.1

    MBeanInfo

    Returns the MBean info for this MBean.

    Deprecated.

           
    Privileges Read only
    Typejavax.management.MBeanInfo
    Redeploy or Restart required Changes take effect after you redeploy the module or restart the server.

    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 Server 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

    ObjectName

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

    Deprecated.

           
    Privileges Read only
    Typeweblogic.management.WebLogicObjectName
    Redeploy or Restart required Changes take effect after you redeploy the module or restart the server.

    Parent

    Return the immediate parent for this MBean

           
    Privileges Read/Write
    Type

    Port

    The UDP port on which the SNMP manager is listening.

           
    Privileges Read/Write
    Typeint
    Default Value162
    Minimum value1
    Maximum value65535

    Registered

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

    Deprecated.

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

    SecurityLevel

    Specifies the security protocols that the SNMP agent uses when sending SNMPv3 responses or notifications to the SNMP manager that this trap destination represents. Requires you to specify a security name for this trap destination.

    For more information, see:

           
    Available Since Release 10.0.0.0
    Privileges Read/Write
    Typejava.lang.String
    Default ValuenoAuthNoPriv
    Legal Values
    • noAuthNoPriv
    • authNoPriv
    • authPriv

    SecurityName

    Specifies the user name that the WebLogic Server SNMP agent encodes into SNMPv3 responses or notifications. Requires you to create a credential map for this user name in the WebLogic Server security realm.

    The credential map contains an authentication password and an optional privacy password for this user.

    The user name and passwords must match the credentials required by the SNMP manager that this trap destination represents.

           
    Available Since Release 10.0.0.0
    Privileges Read/Write
    Typejava.lang.String

    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:


    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

    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