ルート・スキーマ: SNMP Counter Monitor
タイプ: object
ソースを表示
- dynamicallyCreated(optional): boolean
読取り専用: true
デフォルト値: false
MBeanが動的に作成されたか、config.xmlに対して永続化されているかが返されます
- enabledServers(optional): array Server References
タイトル: 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)
- modulus(optional): integer(int64)
最小値: 0
しきい値を超えたときにしきい値から減算される値。
「係数」が0の場合、属性値がしきい値以上であるかぎり、エージェントが監視対象の属性をポーリングするたびに通知が生成されます。
「係数」が0より大きい場合は、しきい値を超えるたびに係数値がしきい値から減算されます。
- monitoredAttributeName(optional): string
監視するMBean属性の名前。この属性は、WebLogic Server MIB内に存在している必要があります。
- monitoredMBeanName(optional): string
監視するMBeanインスタンスの名前。この名前を未定義のままにした場合、「監視するMBeanタイプ」で指定したMBeanタイプのすべてのインスタンスが監視されます。
SNMPエージェントを個々の管理ターゲット・サーバーにターゲット指定する場合は、指定するMBeanインスタンスがターゲットの管理ターゲット・サーバー上で必ずアクティブになるようにしてください。たとえば、ServerRuntimeMBeanインスタンスの名前としてMServer1
を指定した場合は、SNMPエージェントを管理サーバーかMServer1
という管理対象サーバーにターゲット指定した場合にのみ、この監視が機能します
MBeanインスタンスの完全なJMXオブジェクト名を入力しないでください。かわりに、オブジェクト名のName=name
の名前と値の組合せの値のみを入力します。一意なMBeanオブジェクト名を作成するには、WebLogic Serverは各オブジェクト名として、いくつかの名前と値の組合せをエンコードします。これらの組合せの1つに、Name=name
があります。例:
"MedRec:Name=MedRecServer
Type=ServerRuntime"
前述の例では、MBeanインスタンスの名前として、MedRecServer
を指定します。
- monitoredMBeanType(optional): string
監視する属性を定義するMBeanタイプ。MBean
サフィックスは付けないようにしてください。例: ServerRuntime
- name(optional): string
読取り専用: true
このMBeanインスタンスのユーザー定義の名前。
この名前は、MBeanのjavax.management.ObjectName
に、主要なプロパティとして含まれています
Name=user-specified-name
制約
- notes(optional): string
この構成の説明として任意に入力できる情報。
WebLogic Serverは、ドメインの構成ファイル(config.xml
)に、このノートをXML PCDATAとして保存します。すべての左山カッコ(<)はXMLエンティティ<に変換されます。キャリッジ・リターンとライン・フィードは維持されます。)>
ノート: 管理コンソールからノートを作成または編集した場合、キャリッジ・リターンとライン・フィードは維持されません。
- offset(optional): integer(int64)
最小値: 0
測定値がしきい値以上になるたびに、しきい値に追加される値。
- pollingInterval(optional): integer(int32)
最小値: 1
最大値: 65535
デフォルト値: 10
WebLogic Serverが属性値をチェックする周期(単位: 秒)。
- tags(optional): array Items
- threshold(optional): integer(int64)
最小値: 0
カウンタ監視による通知の生成を発生させるためのしきい値を指定します。
測定値がしきい値未満からしきい値以上に初めて変化したときに、監視は通知を生成します。測定値がしきい値以上になったままの間は、追加の通知は生成されません。測定値がしきい値未満に下がり、その後でしきい値以上になった場合、SNMPカウンタ監視では、しきい値を超えるたびに通知が生成されます。
オフセット値を指定すると、測定値がしきい値以上になるたびに、このしきい値を増やすことができます。測定値が初めて新しいしきい値以上になると、監視は通知を生成して、新しいしきい値にオフセット値を追加します。
たとえば、「しきい値」を1000に、「オフセット」を2000に設定した場合、監視されている属性が1000以上になると、カウンタ監視は通知を送信し、しきい値を3000に増やします。監視されている属性が3000以上になると、カウンタ監視は通知を送信し、しきい値を再び5000に増やします。
- type(optional): string
{
"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>"
},
"modulus":{
"minimum":0,
"type":"integer",
"format":"int64",
"description":"<p>A value to be subtracted from the threshold value when the threshold value is crossed.</p><p>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.</p><p>If Modulus is larger than 0, the value of the modulus is subtracted from the threshold each time the threshold is crossed.</p>"
},
"monitoredAttributeName":{
"type":"string",
"description":"<p>The name of an MBean attribute to monitor. This attribute must be in the WebLogic Server MIB.</p>"
},
"monitoredMBeanName":{
"type":"string",
"description":"<p>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.</p><p>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 <code>MServer1</code> 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 named <code>MServer1</code></p><p>Do not enter the full JMX object name of the MBean instance. Instead, enter only the value of the object name's <code>Name=<i>name</i></code> name-value pair. To create unique MBean object names, WebLogic Server encodes several name-value pairs into each object name. One of these pairs is <code>Name=<i>name</i></code>. For example:</p><p><code>\"MedRec:<b>Name=MedRecServer</b></code><br><code>Type=ServerRuntime\"</code></p><p>In the previous example, specify <code>MedRecServer</code> as the name of the MBean instance.</p>"
},
"monitoredMBeanType":{
"type":"string",
"description":"<p>The MBean type that defines the attribute you want to monitor. Do not include the <code>MBean</code> suffix. For example, <code>ServerRuntime</code></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>"
},
"offset":{
"minimum":0,
"type":"integer",
"format":"int64",
"description":"<p>A value to be added to the threshold value each time the observed value equals or exceeds the threshold.</p>"
},
"pollingInterval":{
"default":10,
"minimum":1,
"maximum":65535,
"type":"integer",
"format":"int32",
"description":"<p>The frequency (in seconds) that WebLogic Server checks the attribute value.</p>"
},
"tags":{
"title":"Items",
"type":"array",
"items":{
"type":"string",
"description":""
},
"description":"<p>Return all tags on this Configuration MBean</p>"
},
"threshold":{
"minimum":0,
"type":"integer",
"format":"int64",
"description":"<p>Specifies a value that triggers the Counter Monitor to generate a notification.</p><p>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.</p><p>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.</p><p>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.</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>"
}
},
"description":""
}
ネストされたスキーマ: Server References
タイプ: 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>"
}
ネストされたスキーマ: Server Reference
タイプ: 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."
}