ルート・スキーマ: SNMPログ・フィルタ
型: object
ソースの表示
- dynamicallyCreated(optional): boolean
読取り専用: true
デフォルト値: false
MBeanが動的に作成されたか、config.xmlに対して永続化されているかが返されます
- enabledServers(optional): array サーバー参照
タイトル: Server References
サーバー参照の配列が含まれます。
この属性は、SNMPエージェントがWebLogicドメインの管理サーバー上で動作している場合にのみ適用されます。EnabledServers属性によって、ユーザーは監視対象となるデータ・ソースの範囲を指定したサーバーに制限できます。SNMAgentDeploymentMBeanが管理対象サーバーに割り当てられている場合、EnabledServersリストは無視されます。管理対象サーバーの場合、SNMPエージェントはSNMPエージェントをデプロイしているWebLogicサーバー上にあるデータのみを監視します。
MBean属性を基準とするトラップでは、SNMPエージェントは管理サーバー上で動作しているときはドメイン実行時MBeanサーバーを参照し、管理対象サーバーにデプロイされるときは実行時MBeanサーバーを参照します。
SNMPJMXMonitorMBean
およびSNMPAttributeChangeMBean
の場合、MonitoredMBeanType
およびMonitoredMBeanName
属性はトラップを設定するWebLogic Server MBeanのタイプと名前を指定します。タイプおよび属性の条件に一致するMBeanは、トラップをオンに設定するように修飾されています。EnabledServers属性は、SNMPエージェントが管理サーバーをターゲットとしている場合、MBeanの場所を基準として追加の条件を指定することを許可します。EnabledServersリスト内のサーバーの1つと場所が一致しているMBeanは、対応するJMX通知のために生成されるトラップに適しているとみなされます。EnabledServers属性が指定されていない場合、タイプと名前が一致するすべてのMBeanはSNMPトラップの有効なソースとみなされます。
SNMPLogFilterMBean
の場合、EnabledServers属性はエージェントが管理サーバーで動作しているときにログ・メッセージが監視されるドメイン内のサーバーを指定することを許可します。管理サーバーで動作しているエージェントでEnabledServersが指定されていない場合、ドメイン内のすべての管理対象サーバーのログ・メッセージは、送信トラップで監視されます。この属性は、SNMPエージェントが管理対象サーバーに割り当てられている場合には適用されません。この場合、トラップはエージェントがデプロイされたそれぞれの管理対象サーバーによって生成されたログ・メッセージを基準に送信されます。
- id(optional): integer(int64)
- messageIds(optional): array 項目
タイトル: Items
WebLogic Server SNMPエージェントによる通知生成の対象となるメッセージIDまたはメッセージIDの範囲のリスト。
IDを指定しない場合、このフィルタではすべてのメッセージIDが選択されます。
リスト例: 20,50-100,300
- messageSubstring(optional): string
メッセージ・テキストから検索する文字列。この文字列を含むメッセージのみが選択されます。何も指定しない場合、すべてのメッセージが選択されます。
- name(optional): string
読取り専用: true
このMBeanインスタンスのユーザー定義の名前。
この名前は、MBeanのjavax.management.ObjectName
に、主要なプロパティとして含まれています
Name=user-specified-name
制約
- notes(optional): string
この構成の説明として任意に入力できる情報。
WebLogic Serverは、ドメインの構成ファイル(config.xml
)に、このノートをXML PCDATAとして保存します。すべての左山カッコ(<)はxmlエンティティに変換されます<) are converted to the xml entity <。改行/行送りは保持されます</)>。)>
ノート: 管理コンソールからノートを作成または編集した場合、キャリッジ・リターンとライン・フィードは維持されません。
- severityLevel(optional): string
デフォルト値: Notice
WebLogic Server SNMPエージェントが通知を生成する基準となる最低の重大度。
- subsystemNames(optional): array 項目
タイトル: Items
このログ・フィルタによってメッセージを選択する対象のサブシステムのリスト。何も指定しない場合、すべてのサブシステムからのメッセージが選択されます。
- tags(optional): array Items
- type(optional): string
- userIds(optional): array 項目
タイトル: Items
WebLogic Server SNMPエージェントによる通知生成の対象となるユーザーIDのリスト。
各メッセージには、メッセージが生成されたセキュリティ・コンテキストからユーザーIDが付加されます。
メッセージのユーザーIDフィールドとフィルタで指定したいずれかのユーザーIDが一致する場合に、WebLogic Serverは通知を生成します。
このログ・フィルタでユーザーIDを指定しない場合、WebLogic ServerはすべてのユーザーIDからのメッセージに対して通知を生成できます。
{
"type":"object",
"properties":{
"dynamicallyCreated":{
"readOnly":true,
"default":false,
"type":"boolean",
"description":"<p>Return whether the MBean was created dynamically or is persisted to config.xml</p>"
},
"enabledServers":{
"title":"Server References",
"type":"array",
"items":{
"title":"Server Reference",
"type":"object",
"properties":{
"identity":{
"title":"Identity",
"type":"array",
"items":{
"type":"string",
"description":""
},
"description":"DOC TEAM TBD - describe an identity - it's a reference to another WLS REST resource."
}
},
"description":"Contains the server reference."
},
"description":"Contains the array of server references. <p>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. </p><p> 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. </p><p> In the case of <code>SNMPJMXMonitorMBean</code> and <code>SNMPAttributeChangeMBean</code> the <code>MonitoredMBeanType</code> and <code>MonitoredMBeanName</code> 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. </p><p> In the case of <code>SNMPLogFilterMBean</code> 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. </p>"
},
"id":{
"readOnly":true,
"type":"integer",
"format":"int64",
"description":"<p>Return the unique id of this MBean instance</p>"
},
"messageIds":{
"title":"Items",
"type":"array",
"items":{
"type":"string",
"description":""
},
"description":"<p>A list of message IDs or ID ranges that cause a WebLogic Server SNMP agent to generate a notification.</p><p>If no IDs are specified, this filter selects all message IDs.</p><p>Example list: 20,50-100,300</p>"
},
"messageSubstring":{
"type":"string",
"description":"<p>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.</p>"
},
"name":{
"readOnly":true,
"x-weblogic-legalNull":true,
"type":"string",
"description":"<p>The user-specified name of this MBean instance.</p><p>This name is included as one of the key properties in the MBean's <code>javax.management.ObjectName</code></p><p><code>Name=<i>user-specified-name</i></code></p><p><h5>Constraints</h5></p><ul><li>legal null</li></ul>"
},
"notes":{
"type":"string",
"description":"<p>Optional information that you can include to describe this configuration.</p><p>WebLogic Server saves this note in the domain's configuration file (<code>config.xml</code>) as XML PCDATA. All left angle brackets (<) are converted to the XML entity <code><</code>. Carriage returns/line feeds are preserved.</p><p>Note: If you create or edit a note from the Administration Console, the Administration Console does not preserve carriage returns/line feeds.</p>"
},
"severityLevel":{
"default":"Notice",
"type":"string",
"description":"<p>The minimum severity of a message that causes a WebLogic Server SNMP agent to generate a notification.</p>"
},
"subsystemNames":{
"title":"Items",
"type":"array",
"items":{
"type":"string",
"description":""
},
"description":"<p>A list of subsystems whose messages are selected by this log filter. If none are specified, messages from all subsystems are selected.</p>"
},
"tags":{
"title":"Items",
"type":"array",
"items":{
"type":"string",
"description":""
},
"description":"<p>Return all tags on this Configuration MBean</p>"
},
"type":{
"readOnly":true,
"x-weblogic-unharvestable":true,
"type":"string",
"description":"<p>Returns the type of the MBean.</p><p><h5>Constraints</h5></p><ul><li>unharvestable</li></ul>"
},
"userIds":{
"title":"Items",
"type":"array",
"items":{
"type":"string",
"description":""
},
"description":"<p>A list of user IDs that causes a WebLogic Server SNMP agent to generate a notification.</p><p>Every message includes the user ID from the security context in which the message was generated.</p><p>If the user ID field for a message matches one of the user IDs you specify in the filter, WebLogic Server generates a notification.</p><p>If this log filter doesn't specify user IDs, WebLogic Server can generate a notification for messages from all user IDs.</p>"
}
},
"description":""
}
ネストされたスキーマ: サーバー参照
型: array
タイトル: Server References
サーバー参照の配列が含まれます。
この属性は、SNMPエージェントがWebLogicドメインの管理サーバー上で動作している場合にのみ適用されます。EnabledServers属性によって、ユーザーは監視対象となるデータ・ソースの範囲を指定したサーバーに制限できます。SNMAgentDeploymentMBeanが管理対象サーバーに割り当てられている場合、EnabledServersリストは無視されます。管理対象サーバーの場合、SNMPエージェントはSNMPエージェントをデプロイしているWebLogicサーバー上にあるデータのみを監視します。
MBean属性を基準とするトラップでは、SNMPエージェントは管理サーバー上で動作しているときはドメイン実行時MBeanサーバーを参照し、管理対象サーバーにデプロイされるときは実行時MBeanサーバーを参照します。
SNMPJMXMonitorMBean
およびSNMPAttributeChangeMBean
の場合、MonitoredMBeanType
およびMonitoredMBeanName
属性はトラップを設定するWebLogic Server MBeanのタイプと名前を指定します。タイプおよび属性の条件に一致するMBeanは、トラップをオンに設定するように修飾されています。EnabledServers属性は、SNMPエージェントが管理サーバーをターゲットとしている場合、MBeanの場所を基準として追加の条件を指定することを許可します。EnabledServersリスト内のサーバーの1つと場所が一致しているMBeanは、対応するJMX通知のために生成されるトラップに適しているとみなされます。EnabledServers属性が指定されていない場合、タイプと名前が一致するすべてのMBeanはSNMPトラップの有効なソースとみなされます。
SNMPLogFilterMBean
の場合、EnabledServers属性はエージェントが管理サーバーで動作しているときにログ・メッセージが監視されるドメイン内のサーバーを指定することを許可します。管理サーバーで動作しているエージェントでEnabledServersが指定されていない場合、ドメイン内のすべての管理対象サーバーのログ・メッセージは、送信トラップで監視されます。この属性は、SNMPエージェントが管理対象サーバーに割り当てられている場合には適用されません。この場合、トラップはエージェントがデプロイされたそれぞれの管理対象サーバーによって生成されたログ・メッセージを基準に送信されます。
ソースの表示
{
"title":"Server References",
"type":"array",
"items":{
"title":"Server Reference",
"type":"object",
"properties":{
"identity":{
"title":"Identity",
"type":"array",
"items":{
"type":"string",
"description":""
},
"description":"DOC TEAM TBD - describe an identity - it's a reference to another WLS REST resource."
}
},
"description":"Contains the server reference."
},
"description":"Contains the array of server references. <p>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. </p><p> 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. </p><p> In the case of <code>SNMPJMXMonitorMBean</code> and <code>SNMPAttributeChangeMBean</code> the <code>MonitoredMBeanType</code> and <code>MonitoredMBeanName</code> 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. </p><p> In the case of <code>SNMPLogFilterMBean</code> 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. </p>"
}
ネストされたスキーマ: 項目
型: array
タイトル: Items
WebLogic Server SNMPエージェントによる通知生成の対象となるメッセージIDまたはメッセージIDの範囲のリスト。
IDを指定しない場合、このフィルタではすべてのメッセージIDが選択されます。
リスト例: 20,50-100,300
ソースの表示
{
"title":"Items",
"type":"array",
"items":{
"type":"string",
"description":""
},
"description":"<p>A list of message IDs or ID ranges that cause a WebLogic Server SNMP agent to generate a notification.</p><p>If no IDs are specified, this filter selects all message IDs.</p><p>Example list: 20,50-100,300</p>"
}
ネストされたスキーマ: 項目
型: array
タイトル: Items
このログ・フィルタによってメッセージを選択する対象のサブシステムのリスト。何も指定しない場合、すべてのサブシステムからのメッセージが選択されます。
ソースの表示
{
"title":"Items",
"type":"array",
"items":{
"type":"string",
"description":""
},
"description":"<p>A list of subsystems whose messages are selected by this log filter. If none are specified, messages from all subsystems are selected.</p>"
}
ネストされたスキーマ: 項目
型: array
タイトル: Items
WebLogic Server SNMPエージェントによる通知生成の対象となるユーザーIDのリスト。
各メッセージには、メッセージが生成されたセキュリティ・コンテキストからユーザーIDが付加されます。
メッセージのユーザーIDフィールドとフィルタで指定したいずれかのユーザーIDが一致する場合に、WebLogic Serverは通知を生成します。
このログ・フィルタでユーザーIDを指定しない場合、WebLogic ServerはすべてのユーザーIDからのメッセージに対して通知を生成できます。
ソースの表示
{
"title":"Items",
"type":"array",
"items":{
"type":"string",
"description":""
},
"description":"<p>A list of user IDs that causes a WebLogic Server SNMP agent to generate a notification.</p><p>Every message includes the user ID from the security context in which the message was generated.</p><p>If the user ID field for a message matches one of the user IDs you specify in the filter, WebLogic Server generates a notification.</p><p>If this log filter doesn't specify user IDs, WebLogic Server can generate a notification for messages from all user IDs.</p>"
}
ネストされたスキーマ: サーバー参照
型: object
タイトル: Server Reference
サーバー参照が含まれます。
ソースの表示
{
"title":"Server Reference",
"type":"object",
"properties":{
"identity":{
"title":"Identity",
"type":"array",
"items":{
"type":"string",
"description":""
},
"description":"DOC TEAM TBD - describe an identity - it's a reference to another WLS REST resource."
}
},
"description":"Contains the server reference."
}
ネストされたスキーマ: アイデンティティ
型: array
タイトル: Identity
DOC TEAM TBD - アイデンティティの説明 - 別のWLS RESTリソースへの参照です。
ソースの表示
{
"title":"Identity",
"type":"array",
"items":{
"type":"string",
"description":""
},
"description":"DOC TEAM TBD - describe an identity - it's a reference to another WLS REST resource."
}