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.
If you use the getMBeanInfo operation in MBeanTypeServiceMBean, supply the following value as this MBean's fully qualified interface name:
weblogic.management.configuration.SNMPAgentMBean
No factory methods. Instances of this MBean are created automatically.
You can access this MBean from the following MBean attributes:
|
|
This section describes attributes that contain child MBeans. For more information about the MBean hierarchy, refer to WebLogic Server MBean Data Model.
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.
For more information, see:
| Factory Methods | createSNMPAttributeChange
(java.lang.String name)
Factory methods do not return objects. |
| Lookup Operation | lookupSNMPAttributeChange(String name)
Returns a |
| Privileges | Read/Write |
| Type | SNMPAttributeChangeMBean[] |
The SNMPCounterMonitorMBeans which describe the
criteria for generating trap based on JMX CounterMonitor.
Deprecated.
For more information, see:
| Factory Methods | createSNMPCounterMonitor
(java.lang.String name)
Factory methods do not return objects. |
| Lookup Operation | lookupSNMPCounterMonitor(String name)
Returns a |
| Privileges | Read/Write |
| Type | SNMPCounterMonitorMBean[] |
The SNMPGaugeMonitorMBeans which describe the
criteria for generating traps based on JMX GaugeMonitor.
Deprecated.
For more information, see:
| Factory Methods | createSNMPGaugeMonitor
(java.lang.String name)
Factory methods do not return objects. |
| Lookup Operation | lookupSNMPGaugeMonitor(String name)
Returns a |
| Privileges | Read/Write |
| Type | SNMPGaugeMonitorMBean[] |
The SNMPLogFilterMBeans which describe filters for
generating traps based on server log messages.
Deprecated.
For more information, see:
| Factory Methods | createSNMPLogFilter
(java.lang.String name)
Factory methods do not return objects. |
| Lookup Operation | lookupSNMPLogFilter(String name)
Returns a |
| Privileges | Read/Write |
| Type | SNMPLogFilterMBean[] |
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.
For more information, see:
| Factory Methods | createSNMPProxy
(java.lang.String name)
Factory methods do not return objects. |
| Lookup Operation | lookupSNMPProxy(String name)
Returns a |
| Privileges | Read/Write |
| Type | SNMPProxyMBean[] |
The SNMPStringMonitorMBeans which describe the
criteria for generating traps based on JMX StringMonitor.
Deprecated.
For more information, see:
| Factory Methods | createSNMPStringMonitor
(java.lang.String name)
Factory methods do not return objects. |
| Lookup Operation | lookupSNMPStringMonitor(String name)
Returns a |
| Privileges | Read/Write |
| Type | SNMPStringMonitorMBean[] |
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)
Factory methods do not return objects. |
| Lookup Operation | lookupSNMPTrapDestination(String name)
Returns a |
| Privileges | Read only |
| Type | SNMPTrapDestinationMBean[] |
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 | No explicit creator method. The child shares the lifecycle of its parent. |
| Lookup Operation | lookupSNMPTrapDestination(String name)
Returns a |
| Privileges | Read/Write |
| Type | SNMPTrapDestinationMBean[] |
This section describes the following attributes:
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 |
| Redeploy or Restart required | Changes take effect after you redeploy the module or restart the server. |
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 |
|
| Secure value | 0 |
| Redeploy or Restart required | Changes take effect after you redeploy the module or restart the server. |
Specifies whether the Administration Server in the current WebLogic Server domain uses the SNMP service.
| Privileges | Read/Write |
| Type | boolean |
| Redeploy or Restart required | Changes take effect after you redeploy the module or restart the server. |
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 |
| Redeploy or Restart required | Changes take effect after you redeploy the module or restart the server. |
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 |
| Redeploy or Restart required | Changes take effect after you redeploy the module or restart the server. |
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
<. Carriage returns/line feeds are
preserved.
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 |
Return the immediate parent for this MBean
| Privileges | Read/Write |
| Type | |
| Redeploy or Restart required | Changes take effect after you redeploy the module or restart the server. |
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 |
| Redeploy or Restart required | Changes take effect after you redeploy the module or restart the server. |
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 |
| Redeploy or Restart required | Changes take effect after you redeploy the module or restart the server. |
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 |
| Redeploy or Restart required | Changes take effect after you redeploy the module or restart the server. |
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 |
|
| Redeploy or Restart required | Changes take effect after you redeploy the module or restart the server. |
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. |
This section describes the following operations:
Adds a feature to the SNMPAttributeChange attribute of the SNMPAgentMBean object
Deprecated.
| Operation Name | "addSNMPAttributeChange" |
| Parameters | Object [] {
attrchange }
where:
|
| Signature | String [] {
"weblogic.management.configuration.SNMPAttributeChangeMBean" } |
| Returns |
boolean
|
javax.management.InvalidAttributeValueException
weblogic.management.configuration.ConfigurationException
Adds a feature to the SNMPCounterMonitor attribute of the SNMPAgentMBean object
Deprecated.
| Operation Name | "addSNMPCounterMonitor" |
| Parameters | Object [] {
countermonitor }
where:
|
| Signature | String [] {
"weblogic.management.configuration.SNMPCounterMonitorMBean" } |
| Returns |
boolean
|
javax.management.InvalidAttributeValueException
weblogic.management.configuration.ConfigurationException
Adds a feature to the SNMPGaugeMonitor attribute of the SNMPAgentMBean object
Deprecated.
| Operation Name | "addSNMPGaugeMonitor" |
| Parameters | Object [] {
gaugemonitor }
where:
|
| Signature | String [] {
"weblogic.management.configuration.SNMPGaugeMonitorMBean" } |
| Returns |
boolean
|
javax.management.InvalidAttributeValueException
weblogic.management.configuration.ConfigurationException
Adds a feature to the SNMPLogFilter attribute of the SNMPAgentMBean object
Deprecated.
| Operation Name | "addSNMPLogFilter" |
| Parameters | Object [] {
logfilter }
where:
|
| Signature | String [] {
"weblogic.management.configuration.SNMPLogFilterMBean" } |
| Returns |
boolean
|
javax.management.InvalidAttributeValueException
weblogic.management.configuration.ConfigurationException
Adds a feature to the SNMPProxy attribute of the SNMPAgentMBean object
Deprecated.
| Operation Name | "addSNMPProxy" |
| Parameters | Object [] {
snmpProxy }
where:
|
| Signature | String [] {
"weblogic.management.configuration.SNMPProxyMBean" } |
| Returns |
boolean
|
javax.management.InvalidAttributeValueException
weblogic.management.configuration.ConfigurationException
Adds a feature to the SNMPStringMonitor attribute of the SNMPAgentMBean object
Deprecated.
| Operation Name | "addSNMPStringMonitor" |
| Parameters | Object [] {
stringmonitor }
where:
|
| Signature | String [] {
"weblogic.management.configuration.SNMPStringMonitorMBean" } |
| Returns |
boolean
|
javax.management.InvalidAttributeValueException
weblogic.management.configuration.ConfigurationException
Adds an SNMPTrapDestination to the SNMPAgentMBean object
Deprecated.
| Operation Name | "addSNMPTrapDestination" |
| Parameters | Object [] {
trapdestination }
where:
|
| Signature | String [] {
"weblogic.management.configuration.SNMPTrapDestinationMBean" } |
| Returns |
boolean
|
javax.management.InvalidAttributeValueException
weblogic.management.configuration.ConfigurationException
Adds a feature to the TargetedTrapDestinations attribute of the SNMPAgentMBean object
| Operation Name | "addTargetedTrapDestination" |
| Parameters | Object [] {
trapdestination }
where:
|
| Signature | String [] {
"weblogic.management.configuration.SNMPTrapDestinationMBean" } |
| Returns |
boolean
|
javax.management.InvalidAttributeValueException
weblogic.management.configuration.ConfigurationException
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.
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.
| Operation Name | "freezeCurrentValue" |
| Parameters | Object [] {
attributeName }
where:
|
| Signature | String [] {
"java.lang.String" } |
| Returns |
void
|
javax.management.AttributeNotFoundException
javax.management.MBeanException
Returns true if the specified attribute has been set explicitly in this MBean instance.
| Operation Name | "isSet" |
| Parameters | Object [] {
propertyName }
where:
|
| Signature | String [] {
"java.lang.String" } |
| Returns |
boolean
|
Deprecated.
| Operation Name | "removeSNMPAttributeChange" |
| Parameters | Object [] {
attrchange }
where:
|
| Signature | String [] {
"weblogic.management.configuration.SNMPAttributeChangeMBean" } |
| Returns |
boolean
|
javax.management.InvalidAttributeValueException
weblogic.management.configuration.ConfigurationException
Deprecated.
| Operation Name | "removeSNMPCounterMonitor" |
| Parameters | Object [] {
countermonitor }
where:
|
| Signature | String [] {
"weblogic.management.configuration.SNMPCounterMonitorMBean" } |
| Returns |
boolean
|
javax.management.InvalidAttributeValueException
weblogic.management.configuration.ConfigurationException
Deprecated.
| Operation Name | "removeSNMPGaugeMonitor" |
| Parameters | Object [] {
gaugemonitor }
where:
|
| Signature | String [] {
"weblogic.management.configuration.SNMPGaugeMonitorMBean" } |
| Returns |
boolean
|
javax.management.InvalidAttributeValueException
weblogic.management.configuration.ConfigurationException
Deprecated.
| Operation Name | "removeSNMPLogFilter" |
| Parameters | Object [] {
logfilter }
where:
|
| Signature | String [] {
"weblogic.management.configuration.SNMPLogFilterMBean" } |
| Returns |
boolean
|
javax.management.InvalidAttributeValueException
weblogic.management.configuration.ConfigurationException
Deprecated.
| Operation Name | "removeSNMPProxy" |
| Parameters | Object [] {
snmpProxy }
where:
|
| Signature | String [] {
"weblogic.management.configuration.SNMPProxyMBean" } |
| Returns |
boolean
|
javax.management.InvalidAttributeValueException
weblogic.management.configuration.ConfigurationException
Deprecated.
| Operation Name | "removeSNMPStringMonitor" |
| Parameters | Object [] {
stringmonitor }
where:
|
| Signature | String [] {
"weblogic.management.configuration.SNMPStringMonitorMBean" } |
| Returns |
boolean
|
javax.management.InvalidAttributeValueException
weblogic.management.configuration.ConfigurationException
| Operation Name | "removeTargetedTrapDestination" |
| Parameters | Object [] {
trapdestination }
where:
|
| Signature | String [] {
"weblogic.management.configuration.SNMPTrapDestinationMBean" } |
| Returns |
boolean
|
javax.management.InvalidAttributeValueException
weblogic.management.configuration.ConfigurationException
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.
| Operation Name | "restoreDefaultValue" |
| Parameters | Object [] {
attributeName }
where:
|
| Signature | String [] {
"java.lang.String" } |
| Returns |
void
|
javax.management.AttributeNotFoundException
Restore the given property to its default value.
| Operation Name | "unSet" |
| Parameters | Object [] {
propertyName }
where:
|
| Signature | String [] {
"java.lang.String" } |
| Returns |
void
|