View This SNMP Counter Monitor Collection
/management/weblogic/{version}/edit/SNMPAgentDeployments/{name}/SNMPCounterMonitors
View this SNMP counter monitor collection.
Request
-
name: string
The name property of the instance in the collection.
-
version: string
The version of the WebLogic REST interface.
-
excludeFields(optional): string
The 'excludeFields' query parameter is used to restrict which fields are returned in the response. It is a comma separated list of field names. If present, only fields whose name is not on the list will be returned. If not present, all fields are returned (unless the 'fields' query parameter is specified). Note: 'fields' must not be specified if 'excludeFields' is specified.
-
excludeLinks(optional): string
The 'excludeLinks' query parameter is used to restrict which links are returned in the response. It is a comma separated list of link relationship names. If present, only links whose relationship name is not on the list will be returned. If not present, all links are returned (unless the 'links' query parameter is specified). Note: 'links' must not be specified if 'excludeLinks' is specified.
-
fields(optional): string
The 'fields' query parameter is used to restrict which fields are returned in the response. It is a comma separated list of field names. If present, only fields with matching names are returned. If not present, all fields are returned (unless the 'excludeFields' query parameter is specified). Note: 'excludeFields' must not be specified if 'fields' is specified.
-
links(optional): string
The 'links' query parameter is used to restrict which links are returned in the response. It is a comma separated list of link relationship names. If present, only links with matching relationship names are returned. If not present, all links are returned (unless the 'excludeLinks' query parameter is specified). Note: 'excludeLinks' must not be specified if 'links' is specified.
-
Admin: basic
Type:
basic
Description:A user in the Admin security role.
-
Deployer: basic
Type:
basic
Description:A user in the Deployer security role.
-
Monitor: basic
Type:
basic
Description:A user in the Monitor security role.
-
Operator: basic
Type:
basic
Description:A user in the Operator security role.
Response
- application/json
200 Response
Returns a list of SNMP counter monitor entities.
This method can return the following links:
- rel=create-form uri=/management/weblogic/{version}/edit/SNMPAgentDeployments/{name}/SNMPCounterMonitorCreateForm
The create form resource for this collection resource.
object
-
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
-
modulus(optional):
integer(int64)
Minimum Value:
0
A value to be subtracted from the threshold value when the threshold value is crossed.
If Modulus is 0, a notification is generated each time the agent polls the monitored attribute and its value still exceeds or equals the threshold value.
If Modulus is larger than 0, the value of the modulus is subtracted from the threshold each time the threshold is crossed.
-
monitoredAttributeName(optional):
string
The name of an MBean attribute to monitor. This attribute must be in the WebLogic Server MIB.
-
monitoredMBeanName(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.
If you target SNMP agents to individual Managed Servers, make sure that the MBean instance you specify is active on the Managed Servers you have targeted. For example, if you specify
MServer1
as the name of a ServerRuntimeMBean instance, this monitor will only function if you target an SNMP agent either to the Administration Server or to a Managed Server namedMServer1
Do not enter the full JMX object name of the MBean instance. Instead, enter only the value of the object name's
Name=name
name-value pair. To create unique MBean object names, WebLogic Server encodes several name-value pairs into each object name. One of these pairs isName=name
. For example:"MedRec:Name=MedRecServer
Type=ServerRuntime"
In the previous example, specify
MedRecServer
as the name of the MBean instance. -
monitoredMBeanType(optional):
string
The MBean type that defines the attribute you want to monitor. Do not include the
MBean
suffix. For example,ServerRuntime
-
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.
-
offset(optional):
integer(int64)
Minimum Value:
0
A value to be added to the threshold value each time the observed value equals or exceeds the threshold.
-
pollingInterval(optional):
integer(int32)
Minimum Value:
1
Maximum Value:65535
Default Value:10
The frequency (in seconds) that WebLogic Server checks the attribute value.
-
tags(optional):
array Items
Title:
Items
Return all tags on this Configuration MBean
-
threshold(optional):
integer(int64)
Minimum Value:
0
Specifies a value that triggers the Counter Monitor to generate a notification.
The monitor generates a notification the first time the observed value transitions from below the threshold to at or above the threshold. While the observed value remains at or above the threshold, the Counter Monitor does not generate additional notifications. If the observed value falls below the threshold and then later equals or exceeds the threshold, the SNMP Counter Monitor will generate a notification every time the threshold is crossed.
You can specify an offset value to cause this threshold value to increase each time the observed value equals or exceeds the threshold. The first time the observed value equals or exceeds the new threshold value, this monitor generates a notification and adds the offset value to the new threshold value.
For example, if you set Threshold to 1000 and Offset to 2000, when the observed attribute equals or exceeds 1000, the Counter Monitor sends a notification and increases the threshold to 3000. When the observed attribute equals or exceeds 3000, the Counter Monitor sends a notification and increases the threshold again to 5000.
-
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