SNMPProxyMBean


Overview  |   Related MBeans  |   Attributes  |   Operations

Overview

This MBean represents an SNMP agent that is proxied by a WebLogic Server SNMP agent.

   
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.SNMPProxyMBean
Factory Methods


Attributes

This section describes the following attributes:


CachingDisabled

Private property that disables caching in proxies.

This attribute is not dynamic and requires a server restart to take effect.

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

Community

The community name to be passed on for all SNMPv1 requests to this proxied SNMP agent.

If you specify a security name for this proxied agent, the WebLogic SNMP agent ignores this community name. Instead, the agent encodes the security name in an SNMPv3 request and forwards the SNMPv3 request to this proxied agent.

       
Privileges Read/Write
Typejava.lang.String
Default Valuepublic

DynamicallyCreated

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

This attribute is not dynamic and requires a server restart to take effect.

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

Id

Return the unique id of this MBean instance

This attribute is not dynamic and requires a server restart to take effect.

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

ListenAddress

The address on which the external SNMP agent for which the WebLogic SNMP Agent is acting as a proxy is listening for incoming requests from SNMP managers that use the UDP protocol.

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

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

MBeanInfo

Returns the MBean info for this MBean.

This attribute is not dynamic and requires a server restart to take effect.

Deprecated.

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

Name

The user-specified name of this MBean instance.

This name is included as one of the key properties in the MBean's javax.management.ObjectName:

Name=user-specified-name

This attribute is not dynamic and requires a server restart to take effect.

       
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.

This attribute is not dynamic and requires a server restart to take effect.

           
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.

This attribute is not dynamic and requires a server restart to take effect.

Deprecated.

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

OidRoot

The root of the object identifier (OID) tree that this proxied SNMP agent controls.

       
Privileges Read/Write
Typejava.lang.String

Parent

Return the immediate parent for this MBean

This attribute is not dynamic and requires a server restart to take effect.

       
Privileges Read/Write
Type

Port

The port number on which this proxied SNMP agent is listening.

       
Privileges Read/Write
Typeint
Minimum value0
Maximum value65535

Registered

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

This attribute is not dynamic and requires a server restart to take effect.

Deprecated.

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

SecurityLevel

The security level that the proxied SNMP agent expects for the specified security name.

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

SecurityName

The user name on whose behalf the WebLogic SNMP agent forwards v3 requests. If not specified, the request is forwarded as a v1 request.

If you specify a security name, you must also specify a security level that is equal to or lower than the security level that is configured for communication between the WebLogic SNMP agent and SNMP managers. For example, if the WebLogic SNMP agent requires incoming SNMPv3 requests to use the authentication protocol but no privacy protocol, the security level for this proxy must be either Authentication Only or None. Note that if you want to use the authorization or privacy protocols, you must configure credential mapping in the WebLogic Server security realm.

The WebLogic SNMP agent cannot forward or pass through the credentials that are contained in SNMPv3 requests from SNMP managers. Instead, the agent authenticates and performs other security operations on incoming requests, and then constructs a new request to forward to a proxied agent.

For more information, see:

       
Privileges Read/Write
Typejava.lang.String

Tags

Return all tags on this Configuration MBean

This attribute is dynamic and takes effect immediately.

       
Available Since Release 12.2.1.0.0
Privileges Read/Write
Typeclass java.lang.String[]

Timeout

The number of milliseconds that the WebLogic Server SNMP agent waits for a response to requests that it forwards to this proxy agent.

If the interval elapses without a response, the WebLogic SNMP agent sends an error to the requesting manager.

       
Privileges Read/Write
Typelong
Default Value5000
Minimum value0

Type

Returns the type of the MBean.

This attribute is not dynamic and requires a server restart to take effect.

       
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:


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

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

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

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