# SNMPAgentMBean

Overview | Related MBeans | Attributes | Operations

## Overview

The MBean representing the SNMP Agent Configuration. The SNMP Agent MBean is a singleton for the SNMP Agent Configuration and does not belong to any configuration.

Fully Qualified Interface Name | If 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:
DomainMBean.SNMPAgent |

## 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.

SNMPAttributeChanges SNMPCounterMonitors SNMPGaugeMonitors SNMPLogFilters SNMPProxies | SNMPStringMonitors SNMPTrapDestinations TargetedTrapDestinations

### SNMPAttributeChanges

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

Deprecated. 9.0.0.0

For more information, see:

- SNMPAttributeChangeMBean

Factory Methods | `createSNMPAttributeChange (java.lang.String name)` `destroySNMPAttributeChange (SNMPAttributeChangeMBean SNMPAttributeChange)` Factory methods do not return objects. See Using factory methods.
Lookup Operation | `lookupSNMPAttributeChange(String name)` Returns a `javax.management.ObjectName` for the instance of `SNMPAttributeChangeMBean` named `name`.
Privileges | Read/Write
Type | SNMPAttributeChangeMBean[]
Relationship type: | Containment.
Redeploy or Restart required | Changes take effect after you redeploy the module or restart the server.

### SNMPCounterMonitors

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

Deprecated. 9.0.0.0

For more information, see:

- SNMPCounterMonitorMBean

Factory Methods | `createSNMPCounterMonitor (java.lang.String name)` `destroySNMPCounterMonitor (SNMPCounterMonitorMBean SNMPCounterMonitor)` Factory methods do not return objects. See Using factory methods.
Lookup Operation | `lookupSNMPCounterMonitor(String name)` Returns a `javax.management.ObjectName` for the instance of `SNMPCounterMonitorMBean` named `name`.
Privileges | Read/Write
Type | SNMPCounterMonitorMBean[]
Relationship type: | Containment.
Redeploy or Restart required | Changes take effect after you redeploy the module or restart the server.

### SNMPGaugeMonitors

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

Deprecated. 9.0.0.0

For more information, see:

- SNMPGaugeMonitorMBean

Factory Methods | `createSNMPGaugeMonitor (java.lang.String name)` `destroySNMPGaugeMonitor (SNMPGaugeMonitorMBean SNMPGaugeMonitor)` Factory methods do not return objects. See Using factory methods.
Lookup Operation | `lookupSNMPGaugeMonitor(String name)` Returns a `javax.management.ObjectName` for the instance of `SNMPGaugeMonitorMBean` named `name`.
Privileges | Read/Write
Type | SNMPGaugeMonitorMBean[]
Relationship type: | Containment.
Redeploy or Restart required | Changes take effect after you redeploy the module or restart the server.

### SNMPLogFilters

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

Deprecated. 9.0.0.0

For more information, see:

- SNMPLogFilterMBean

Factory Methods | `createSNMPLogFilter (java.lang.String name)` `destroySNMPLogFilter (SNMPLogFilterMBean SNMPLogFilter)` Factory methods do not return objects. See Using factory methods.
Lookup Operation | `lookupSNMPLogFilter(String name)` Returns a `javax.management.ObjectName` for the instance of `SNMPLogFilterMBean` named `name`.
Privileges | Read/Write
Type | SNMPLogFilterMBean[]
Relationship type: | Containment.
Redeploy or Restart required | Changes take effect after you redeploy the module or restart the server.

### SNMPProxies

The SNMP Agents which are proxied by this Master SNMP Agent. `SNMPProxyMBeans` describe settings for SNMP agents to be proxied by this Master agent.

Deprecated. 9.0.0.0

For more information, see:

- SNMPProxyMBean

Factory Methods | `createSNMPProxy (java.lang.String name)` `destroySNMPProxy (SNMPProxyMBean SNMPProxy)` Factory methods do not return objects. See Using factory methods.
Lookup Operation | `lookupSNMPProxy(String name)` Returns a `javax.management.ObjectName` for the instance of `SNMPProxyMBean` named `name`.
Privileges | Read/Write
Type | SNMPProxyMBean[]
Relationship type: | Containment.
Redeploy or Restart required | Changes take effect after you redeploy the module or restart the server.

### SNMPStringMonitors

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

Deprecated. 9.0.0.0

For more information, see:

- SNMPStringMonitorMBean

Factory Methods | `createSNMPStringMonitor (java.lang.String name)` `destroySNMPStringMonitor (SNMPStringMonitorMBean SNMPStringMonitor)` Factory methods do not return objects. See Using factory methods.
Lookup Operation | `lookupSNMPStringMonitor(String name)` Returns a `javax.management.ObjectName` for the instance of `SNMPStringMonitorMBean` named `name`.
Privileges | Read/Write
Type | SNMPStringMonitorMBean[]
Relationship type: | Containment.
Redeploy or Restart required | Changes take effect after you redeploy the module or restart the server.

### SNMPTrapDestinations

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. Select which trap destination(s) should be used in this WebLogic Server domain from the list of available trap destinations.

Factory Methods | `createSNMPTrapDestination (java.lang.String name)` `destroySNMPTrapDestination (SNMPTrapDestinationMBean SNMPTrapDestination)` Factory methods do not return objects. See Using factory methods.
Lookup Operation | `lookupSNMPTrapDestination(String name)` Returns a `javax.management.ObjectName` for the instance of `SNMPTrapDestinationMBean` named `name`.
Privileges | Read only
Type | SNMPTrapDestinationMBean[]
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. Select which trap destination(s) should be used in this WebLogic Server domain from the list of available trap destinations.

Lookup Operation | `lookupSNMPTrapDestination(String name)` Returns a `javax.management.ObjectName` for the instance of `SNMPTrapDestinationMBean` named `name`.
Privileges | Read/Write
Type | SNMPTrapDestinationMBean[]
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:

CommunityPrefix DebugLevel Enabled MibDataRefreshInterval Name Notes Parent | SendAutomaticTrapsEnabled ServerStatusCheckIntervalFactor SNMPPort SNMPTrapVersion Type

### CommunityPrefix

The password (community name) that you want the WebLogic SNMP agent to use to secure communication with SNMP managers.

Note that 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 the WebLogic SNMP agent.

- The community name that the SNMP manager defines. The WebLogic 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, the WebLogic SNMP agent uses the prefix to qualify requests from SNMP managers. Because a WebLogic Server domain can have multiple server instances concurrently active, 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, 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 on the Administration Server, send a community name with the following form: `community_prefix`

- To request the value of an attribute for all server instances in a domain, send a community name with the following form: `community_prefix@domain_name`

To secure access to the values of the WebLogic attributes, it is recommended that you set community prefix to a value other than `public`.

Privileges | Read/Write
Type | java.lang.String
Default Value | public
Secure value | not public

### DebugLevel

The minimum severity of debug messages that the 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 trap.

Valid values are:

- `0`

  No debug messages.

- `1`

  Fatal messages only.

- `2`

  Critical and fatal messages.

- `3`

  Non-critical, critical, and, fatal messages.

Privileges | Read/Write
Type | int
Default Value | 0
Legal Values | 0 1 2 3
Secure value | 0

### Enabled

Specifies whether the Administration Server in the current WebLogic Server domain uses the SNMP service.

Privileges | Read/Write
Type | boolean

### MibDataRefreshInterval

The minimum number of seconds that the WebLogic 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.

Privileges | Read/Write
Type | int
Default Value | 120
Minimum value | 30
Maximum value | 65535

### 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
Type | java.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
Type | java.lang.String

### Parent

Return the immediate parent for this MBean

Privileges | Read/Write
Type |

### SendAutomaticTrapsEnabled

Specifies whether the WebLogic SNMP agent sends automatically generated traps to SNMP managers.

The WebLogic SNMP agent generates automatic traps when any of the following events occur:

- The Administration Server starts.

- An SNMP manager sends an incorrect community string.

- A Managed Server starts.

- A Managed Server shuts down.

Privileges | Read/Write
Type | boolean
Default Value | true

### ServerStatusCheckIntervalFactor

The multiplier used to calculate the interval at which the WebLogic SNMP agent checks for newly started or shut down Managed Servers.

The SNMP agent can automatically generate traps when Managed Servers start or shut down.

This status check value is multiplied by the MIB Data Refresh Interval to determine the interval:
`interval = n * MibDataRefreshInterval`

For the most frequent interval, specify `1` as the multiplier value.

Privileges | Read/Write
Type | int
Default Value | 1
Minimum value | 1
Maximum value | 65535

### SNMPPort

The port number on which you want the WebLogic SNMP agent to listen for incoming requests from SNMP managers.

