SNMPAgentMBean


Overview  |   Related MBeans  |   Attributes  |   Operations

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.

       
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.SNMPAgentMBean
Factory Methods No factory methods. Instances of this MBean are created automatically.
Access Points You can access this MBean from the following MBean attributes:
    Subtypes The following MBeans extend or implement this MBean type:


      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:

                 
      Factory MethodscreateSNMPAttributeChange (java.lang.String name)

      destroySNMPAttributeChange (SNMPAttributeChangeMBean attrchange)

      Factory methods do not return objects.

      See Using factory methods.

      Lookup OperationlookupSNMPAttributeChange(String name)

      Returns a javax.management.ObjectName for the instance of SNMPAttributeChangeMBean named name.

      Privileges Read/Write

      Setter method for this attribute is deprecated. 9.0.0.0 Instead, use standard JMX design patterns using <code>javax.management.MBeanServerConnection</code> interface.

      TypeSNMPAttributeChangeMBean[]
      Relationship type: Containment.

      SNMPCounterMonitors

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

      For more information, see:

                 
      Factory MethodscreateSNMPCounterMonitor (java.lang.String name)

      destroySNMPCounterMonitor (SNMPCounterMonitorMBean countermonitor)

      Factory methods do not return objects.

      See Using factory methods.

      Lookup OperationlookupSNMPCounterMonitor(String name)

      Returns a javax.management.ObjectName for the instance of SNMPCounterMonitorMBean named name.

      Privileges Read/Write

      Setter method for this attribute is deprecated. 9.0.0.0 Instead, use standard JMX design patterns using <code>javax.management.MBeanServerConnection</code> interface.

      TypeSNMPCounterMonitorMBean[]
      Relationship type: Containment.

      SNMPGaugeMonitors

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

      For more information, see:

                 
      Factory MethodscreateSNMPGaugeMonitor (java.lang.String name)

      destroySNMPGaugeMonitor (SNMPGaugeMonitorMBean gaugemonitor)

      Factory methods do not return objects.

      See Using factory methods.

      Lookup OperationlookupSNMPGaugeMonitor(String name)

      Returns a javax.management.ObjectName for the instance of SNMPGaugeMonitorMBean named name.

      Privileges Read/Write

      Setter method for this attribute is deprecated. 9.0.0.0 Instead, use standard JMX design patterns using <code>javax.management.MBeanServerConnection</code> interface.

      TypeSNMPGaugeMonitorMBean[]
      Relationship type: Containment.

      SNMPLogFilters

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

      For more information, see:

                 
      Factory MethodscreateSNMPLogFilter (java.lang.String name)

      destroySNMPLogFilter (SNMPLogFilterMBean logfilter)

      Factory methods do not return objects.

      See Using factory methods.

      Lookup OperationlookupSNMPLogFilter(String name)

      Returns a javax.management.ObjectName for the instance of SNMPLogFilterMBean named name.

      Privileges Read/Write

      Setter method for this attribute is deprecated. 9.0.0.0 Instead, use standard JMX design patterns using <code>javax.management.MBeanServerConnection</code> interface.

      TypeSNMPLogFilterMBean[]
      Relationship type: Containment.

      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:

                 
      Factory MethodscreateSNMPProxy (java.lang.String name)

      destroySNMPProxy (SNMPProxyMBean snmpProxy)

      Factory methods do not return objects.

      See Using factory methods.

      Lookup OperationlookupSNMPProxy(String name)

      Returns a javax.management.ObjectName for the instance of SNMPProxyMBean named name.

      Privileges Read/Write

      Setter method for this attribute is deprecated. 9.0.0.0 Instead, use standard JMX design patterns using <code>javax.management.MBeanServerConnection</code> interface.

      TypeSNMPProxyMBean[]
      Relationship type: Containment.

      SNMPStringMonitors

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

      For more information, see:

                 
      Factory MethodscreateSNMPStringMonitor (java.lang.String name)

      destroySNMPStringMonitor (SNMPStringMonitorMBean stringmonitor)

      Factory methods do not return objects.

      See Using factory methods.

      Lookup OperationlookupSNMPStringMonitor(String name)

      Returns a javax.management.ObjectName for the instance of SNMPStringMonitorMBean named name.

      Privileges Read/Write

      Setter method for this attribute is deprecated. 9.0.0.0 Instead, use standard JMX design patterns using <code>javax.management.MBeanServerConnection</code> interface.

      TypeSNMPStringMonitorMBean[]
      Relationship type: Containment.

      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.

                 
      Factory MethodscreateSNMPTrapDestination (java.lang.String name)

      destroySNMPTrapDestination (SNMPTrapDestinationMBean trapdestination)

      Factory methods do not return objects.

      See Using factory methods.

      Lookup OperationlookupSNMPTrapDestination(String name)

      Returns a javax.management.ObjectName for the instance of SNMPTrapDestinationMBean named name.

      Privileges Read only
      TypeSNMPTrapDestinationMBean[]
      Relationship type: Containment.

      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.

                 
      Lookup OperationlookupSNMPTrapDestination(String name)

      Returns a javax.management.ObjectName for the instance of SNMPTrapDestinationMBean named name.

      Privileges Read/Write
      TypeSNMPTrapDestinationMBean[]
      Relationship type: Reference.


      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.

             
      Available Since Release 10.0.0.0
      Privileges Read/Write
      Typejava.lang.String
      Default ValueMD5
      Legal Values
      • noAuth
      • MD5
      • SHA

      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.

      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.

      Deprecated. 12.2.1.4 There is no replacement for this attribute as SNMPv1 and v2 support will be removed.

             
      Available Since Release 10.0.0.0
      Privileges Read/Write
      Typeboolean

      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:

      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 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 or private.

      You cannot specify a null (empty) value for the community prefix when SNMP agent is enabled. If you do not want this agent to receive SNMPv1 or v2 requests, disable community based access.

      Deprecated. 12.2.1.4 There is no replacement for this attribute as SNMPv1 and v2 support will be removed.

             
      Privileges Read/Write
      Typejava.lang.String
      Secure valueA unique value, should not be public or private

      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:

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

             
      Privileges Read/Write
      Typeint
      Default Value0
      Legal Values
      • 0
      • 1
      • 2
      • 3
      Secure value0

      DynamicallyCreated

      Return whether the MBean was created dynamically or is persisted to config.xml

             
      Privileges Read only
      Typeboolean

      Enabled

      Specifies whether this SNMP agent is enabled.

             
      Privileges Read/Write
      Typeboolean

      Id

      Return the unique id of this MBean instance

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

      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:

             
      Available Since Release 10.0.0.0
      Privileges Read/Write
      Typeboolean

      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.

             
      Available Since Release 10.0.0.0
      Privileges Read/Write
      Typeint
      Default Value10000
      Minimum value3000
      Maximum value30000

      ListenAddress

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

      If not specified the Server's ListenAddress is used as the ListenAddress for the SNMPAgent.

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

      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:

             
      Available Since Release 10.0.0.0
      Privileges Read/Write
      Typelong
      Default Value3600000
      Maximum value86400000

      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.

             
      Available Since Release 10.0.0.0
      Privileges Read/Write
      Typeint
      Default Value705
      Minimum value1
      Maximum value65535

      MaxInformRetryCount

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

             
      Available Since Release 10.0.0.0
      Privileges Read/Write
      Typeint
      Default Value1
      Minimum value1
      Maximum value3

      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.

      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.

             
      Privileges Read/Write
      Typeint
      Default Value120
      Minimum value30
      Maximum value65535

      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
      Security rolesWrite access is granted only to the following roles:
      • Deployer
      • Operator
      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

      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:

             
      Available Since Release 10.0.0.0
      Privileges Read/Write
      Typejava.lang.String
      Default ValueAES_128
      Legal Values
      • noPriv
      • DES
      • AES_128

      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.

      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:

      For more information, see:

             
      Privileges Read/Write
      Typeboolean
      Default Valuetrue

      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.

             
      Privileges Read/Write
      Typeint
      Default Value1
      Minimum value1
      Maximum value65535

      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:

             
      Available Since Release 10.0.0.0
      Privileges Read/Write
      Typeboolean

      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.

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

      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:

             
      Privileges Read/Write
      Typeint
      Default Value161
      Minimum value1
      Maximum value65535

      SNMPTrapVersion

      The SNMP notification version that this SNMP agent generates.

      For more information, see:

             
      Privileges Read/Write
      Typeint
      Default Value3
      Legal Values
      • 1
      • 2
      • 3

      Tags

      Return all tags on this Configuration MBean

             
      Available Since Release 12.2.1.0.0
      Privileges Read/Write
      Typeclass java.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:


      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.

         
      Operation Name"addSNMPAttributeChange"
      ParametersObject [] {  attrchange }

      where:

      • attrchange is an object of type weblogic.management.configuration.SNMPAttributeChangeMBean that specifies:

        The feature to be added to the SNMPAttributeChange attribute

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

      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.

         
      Operation Name"addSNMPCounterMonitor"
      ParametersObject [] {  countermonitor }

      where:

      • countermonitor is an object of type weblogic.management.configuration.SNMPCounterMonitorMBean that specifies:

        The feature to be added to the SNMPCounterMonitor attribute

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

      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.

         
      Operation Name"addSNMPGaugeMonitor"
      ParametersObject [] {  gaugemonitor }

      where:

      • gaugemonitor is an object of type weblogic.management.configuration.SNMPGaugeMonitorMBean that specifies:

        The feature to be added to the SNMPGaugeMonitor attribute

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

      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.

         
      Operation Name"addSNMPLogFilter"
      ParametersObject [] {  logfilter }

      where:

      • logfilter is an object of type weblogic.management.configuration.SNMPLogFilterMBean that specifies:

        The feature to be added to the SNMPLogFilter attribute

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

      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.

         
      Operation Name"addSNMPProxy"
      ParametersObject [] {  snmpProxy }

      where:

      • snmpProxy is an object of type weblogic.management.configuration.SNMPProxyMBean that specifies:

        The feature to be added to the SNMPProxy attribute

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

      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:

         
      Operation Name"addSNMPStringMonitor"
      ParametersObject [] {  stringmonitor }

      where:

      • stringmonitor is an object of type weblogic.management.configuration.SNMPStringMonitorMBean that specifies:

        The feature to be added to the SNMPStringMonitor attribute

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

      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.

         
      Operation Name"addSNMPTrapDestination"
      ParametersObject [] {  trapdestination }

      where:

      • trapdestination is an object of type weblogic.management.configuration.SNMPTrapDestinationMBean that specifies:

        The feature to be added to the SNMPTrapDestination attribute

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

      addTag

      Add a tag to this Configuration MBean. Adds a tag to the current set of tags on the Configuration MBean. Tags may contain white spaces.

         
      Operation Name"addTag"
      ParametersObject [] {  tag }

      where:

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

        tag to be added to the MBean

      SignatureString [] { "java.lang.String" }
      Returns boolean
      Exceptions
      • java.lang.IllegalArgumentException
        IllegalArgumentException if the tag contains illegal punctuation

      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:

         
      Operation Name"addTargetedTrapDestination"
      ParametersObject [] {  trapdestination }

      where:

      • trapdestination is an object of type weblogic.management.configuration.SNMPTrapDestinationMBean that specifies:

        The feature to be added to the TargetedTrapDestination attribute

      SignatureString [] { "weblogic.management.configuration.SNMPTrapDestinationMBean" }
      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

      getInheritedProperties

      Return all properties' names whose value is inherited from template mbean. this is a convenient method to get inheritance info on multiple properties in one jmx call.

         
      Operation Name"getInheritedProperties"
      ParametersObject [] {  propertyNames }

      where:

      • propertyNames is an object of type [Ljava.lang.String; that specifies:

        properties to check

      SignatureString [] { "[Ljava.lang.String;" }
      Returns class

      isInherited

      Check if the value of a property is inherited from template mbean or not.

         
      Operation Name"isInherited"
      ParametersObject [] {  propertyName }

      where:

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

        the name of the property

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

      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

      removeSNMPAttributeChange

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

         
      Operation Name"removeSNMPAttributeChange"
      ParametersObject [] {  attrchange }

      where:

      • attrchange is an object of type weblogic.management.configuration.SNMPAttributeChangeMBean that specifies:

        attrchange

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

      removeSNMPCounterMonitor

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

         
      Operation Name"removeSNMPCounterMonitor"
      ParametersObject [] {  countermonitor }

      where:

      • countermonitor is an object of type weblogic.management.configuration.SNMPCounterMonitorMBean that specifies:

        countermonitor

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

      removeSNMPGaugeMonitor

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

         
      Operation Name"removeSNMPGaugeMonitor"
      ParametersObject [] {  gaugemonitor }

      where:

      • gaugemonitor is an object of type weblogic.management.configuration.SNMPGaugeMonitorMBean that specifies:

        gaugemonitor

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

      removeSNMPLogFilter

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

         
      Operation Name"removeSNMPLogFilter"
      ParametersObject [] {  logfilter }

      where:

      • logfilter is an object of type weblogic.management.configuration.SNMPLogFilterMBean that specifies:

        logfilter

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

      removeSNMPProxy

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

         
      Operation Name"removeSNMPProxy"
      ParametersObject [] {  snmpProxy }

      where:

      • snmpProxy is an object of type weblogic.management.configuration.SNMPProxyMBean that specifies:

        snmpProxy

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

      removeSNMPStringMonitor

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

         
      Operation Name"removeSNMPStringMonitor"
      ParametersObject [] {  stringmonitor }

      where:

      • stringmonitor is an object of type weblogic.management.configuration.SNMPStringMonitorMBean that specifies:

        stringmonitor

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

      removeTag

      Remove a tag from this Configuration MBean

         
      Operation Name"removeTag"
      ParametersObject [] {  tag }

      where:

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

        tag to be removed from the MBean

      SignatureString [] { "java.lang.String" }
      Returns boolean
      Exceptions
      • java.lang.IllegalArgumentException
        IllegalArgumentException if the tag contains illegal punctuation

      removeTargetedTrapDestination

      Deprecated. 9.0.0.0

         
      Operation Name"removeTargetedTrapDestination"
      ParametersObject [] {  trapdestination }

      where:

      • trapdestination is an object of type weblogic.management.configuration.SNMPTrapDestinationMBean that specifies:

        trapdestination

      SignatureString [] { "weblogic.management.configuration.SNMPTrapDestinationMBean" }
      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