GET A Create Form For This SNMP Log Filter Collection
/management/weblogic/{version}/edit/SNMPAgentDeployments/{name}/SNMPLogFilterCreateForm
This resource returns a pre-populated SNMP log filter model that can be customized then posted (using the POST method) to the SNMPLogFilters collection resource to create a new SNMP log filter.
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 this SNMP log filter.
This method can return the following links:
- rel=create uri=/management/weblogic/{version}/edit/SNMPAgentDeployments/{name}/SNMPLogFilters
The collection resource for this create form 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
-
messageIds(optional):
array Items
Title:
Items
A list of message IDs or ID ranges that cause a WebLogic Server SNMP agent to generate a notification.
If no IDs are specified, this filter selects all message IDs.
Example list: 20,50-100,300
-
messageSubstring(optional):
string
A string that is searched for in the message text. Only messages that contain the string are selected. If a string is not specified, all messages are selected.
-
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.
-
severityLevel(optional):
string
Default Value:
Notice
The minimum severity of a message that causes a WebLogic Server SNMP agent to generate a notification.
-
subsystemNames(optional):
array Items
Title:
Items
A list of subsystems whose messages are selected by this log filter. If none are specified, messages from all subsystems are selected.
-
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
-
userIds(optional):
array Items
Title:
Items
A list of user IDs that causes a WebLogic Server SNMP agent to generate a notification.
Every message includes the user ID from the security context in which the message was generated.
If the user ID field for a message matches one of the user IDs you specify in the filter, WebLogic Server generates a notification.
If this log filter doesn't specify user IDs, WebLogic Server can generate a notification for messages from all user IDs.
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.
array
Items
A list of message IDs or ID ranges that cause a WebLogic Server SNMP agent to generate a notification.
If no IDs are specified, this filter selects all message IDs.
Example list: 20,50-100,300
array
Items
A list of subsystems whose messages are selected by this log filter. If none are specified, messages from all subsystems are selected.
array
Items
A list of user IDs that causes a WebLogic Server SNMP agent to generate a notification.
Every message includes the user ID from the security context in which the message was generated.
If the user ID field for a message matches one of the user IDs you specify in the filter, WebLogic Server generates a notification.
If this log filter doesn't specify user IDs, WebLogic Server can generate a notification for messages from all user IDs.
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