SNMP managers can this port to ping the WebLogic Server SNMP agent and request the status of specific attributes.

Privileges | Read/Write
Type | int
Default Value | 161
Minimum value | 1
Maximum value | 65535

### SNMPTrapVersion

The SNMP trap version that this WebLogic Server domain generates.

Valid values are:

- `1`

  Generates SNMPv1 traps.

- `2`

  Generates SNMPv2 traps.

Choose the protocol that your SNMP managers support.

Privileges | Read/Write
Type | int
Default Value | 1
Legal Values | 1 2

### Type

Returns the type of the MBean.

Privileges | Read only
Type | java.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 addSNMPCounterMonitor addSNMPGaugeMonitor addSNMPLogFilter addSNMPProxy addSNMPStringMonitor addSNMPTrapDestination addTargetedTrapDestination freezeCurrentValue isSet | removeSNMPAttributeChange removeSNMPCounterMonitor removeSNMPGaugeMonitor removeSNMPLogFilter removeSNMPProxy removeSNMPStringMonitor removeTargetedTrapDestination restoreDefaultValue unSet

### addSNMPAttributeChange

Adds a feature to the SNMPAttributeChange attribute of the SNMPAgentMBean object

Deprecated. 9.0.0.0

Operation Name | `"addSNMPAttributeChange"`
Parameters | `Object [] { attrchange }` where: `attrchange` is an object of type `weblogic.management.configuration.SNMPAttributeChangeMBean` that specifies: The feature to be added to the SNMPAttributeChange attribute
Signature | `String [] { "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

Operation Name | `"addSNMPCounterMonitor"`
Parameters | `Object [] { countermonitor }` where: `countermonitor` is an object of type `weblogic.management.configuration.SNMPCounterMonitorMBean` that specifies: The feature to be added to the SNMPCounterMonitor attribute
Signature | `String [] { "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

Operation Name | `"addSNMPGaugeMonitor"`
Parameters | `Object [] { gaugemonitor }` where: `gaugemonitor` is an object of type `weblogic.management.configuration.SNMPGaugeMonitorMBean` that specifies: The feature to be added to the SNMPGaugeMonitor attribute
Signature | `String [] { "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

Operation Name | `"addSNMPLogFilter"`
Parameters | `Object [] { logfilter }` where: `logfilter` is an object of type `weblogic.management.configuration.SNMPLogFilterMBean` that specifies: The feature to be added to the SNMPLogFilter attribute
Signature | `String [] { "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

Operation Name | `"addSNMPProxy"`
Parameters | `Object [] { snmpProxy }` where: `snmpProxy` is an object of type `weblogic.management.configuration.SNMPProxyMBean` that specifies: The feature to be added to the SNMPProxy attribute
Signature | `String [] { "weblogic.management.configuration.SNMPProxyMBean" }`
Returns | `boolean`
Exceptions | `javax.management.InvalidAttributeValueException` `weblogic.management.configuration.ConfigurationException`

### addSNMPStringMonitor

Adds a feature to the SNMPStringMonitor attribute of the SNMPAgentMBean object

Deprecated. 9.0.0.0

Operation Name | `"addSNMPStringMonitor"`
Parameters | `Object [] { stringmonitor }` where: `stringmonitor` is an object of type `weblogic.management.configuration.SNMPStringMonitorMBean` that specifies: The feature to be added to the SNMPStringMonitor attribute
Signature | `String [] { "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

Operation Name | `"addSNMPTrapDestination"`
Parameters | `Object [] { trapdestination }` where: `trapdestination` is an object of type `weblogic.management.configuration.SNMPTrapDestinationMBean` that specifies: The feature to be added to the SNMPTrapDestination attribute
Signature | `String [] { "weblogic.management.configuration.SNMPTrapDestinationMBean" }`
Returns | `boolean`
Exceptions | `javax.management.InvalidAttributeValueException` `weblogic.management.configuration.ConfigurationException`

### addTargetedTrapDestination

Adds a feature to the TargetedTrapDestinations attribute of the SNMPAgentMBean object

Operation Name | `"addTargetedTrapDestination"`
Parameters | `Object [] { trapdestination }` where: `trapdestination` is an object of type `weblogic.management.configuration.SNMPTrapDestinationMBean` that specifies: The feature to be added to the TargetedTrapDestination attribute
Signature | `String [] { "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"`
Parameters | `Object [] { attributeName }` where: `attributeName` is an object of type `java.lang.String` that specifies: attributeName
Signature | `String [] { "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"`
Parameters | `Object [] { propertyName }` where: `propertyName` is an object of type `java.lang.String` that specifies: property to check
Signature | `String [] { "java.lang.String" }`
Returns | `boolean`

### removeSNMPAttributeChange

Deprecated. 9.0.0.0

Operation Name | `"removeSNMPAttributeChange"`
Parameters | `Object [] { attrchange }` where: `attrchange` is an object of type `weblogic.management.configuration.SNMPAttributeChangeMBean` that specifies: attrchange
Signature | `String [] { "weblogic.management.configuration.SNMPAttributeChangeMBean" }`
Returns | `boolean`
Exceptions | `javax.management.InvalidAttributeValueException` `weblogic.management.configuration.ConfigurationException`

### removeSNMPCounterMonitor

Deprecated. 9.0.0.0

Operation Name | `"removeSNMPCounterMonitor"`
Parameters | `Object [] { countermonitor }` where: `countermonitor` is an object of type `weblogic.management.configuration.SNMPCounterMonitorMBean` that specifies: countermonitor
Signature | `String [] { "weblogic.management.configuration.SNMPCounterMonitorMBean" }`
Returns | `boolean`
Exceptions | `javax.management.InvalidAttributeValueException` `weblogic.management.configuration.ConfigurationException`

### removeSNMPGaugeMonitor

Deprecated. 9.0.0.0

Operation Name | `"removeSNMPGaugeMonitor"`
Parameters | `Object [] { gaugemonitor }` where: `gaugemonitor` is an object of type `weblogic.management.configuration.SNMPGaugeMonitorMBean` that specifies: gaugemonitor
Signature | `String [] { "weblogic.management.configuration.SNMPGaugeMonitorMBean" }`
Returns | `boolean`
Exceptions | `javax.management.InvalidAttributeValueException` `weblogic.management.configuration.ConfigurationException`

### removeSNMPLogFilter

Deprecated. 9.0.0.0

Operation Name | `"removeSNMPLogFilter"`
Parameters | `Object [] { logfilter }` where: `logfilter` is an object of type `weblogic.management.configuration.SNMPLogFilterMBean` that specifies: logfilter
Signature | `String [] { "weblogic.management.configuration.SNMPLogFilterMBean" }`
Returns | `boolean`
Exceptions | `javax.management.InvalidAttributeValueException` `weblogic.management.configuration.ConfigurationException`

### removeSNMPProxy

Deprecated. 9.0.0.0

Operation Name | `"removeSNMPProxy"`
Parameters | `Object [] { snmpProxy }` where: `snmpProxy` is an object of type `weblogic.management.configuration.SNMPProxyMBean` that specifies: snmpProxy
Signature | `String [] { "weblogic.management.configuration.SNMPProxyMBean" }`
Returns | `boolean`
Exceptions | `javax.management.InvalidAttributeValueException` `weblogic.management.configuration.ConfigurationException`

### removeSNMPStringMonitor

Deprecated. 9.0.0.0

Operation Name | `"removeSNMPStringMonitor"`
Parameters | `Object [] { stringmonitor }` where: `stringmonitor` is an object of type `weblogic.management.configuration.SNMPStringMonitorMBean` that specifies: stringmonitor
Signature | `String [] { "weblogic.management.configuration.SNMPStringMonitorMBean" }`
Returns | `boolean`
Exceptions | `javax.management.InvalidAttributeValueException` `weblogic.management.configuration.ConfigurationException`

### removeTargetedTrapDestination

Operation Name | `"removeTargetedTrapDestination"`
Parameters | `Object [] { trapdestination }` where: `trapdestination` is an object of type `weblogic.management.configuration.SNMPTrapDestinationMBean` that specifies: trapdestination
Signature | `String [] { "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"`
Parameters | `Object [] { attributeName }` where: `attributeName` is an object of type `java.lang.String` that specifies: attributeName
Signature | `String [] { "java.lang.String" }`
Returns | `void`
Exceptions | `javax.management.AttributeNotFoundException`

### unSet

Restore the given property to its default value.

Operation Name | `"unSet"`
Parameters | `Object [] { propertyName }` where: `propertyName` is an object of type `java.lang.String` that specifies: property to restore
Signature | `String [] { "java.lang.String" }`
Returns | `void`