Modify This SNMP Attribute Change
/management/weblogic/{version}/edit/SNMPAgentDeployments/{name}/SNMPAttributeChanges/{name}
Modify this SNMP attribute change.
Request
- application/json
-
name: string
The name property of the instance in the collection.
-
version: string
The version of the WebLogic REST interface.
-
X-Requested-By: string
The 'X-Requested-By' header is used to protect against Cross-Site Request Forgery (CSRF) attacks. The value is an arbitrary name such as 'MyClient'.
Must contain the modified SNMP attribute change model.
object
-
attributeMBeanName(optional):
string
The name of the MBean instance that you want to monitor. If you leave the name undefined, WebLogic Server monitors all instances of the MBean type that you specify in Monitored MBean Type.
Do not enter the full JMX object name of the MBean instance. Instead, enter only the value that you provided when you created the instance. To create unique MBean object names, WebLogic Server encodes several name-value pairs into each object name. One of these pairs is
Name=name
, and this is the value that you enter for MBean Name. For example:"MedRec:Name=MedRecServer
Type=ServerRuntime"
In the previous example, specify
MedRecServer
as the name of the MBean instance. -
attributeMBeanType(optional):
string
The MBean type that defines the attribute you want to monitor. Do not include the
MBean
suffix. For example, specifyServer
to monitor a ServerMBean.WebLogic Server does not support using Attribute Change notifications to monitor run-time attributes. Runtime MBeans always include the word
Runtime
in their names. For example, theServerRuntime
MBean provides access to runtime attributes while theServer
MBean provides access to configuration attributes. To monitor changes in an MBean that includesRuntime
in its name, use a String Monitor, Gauge Monitor, or Counter Monitor. -
attributeName(optional):
string
The name of the attribute that you want to monitor. This attribute must be in the WebLogic Server MIB.
-
dynamicallyCreated(optional):
boolean
Read Only:
true
Default Value:false
Return whether the MBean was created dynamically or is persisted to config.xml
-
enabledServers(optional):
array Server References
Title:
Server References
Contains the array of server references.This attribute is applicable only when the SNMP Agent is running on the Admin Server of a WebLogic Domain. The EnabledServers attribute allows the users to limit the scope of the monitored data sources to the specific named Servers. The EnabledServers list is ignored when the SNMAgentDeploymentMBean is targeted to a Managed Server. In the case of a Managed Server the SNMP Agent only looks at the data available in the WebLogic Server where the SNMP Agent is deployed.
For traps based on MBean attributes the SNMP Agent refers to the Domain Runtime MBean Server when it is running on the Admin Server and the Runtime MBean Server when it is deployed to a Managed Server.
In the case of
SNMPJMXMonitorMBean
andSNMPAttributeChangeMBean
theMonitoredMBeanType
andMonitoredMBeanName
attributes specify the type and name of a WebLogic Server MBean for which the trap will be setup. MBeans that meet the Type and Name criteria are qualified to set the trap on. The EnabledServers attribute allows a user to specify additional criteria based on the Location of an MBean when the SNMP Agent is targeted to the Admin Server. MBeans whose Location matches one of the Servers in the EnabledServers list are considered eligible for the trap to be generated for a corresponding JMX notification. When the EnabledServers attribute is not specified all MBeans whose Type and Name match are considered as valid sources for the SNMP trap.In the case of
SNMPLogFilterMBean
the EnabledServers attribute allows a user to specify the Servers in the Domain whose log messages will be monitored when the Agent is running on the Admin Server. When EnabledServers is not specified for an Agent running on the Admin Server log messages on all Managed Servers in the domain are monitored for sending traps. This attribute is not applicable when the SNMP Agent is targeted to a Managed Server, in this case the traps are sent based on log messages generated by the respective Managed Server where the Agent is deployed. -
id(optional):
integer(int64)
Read Only:
true
Return the unique id of this MBean instance
-
name(optional):
string
Read Only:
true
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
Constraints
- legal null
-
notes(optional):
string
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<. 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.
-
tags(optional):
array Items
Title:
Items
Return all tags on this Configuration MBean
-
type(optional):
string
Read Only:
true
Returns the type of the MBean.
Constraints
- unharvestable
array
Server References
This attribute is applicable only when the SNMP Agent is running on the Admin Server of a WebLogic Domain. The EnabledServers attribute allows the users to limit the scope of the monitored data sources to the specific named Servers. The EnabledServers list is ignored when the SNMAgentDeploymentMBean is targeted to a Managed Server. In the case of a Managed Server the SNMP Agent only looks at the data available in the WebLogic Server where the SNMP Agent is deployed.
For traps based on MBean attributes the SNMP Agent refers to the Domain Runtime MBean Server when it is running on the Admin Server and the Runtime MBean Server when it is deployed to a Managed Server.
In the case of SNMPJMXMonitorMBean
and SNMPAttributeChangeMBean
the MonitoredMBeanType
and MonitoredMBeanName
attributes specify the type and name of a WebLogic Server MBean for which the trap will be setup. MBeans that meet the Type and Name criteria are qualified to set the trap on. The EnabledServers attribute allows a user to specify additional criteria based on the Location of an MBean when the SNMP Agent is targeted to the Admin Server. MBeans whose Location matches one of the Servers in the EnabledServers list are considered eligible for the trap to be generated for a corresponding JMX notification. When the EnabledServers attribute is not specified all MBeans whose Type and Name match are considered as valid sources for the SNMP trap.
In the case of SNMPLogFilterMBean
the EnabledServers attribute allows a user to specify the Servers in the Domain whose log messages will be monitored when the Agent is running on the Admin Server. When EnabledServers is not specified for an Agent running on the Admin Server log messages on all Managed Servers in the domain are monitored for sending traps. This attribute is not applicable when the SNMP Agent is targeted to a Managed Server, in this case the traps are sent based on log messages generated by the respective Managed Server where the Agent is deployed.
-
Array of:
object Server Reference
Title:
Server Reference
Contains the server reference.
object
Server Reference
-
identity(optional):
array Identity
Title:
Identity
DOC TEAM TBD - describe an identity - it's a reference to another WLS REST resource.
array
Identity
-
Admin: basic
Type:
basic
Description:A user in the Admin security role.