|
Oracle Fusion Middleware Java API Reference for Oracle WebLogic Server 12c (12.2.1) Part Number E55141-01 P4 Change 1723563 on 2015/10/09 |
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
public interface SNMPAgentMBean
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.
Field Summary | |
---|---|
static String |
AES_128 AES privacy protocol |
static int |
DEBUG_CRITICAL |
static int |
DEBUG_FATAL |
static int |
DEBUG_NONCRITICAL |
static int |
DEBUG_NONE |
static String |
DES DES privacy protocol |
static String |
MD5 MD5 authentication protocol |
static String |
NO_AUTH Constant for no authentication |
static String |
NO_PRIV Constant for no privacy |
static String |
SHA SHA authentication protocol |
static int |
SNMPV1 SNMP Version 1 |
static int |
SNMPV2 SNMP Version 2 |
static int |
SNMPV3 SNMP Version 3 |
Fields inherited from interface weblogic.management.configuration.ConfigurationMBean |
---|
DEFAULT_EMPTY_BYTE_ARRAY |
Method Summary | |
---|---|
abstract boolean |
addSNMPAttributeChange(SNMPAttributeChangeMBean attrchange) Deprecated. 9.0.0.0 Instead, use standard JMX design patterns using javax.management.MBeanServerConnection interface. |
abstract boolean |
addSNMPCounterMonitor(SNMPCounterMonitorMBean countermonitor) Deprecated. 9.0.0.0 Instead, use standard JMX design patterns using javax.management.MBeanServerConnection interface. |
abstract boolean |
addSNMPGaugeMonitor(SNMPGaugeMonitorMBean gaugemonitor) Deprecated. 9.0.0.0 Instead, use standard JMX design patterns using javax.management.MBeanServerConnection interface. |
abstract boolean |
addSNMPLogFilter(SNMPLogFilterMBean logfilter) Deprecated. 9.0.0.0 Instead, use standard JMX design patterns using javax.management.MBeanServerConnection interface. |
abstract boolean |
addSNMPProxy(SNMPProxyMBean snmpProxy) Deprecated. 9.0.0.0 Instead, use standard JMX design patterns using javax.management.MBeanServerConnection interface. |
abstract boolean |
addSNMPStringMonitor(SNMPStringMonitorMBean stringmonitor) Deprecated. 9.0.0.0 Instead, use standard JMX design patterns using javax.management.MBeanServerConnection interface. |
abstract boolean |
addSNMPTrapDestination(SNMPTrapDestinationMBean trapdestination) Deprecated. 9.0.0.0 Instead, use standard JMX design patterns using javax.management.MBeanServerConnection interface. |
abstract boolean |
addTargetedTrapDestination(SNMPTrapDestinationMBean trapdestination) Deprecated. 9.0.0.0 |
abstract SNMPAttributeChangeMBean |
createSNMPAttributeChange(String name) Factory method to create SNMPAttributeChange objects |
abstract SNMPCounterMonitorMBean |
createSNMPCounterMonitor(String name) Factory method to create SNMPCounterMonitor objects |
abstract SNMPGaugeMonitorMBean |
createSNMPGaugeMonitor(String name) Factory method to create SNMPGaugeMonitor objects |
abstract SNMPLogFilterMBean |
createSNMPLogFilter(String name) Factory method to create SNMPLogFilter objects |
abstract SNMPProxyMBean |
createSNMPProxy(String name) Factory method to create SNMPProxy objects |
abstract SNMPStringMonitorMBean |
createSNMPStringMonitor(String name) Factory method to create SNMPStringMonitor objects |
abstract SNMPTrapDestinationMBean |
createSNMPTrapDestination(String name) Factory method to create SNMPTrapDestination objects |
abstract void |
destroySNMPAttributeChange(SNMPAttributeChangeMBean attrchange) Removes a SNMPAttributeChange from this domain |
abstract void |
destroySNMPCounterMonitor(SNMPCounterMonitorMBean countermonitor) Removes a SNMPCounterMonitor from this domain |
abstract void |
destroySNMPGaugeMonitor(SNMPGaugeMonitorMBean gaugemonitor) Removes a SNMPGaugeMonitor from this domain |
abstract void |
destroySNMPLogFilter(SNMPLogFilterMBean logfilter) Removes a SNMPLogFilter from this domain |
abstract void |
destroySNMPProxy(SNMPProxyMBean snmpProxy) Removes a SNMPProxy from this domain |
abstract void |
destroySNMPStringMonitor(SNMPStringMonitorMBean stringmonitor) Removes a SNMPStringMonitor from this domain |
abstract void |
destroySNMPTrapDestination(SNMPTrapDestinationMBean trapdestination) Removes a SNMPTrapDestination from this SNMPAgent |
abstract String |
getAuthenticationProtocol() The protocol that this SNMP agent uses to ensure that only authorized users can request or receive information about your WebLogic Server domain. |
abstract String |
getCommunityPrefix() The password (community name) that you want this SNMP agent to use to secure SNMPv1 or v2 communication with SNMP managers. |
abstract int |
getDebugLevel() Deprecated. 10.0.0.0 Use the ServerDebugMBean.DebugSNMPToolkit attribute to configure the SNMP Toolkit debug |
abstract int |
getInformRetryInterval() The number of milliseconds that this SNMP agent will wait for a response to an INFORM notification. |
abstract long |
getLocalizedKeyCacheInvalidationInterval() The number of milliseconds after which WebLogic Server invalidates its cache of SNMP security keys. |
abstract int |
getMasterAgentXPort() The port that this SNMP agent uses to communicate with its subagents. |
abstract int |
getMaxInformRetryCount() The maximum number of times that this SNMP agent will resend INFORM notifications for which it has not received a response. |
abstract int |
getMibDataRefreshInterval() Deprecated. 10.0.0.0 There is no replacement for this attribute. |
abstract String |
getPrivacyProtocol() The protocol that this SNMP agent uses to encrypt and unencrypt messages. |
abstract int |
getServerStatusCheckIntervalFactor() Deprecated. 10.0.0.0 There is no replacement for this attribute. |
abstract SNMPAttributeChangeMBean[] |
getSNMPAttributeChanges() The SNMPAttributeChangeMBeans which describe the MBean type and Attribute name for which attribute change notification should be sent when an attribute change is observed. |
abstract SNMPCounterMonitorMBean[] |
getSNMPCounterMonitors() The SNMPCounterMonitorMBeans which describe the criteria for generating notifications based on JMX CounterMonitor. |
abstract String |
getSNMPEngineId() An identifier for this SNMP agent that is unique amongst all other SNMP agents in the current WebLogic Server domain. |
abstract SNMPGaugeMonitorMBean[] |
getSNMPGaugeMonitors() The SNMPGaugeMonitorMBeans which describe the criteria for generating notifications based on JMX GaugeMonitor. |
abstract SNMPLogFilterMBean[] |
getSNMPLogFilters() The SNMPLogFilterMBeans which describe filters for generating notifications based on server log messages. |
abstract int |
getSNMPPort() The port on which you want this SNMP agent to listen for incoming requests from SNMP managers that use the UDP protocol. |
abstract SNMPProxyMBean[] |
getSNMPProxies() The SNMP agents for which this SNMP agent is a proxy. |
abstract SNMPStringMonitorMBean[] |
getSNMPStringMonitors() The SNMPStringMonitorMBeans which describe the criteria for generating notifications based on JMX StringMonitor. |
abstract SNMPTrapDestinationMBean[] |
getSNMPTrapDestinations() WebLogic Server uses a trap destination to specify the SNMP management station and the community name used by the SNMP agent to send notifications. |
abstract int |
getSNMPTrapVersion() The SNMP notification version that this SNMP agent generates. |
abstract SNMPTrapDestinationMBean[] |
getTargetedTrapDestinations() Deprecated. 9.0.0.0 Use the getSNMPTrapDestinations() method instead. |
abstract boolean |
isCommunityBasedAccessEnabled() Specifies whether this SNMP agent supports SNMPv1 and v2. |
abstract boolean |
isEnabled() Specifies whether this SNMP agent is enabled. |
abstract boolean |
isInformEnabled() Configures this SNMP agent to send notifications as an INFORM instead of a TRAP. |
abstract boolean |
isSendAutomaticTrapsEnabled() Specifies whether this SNMP agent sends automatically generated notifications to SNMP managers. |
abstract boolean |
isSNMPAccessForUserMBeansEnabled() Configures this SNMP agent to provide read-only access to MBean types that you have created and registered (custom MBeans). |
abstract SNMPAttributeChangeMBean |
lookupSNMPAttributeChange(String name) |
abstract SNMPCounterMonitorMBean |
lookupSNMPCounterMonitor(String name) |
abstract SNMPGaugeMonitorMBean |
lookupSNMPGaugeMonitor(String name) |
abstract SNMPLogFilterMBean |
lookupSNMPLogFilter(String name) |
abstract SNMPProxyMBean |
lookupSNMPProxy(String name) |
abstract SNMPStringMonitorMBean |
lookupSNMPStringMonitor(String name) |
abstract SNMPTrapDestinationMBean |
lookupSNMPTrapDestination(String name) |
abstract boolean |
removeSNMPAttributeChange(SNMPAttributeChangeMBean attrchange) Deprecated. 9.0.0.0 Instead, use standard JMX design patterns using javax.management.MBeanServerConnection interface. |
abstract boolean |
removeSNMPCounterMonitor(SNMPCounterMonitorMBean countermonitor) Deprecated. 9.0.0.0 Instead, use standard JMX design patterns using javax.management.MBeanServerConnection interface. |
abstract boolean |
removeSNMPGaugeMonitor(SNMPGaugeMonitorMBean gaugemonitor) Deprecated. 9.0.0.0 Instead, use standard JMX design patterns using javax.management.MBeanServerConnection interface. |
abstract boolean |
removeSNMPLogFilter(SNMPLogFilterMBean logfilter) Deprecated. 9.0.0.0 Instead, use standard JMX design patterns using javax.management.MBeanServerConnection interface. |
abstract boolean |
removeSNMPProxy(SNMPProxyMBean snmpProxy) Deprecated. 9.0.0.0 Instead, use standard JMX design patterns using javax.management.MBeanServerConnection interface. |
abstract boolean |
removeSNMPStringMonitor(SNMPStringMonitorMBean stringmonitor) Deprecated. 9.0.0.0 Instead, use standard JMX design patterns using javax.management.MBeanServerConnection interface. |
abstract boolean |
removeTargetedTrapDestination(SNMPTrapDestinationMBean trapdestination) Deprecated. 9.0.0.0 |
abstract void |
setAuthenticationProtocol(String protocol) |
abstract void |
setCommunityBasedAccessEnabled(boolean enabled) |
abstract void |
setCommunityPrefix(String prefix) Sets the value of the CommunityPrefix attribute. |
abstract void |
setDebugLevel(int debugLevel) Deprecated. 10.0.0.0 Use the ServerDebugMBean.DebugSNMPToolkit attribute to configure the SNMP Toolkit debug |
abstract void |
setEnabled(boolean flag) Sets the value of the Enabled attribute. |
abstract void |
setInformEnabled(boolean value) |
abstract void |
setInformRetryInterval(int interval) |
abstract void |
setLocalizedKeyCacheInvalidationInterval(long value) |
abstract void |
setMasterAgentXPort(int value) |
abstract void |
setMaxInformRetryCount(int retryCount) |
abstract void |
setMibDataRefreshInterval(int interval) Sets the value of the MibDataRefreshInterval attribute. |
abstract void |
setPrivacyProtocol(String protocol) |
abstract void |
setSendAutomaticTrapsEnabled(boolean flag) Sets the value of the SendAutomaticTrapsEnabled attribute. |
abstract void |
setServerStatusCheckIntervalFactor(int factor) Sets the value of the ServerStatusCheckIntervalFactor attribute. |
abstract void |
setSNMPAccessForUserMBeansEnabled(boolean v) |
abstract void |
setSNMPAttributeChanges(SNMPAttributeChangeMBean[] snmpAttributeChanges) Deprecated. 9.0.0.0 Instead, use standard JMX design patterns using javax.management.MBeanServerConnection interface. |
abstract void |
setSNMPCounterMonitors(SNMPCounterMonitorMBean[] snmpCounterMonitors) Deprecated. 9.0.0.0 Instead, use standard JMX design patterns using javax.management.MBeanServerConnection interface. |
abstract void |
setSNMPEngineId(String engineId) |
abstract void |
setSNMPGaugeMonitors(SNMPGaugeMonitorMBean[] snmpGaugeMonitors) Deprecated. 9.0.0.0 Instead, use standard JMX design patterns using javax.management.MBeanServerConnection interface. |
abstract void |
setSNMPLogFilters(SNMPLogFilterMBean[] snmpLogFilters) Deprecated. 9.0.0.0 Instead, use standard JMX design patterns using javax.management.MBeanServerConnection interface. |
abstract void |
setSNMPPort(int port) Sets the value of the SNMPPort attribute. |
abstract void |
setSNMPProxies(SNMPProxyMBean[] snmpProxys) Deprecated. 9.0.0.0 Instead, use standard JMX design patterns using javax.management.MBeanServerConnection interface. |
abstract void |
setSNMPStringMonitors(SNMPStringMonitorMBean[] snmpStringMonitors) Deprecated. 9.0.0.0 Instead, use standard JMX design patterns using javax.management.MBeanServerConnection interface. |
abstract void |
setSNMPTrapVersion(int version) Sets the value of the SNMPTrapVersion attribute. |
abstract void |
setTargetedTrapDestinations(SNMPTrapDestinationMBean[] snmpTrapDestinations) Deprecated. 9.0.0.0 Instead, use standard JMX design patterns using javax.management.MBeanServerConnection interface. |
Methods inherited from interface weblogic.management.configuration.ConfigurationMBean |
---|
freezeCurrentValue, getId, getInheritedProperties, getName, getNotes, isDynamicallyCreated, isInherited, isSet, restoreDefaultValue, setComments, setDefaultedMBean, setName, setNotes, setPersistenceEnabled, unSet |
Methods inherited from interface weblogic.management.WebLogicMBean |
---|
getMBeanInfo, getObjectName, getParent, getType, isCachingDisabled, isRegistered, setParent |
Methods inherited from interface javax.management.DynamicMBean |
---|
getAttribute, getAttributes, invoke, setAttribute, setAttributes |
Methods inherited from interface javax.management.MBeanRegistration |
---|
postDeregister, postRegister, preDeregister, preRegister |
Methods inherited from interface javax.management.NotificationBroadcaster |
---|
addNotificationListener, getNotificationInfo, removeNotificationListener |
Methods inherited from interface weblogic.descriptor.DescriptorBean |
---|
addPropertyChangeListener, createChildCopyIncludingObsolete, getParentBean, isEditable, removePropertyChangeListener |
Field Detail |
---|
static final int DEBUG_NONE
static final int DEBUG_FATAL
static final int DEBUG_CRITICAL
static final int DEBUG_NONCRITICAL
static final int SNMPV1
static final int SNMPV2
static final int SNMPV3
static final String NO_AUTH
static final String MD5
static final String SHA
static final String NO_PRIV
static final String DES
static final String AES_128
Method Detail |
---|
boolean isEnabled()
Specifies whether this SNMP agent is enabled.
void setEnabled(boolean flag)
Sets the value of the Enabled attribute.
flag
- The new enabled valueSNMPAgentMBean.isEnabled()
boolean isSendAutomaticTrapsEnabled()
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:
The WebLogic Server instance that is hosting the SNMP agent starts.
This type of notification (coldStart) has no variable bindings.
A server instance starts or stops.
An SNMP agent on a Managed Server generates these notifications only when its host Managed Server starts or stops. An SNMP agent on an Administration Server generates these notifications when any server in the domain starts or stops.
These notification types (serverStart and serverShutdown) contain variable bindings to identify the server that started or stopped and the time at which the notification was generated.
SNMPAgentMBean.getServerStatusCheckIntervalFactor()
void setSendAutomaticTrapsEnabled(boolean flag)
Sets the value of the SendAutomaticTrapsEnabled attribute.
flag
- The new sendAutomaticTrapsEnabled valueSNMPAgentMBean.isSendAutomaticTrapsEnabled()
int getSNMPPort()
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.
SNMPAgentRuntimeMBean
, ServerTemplateMBean.getListenPort()
, NetworkAccessPointMBean
void setSNMPPort(int port) throws InvalidAttributeValueException, ConfigurationException
Sets the value of the SNMPPort attribute.
port
- The new SNMPPort valueInvalidAttributeValueException
ConfigurationException
SNMPAgentMBean.getSNMPPort()
int getSNMPTrapVersion()
The SNMP notification version that this SNMP agent generates.
SNMPAgentMBean.isCommunityBasedAccessEnabled()
void setSNMPTrapVersion(int version)
Sets the value of the SNMPTrapVersion attribute.
SNMPAgentMBean.getSNMPTrapVersion()
int getMibDataRefreshInterval()
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.
void setMibDataRefreshInterval(int interval) throws InvalidAttributeValueException, ConfigurationException
Sets the value of the MibDataRefreshInterval attribute.
interval
- The new mibDataRefreshInterval valueInvalidAttributeValueException
ConfigurationException
SNMPAgentMBean.getMibDataRefreshInterval()
int getServerStatusCheckIntervalFactor()
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.
void setServerStatusCheckIntervalFactor(int factor) throws InvalidAttributeValueException, ConfigurationException
Sets the value of the ServerStatusCheckIntervalFactor attribute.
factor
- The new serverStatusCheckIntervalFactor valueInvalidAttributeValueException
ConfigurationException
SNMPAgentMBean.getServerStatusCheckIntervalFactor()
String getCommunityPrefix()
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:
The name that you specify in this community prefix. All SNMP managers must send this name when connecting to this SNMP agent.
The community name that the SNMP manager defines. The 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, 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 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 for all server instances in a domain, send a community name with the following form: community_prefix
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
.
You cannot specify a null (empty) value for the community prefix. If you delete the prefix value, WebLogic Server resets the value to public
. If you do not want this agent to receive SNMPv1 or v2 requests, instead of trying to set the community prefix to a null value, disable community based access. With community based access disabled, WebLogic Server ignores the community prefix value.
void setCommunityPrefix(String prefix) throws InvalidAttributeValueException, ConfigurationException
Sets the value of the CommunityPrefix attribute.
prefix
- The new communityPrefix valueInvalidAttributeValueException
ConfigurationException
SNMPAgentMBean.getCommunityPrefix()
int getDebugLevel()
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:
0
No debug messages.
1
Fatal messages only.
2
Critical and fatal messages.
3
Non-critical, critical, and, fatal messages.
void setDebugLevel(int debugLevel) throws InvalidAttributeValueException, ConfigurationException
Sets the value of the DebugLevel attribute.
debugLevel
- The new debugLevel valueInvalidAttributeValueException
ConfigurationException
SNMPAgentMBean.getDebugLevel()
SNMPTrapDestinationMBean[] getTargetedTrapDestinations()
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.
void setTargetedTrapDestinations(SNMPTrapDestinationMBean[] snmpTrapDestinations) throws InvalidAttributeValueException, ConfigurationException
javax.management.MBeanServerConnection
interface.Sets the value of the TargetedTrapDestinations attribute.
snmpTrapDestinations
- The new targetedTrapDestinations valueInvalidAttributeValueException
ConfigurationException
SNMPAgentMBean.getTargetedTrapDestinations()
boolean addTargetedTrapDestination(SNMPTrapDestinationMBean trapdestination) throws InvalidAttributeValueException, ConfigurationException
Adds a single trap destination to this SNMP agent's list of targeted trap destinations.
trapdestination
- The feature to be added to the TargetedTrapDestination attributeInvalidAttributeValueException
ConfigurationException
SNMPAgentMBean.getTargetedTrapDestinations()
boolean removeTargetedTrapDestination(SNMPTrapDestinationMBean trapdestination) throws InvalidAttributeValueException, ConfigurationException
trapdestination
-InvalidAttributeValueException
ConfigurationException
SNMPTrapDestinationMBean createSNMPTrapDestination(String name)
Factory method to create SNMPTrapDestination objects
name
-void destroySNMPTrapDestination(SNMPTrapDestinationMBean trapdestination)
Removes a SNMPTrapDestination from this SNMPAgent
trapdestination
-SNMPTrapDestinationMBean lookupSNMPTrapDestination(String name)
name
-SNMPTrapDestinationMBean[] getSNMPTrapDestinations()
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.
boolean addSNMPTrapDestination(SNMPTrapDestinationMBean trapdestination) throws InvalidAttributeValueException, ConfigurationException
javax.management.MBeanServerConnection
interface.Adds an SNMPTrapDestination to the SNMPAgentMBean object
trapdestination
- The feature to be added to the SNMPTrapDestination attributeInvalidAttributeValueException
ConfigurationException
SNMPProxyMBean[] getSNMPProxies()
The SNMP agents for which this SNMP agent is a proxy. SNMPProxyMBeans
describe settings for SNMP agents to be proxied by this SNMP agent.
SNMPProxyMBean
void setSNMPProxies(SNMPProxyMBean[] snmpProxys) throws InvalidAttributeValueException, ConfigurationException
javax.management.MBeanServerConnection
interface.Sets the value of the SNMPProxies attribute.
snmpProxys
- The new SNMPProxies valueInvalidAttributeValueException
ConfigurationException
SNMPAgentMBean.getSNMPProxies()
boolean addSNMPProxy(SNMPProxyMBean snmpProxy) throws InvalidAttributeValueException, ConfigurationException
javax.management.MBeanServerConnection
interface.Adds a feature to the SNMPProxy attribute of the SNMPAgentMBean object
snmpProxy
- The feature to be added to the SNMPProxy attributeInvalidAttributeValueException
ConfigurationException
boolean removeSNMPProxy(SNMPProxyMBean snmpProxy) throws InvalidAttributeValueException, ConfigurationException
javax.management.MBeanServerConnection
interface.snmpProxy
-InvalidAttributeValueException
ConfigurationException
SNMPProxyMBean createSNMPProxy(String name)
Factory method to create SNMPProxy objects
name
-void destroySNMPProxy(SNMPProxyMBean snmpProxy)
Removes a SNMPProxy from this domain
snmpProxy
-SNMPProxyMBean lookupSNMPProxy(String name)
name
-SNMPGaugeMonitorMBean[] getSNMPGaugeMonitors()
The SNMPGaugeMonitorMBeans
which describe the criteria for generating notifications based on JMX GaugeMonitor.
SNMPGaugeMonitorMBean
void setSNMPGaugeMonitors(SNMPGaugeMonitorMBean[] snmpGaugeMonitors) throws InvalidAttributeValueException, ConfigurationException
javax.management.MBeanServerConnection
interface.Sets the value of the SNMPGaugeMonitors attribute.
snmpGaugeMonitors
- The new SNMPGaugeMonitors valueInvalidAttributeValueException
ConfigurationException
SNMPAgentMBean.getSNMPGaugeMonitors()
boolean addSNMPGaugeMonitor(SNMPGaugeMonitorMBean gaugemonitor) throws InvalidAttributeValueException, ConfigurationException
javax.management.MBeanServerConnection
interface.Adds a feature to the SNMPGaugeMonitor attribute of the SNMPAgentMBean object
gaugemonitor
- The feature to be added to the SNMPGaugeMonitor attributeInvalidAttributeValueException
ConfigurationException
boolean removeSNMPGaugeMonitor(SNMPGaugeMonitorMBean gaugemonitor) throws InvalidAttributeValueException, ConfigurationException
javax.management.MBeanServerConnection
interface.gaugemonitor
-InvalidAttributeValueException
ConfigurationException
SNMPGaugeMonitorMBean createSNMPGaugeMonitor(String name)
Factory method to create SNMPGaugeMonitor objects
name
-void destroySNMPGaugeMonitor(SNMPGaugeMonitorMBean gaugemonitor)
Removes a SNMPGaugeMonitor from this domain
gaugemonitor
-SNMPGaugeMonitorMBean lookupSNMPGaugeMonitor(String name)
name
-SNMPStringMonitorMBean[] getSNMPStringMonitors()
The SNMPStringMonitorMBeans
which describe the criteria for generating notifications based on JMX StringMonitor.
SNMPStringMonitorMBean
void setSNMPStringMonitors(SNMPStringMonitorMBean[] snmpStringMonitors) throws InvalidAttributeValueException, ConfigurationException
javax.management.MBeanServerConnection
interface.Sets the value of the SNMPStringMonitors attribute.
snmpStringMonitors
- The new SNMPStringMonitors valueInvalidAttributeValueException
ConfigurationException
SNMPAgentMBean.getSNMPStringMonitors()
boolean addSNMPStringMonitor(SNMPStringMonitorMBean stringmonitor) throws InvalidAttributeValueException, ConfigurationException
javax.management.MBeanServerConnection
interface.Adds a single SNMPStringMonitorMBeans
to this SNMP agent's collection.
stringmonitor
- The feature to be added to the SNMPStringMonitor attributeInvalidAttributeValueException
ConfigurationException
SNMPAgentMBean.getSNMPStringMonitors()
boolean removeSNMPStringMonitor(SNMPStringMonitorMBean stringmonitor) throws InvalidAttributeValueException, ConfigurationException
javax.management.MBeanServerConnection
interface.stringmonitor
-InvalidAttributeValueException
ConfigurationException
SNMPStringMonitorMBean createSNMPStringMonitor(String name)
Factory method to create SNMPStringMonitor objects
name
-void destroySNMPStringMonitor(SNMPStringMonitorMBean stringmonitor)
Removes a SNMPStringMonitor from this domain
stringmonitor
-SNMPStringMonitorMBean lookupSNMPStringMonitor(String name)
name
-SNMPCounterMonitorMBean[] getSNMPCounterMonitors()
The SNMPCounterMonitorMBeans
which describe the criteria for generating notifications based on JMX CounterMonitor.
SNMPCounterMonitorMBean
void setSNMPCounterMonitors(SNMPCounterMonitorMBean[] snmpCounterMonitors) throws InvalidAttributeValueException, ConfigurationException
javax.management.MBeanServerConnection
interface.Sets the value of the SNMPCounterMonitors attribute.
snmpCounterMonitors
- The new SNMPCounterMonitors valueInvalidAttributeValueException
ConfigurationException
SNMPAgentMBean.getSNMPCounterMonitors()
boolean addSNMPCounterMonitor(SNMPCounterMonitorMBean countermonitor) throws InvalidAttributeValueException, ConfigurationException
javax.management.MBeanServerConnection
interface.Adds a feature to the SNMPCounterMonitor attribute of the SNMPAgentMBean object
countermonitor
- The feature to be added to the SNMPCounterMonitor attributeInvalidAttributeValueException
ConfigurationException
boolean removeSNMPCounterMonitor(SNMPCounterMonitorMBean countermonitor) throws InvalidAttributeValueException, ConfigurationException
javax.management.MBeanServerConnection
interface.countermonitor
-InvalidAttributeValueException
ConfigurationException
SNMPCounterMonitorMBean createSNMPCounterMonitor(String name)
Factory method to create SNMPCounterMonitor objects
name
-void destroySNMPCounterMonitor(SNMPCounterMonitorMBean countermonitor)
Removes a SNMPCounterMonitor from this domain
countermonitor
-SNMPCounterMonitorMBean lookupSNMPCounterMonitor(String name)
name
-SNMPLogFilterMBean[] getSNMPLogFilters()
The SNMPLogFilterMBeans
which describe filters for generating notifications based on server log messages.
SNMPLogFilterMBean
void setSNMPLogFilters(SNMPLogFilterMBean[] snmpLogFilters) throws InvalidAttributeValueException, ConfigurationException
javax.management.MBeanServerConnection
interface.Sets the value of the SNMPLogFilters attribute.
snmpLogFilters
- The new SNMPLogFilters valueInvalidAttributeValueException
ConfigurationException
SNMPAgentMBean.getSNMPLogFilters()
boolean addSNMPLogFilter(SNMPLogFilterMBean logfilter) throws InvalidAttributeValueException, ConfigurationException
javax.management.MBeanServerConnection
interface.Adds a feature to the SNMPLogFilter attribute of the SNMPAgentMBean object
logfilter
- The feature to be added to the SNMPLogFilter attributeInvalidAttributeValueException
ConfigurationException
boolean removeSNMPLogFilter(SNMPLogFilterMBean logfilter) throws InvalidAttributeValueException, ConfigurationException
javax.management.MBeanServerConnection
interface.logfilter
-InvalidAttributeValueException
ConfigurationException
SNMPLogFilterMBean createSNMPLogFilter(String name)
Factory method to create SNMPLogFilter objects
name
-void destroySNMPLogFilter(SNMPLogFilterMBean logfilter)
Removes a SNMPLogFilter from this domain
logfilter
-SNMPLogFilterMBean lookupSNMPLogFilter(String name)
name
-SNMPAttributeChangeMBean[] getSNMPAttributeChanges()
The SNMPAttributeChangeMBeans
which describe the MBean type and Attribute name for which attribute change notification should be sent when an attribute change is observed.
SNMPAttributeChangeMBean
void setSNMPAttributeChanges(SNMPAttributeChangeMBean[] snmpAttributeChanges) throws InvalidAttributeValueException, ConfigurationException
javax.management.MBeanServerConnection
interface.Sets the value of the SNMPAttributeChanges attribute.
snmpAttributeChanges
- The new SNMPAttributeChanges valueInvalidAttributeValueException
ConfigurationException
SNMPAgentMBean.getSNMPAttributeChanges()
boolean addSNMPAttributeChange(SNMPAttributeChangeMBean attrchange) throws InvalidAttributeValueException, ConfigurationException
javax.management.MBeanServerConnection
interface.Adds a feature to the SNMPAttributeChange attribute of the SNMPAgentMBean object
attrchange
- The feature to be added to the SNMPAttributeChange attributeInvalidAttributeValueException
ConfigurationException
boolean removeSNMPAttributeChange(SNMPAttributeChangeMBean attrchange) throws InvalidAttributeValueException, ConfigurationException
javax.management.MBeanServerConnection
interface.attrchange
-InvalidAttributeValueException
ConfigurationException
SNMPAttributeChangeMBean createSNMPAttributeChange(String name)
Factory method to create SNMPAttributeChange objects
name
-void destroySNMPAttributeChange(SNMPAttributeChangeMBean attrchange)
Removes a SNMPAttributeChange from this domain
attrchange
-SNMPAttributeChangeMBean lookupSNMPAttributeChange(String name)
name
-boolean isCommunityBasedAccessEnabled()
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.
void setCommunityBasedAccessEnabled(boolean enabled)
String getSNMPEngineId()
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.
void setSNMPEngineId(String engineId)
String getAuthenticationProtocol()
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.
void setAuthenticationProtocol(String protocol)
String getPrivacyProtocol()
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.
SNMPTrapDestinationMBean.getSecurityLevel()
void setPrivacyProtocol(String protocol)
int getInformRetryInterval()
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.
void setInformRetryInterval(int interval)
int getMaxInformRetryCount()
The maximum number of times that this SNMP agent will resend INFORM notifications for which it has not received a response.
void setMaxInformRetryCount(int retryCount)
long getLocalizedKeyCacheInvalidationInterval()
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.
SNMPAgentRuntimeMBean.invalidateLocalizedKeyCache(String)
, SNMPTrapDestinationMBean
void setLocalizedKeyCacheInvalidationInterval(long value)
boolean isSNMPAccessForUserMBeansEnabled()
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.
SNMPAgentMBean.getMasterAgentXPort()
void setSNMPAccessForUserMBeansEnabled(boolean v)
boolean isInformEnabled()
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.
SNMPAgentMBean.getSNMPTrapVersion()
void setInformEnabled(boolean value)
int getMasterAgentXPort()
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.
void setMasterAgentXPort(int value)
|
Copyright 1996, 2015, Oracle and/or its affiliates. All rights reserved. Oracle is a registered trademark of Oracle Corporation and/or its affiliates. Other names may be trademarks of their respective owners. Oracle Fusion Middleware Java API Reference for Oracle WebLogic Server 12c (12.2.1) Part Number E55141-01 P4 Change 1723563 on 2015/10/09 |
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |