ジャンプ先

• リクエスト
• レスポンス

このSNMP属性変更の変更

post

/management/weblogic/{version}/edit/SNMPAgent/SNMPAttributeChanges/{name}

このSNMP属性変更を変更します。

リクエスト

サポートされているメディア・タイプ

• application/json

パス・パラメータ

• name: string
  コレクション内のインスタンスのnameプロパティ。
• version: string
  WebLogic RESTインタフェースのバージョン。

ヘッダー・パラメータ

• X-Requested-By: string
  X-Requested-Byヘッダーは、クロスサイト・リクエスト・フォージェリ(CSRF)攻撃からの保護に使用されます。値は、MyClientなどの任意の名前です。

本文()

変更されたSNMP属性変更モデルを含める必要があります。

ルート・スキーマ: SNMP Attribute Change

タイプ: object

ソースを表示

• attributeMBeanName(optional): string

  監視するMBeanインスタンスの名前。この名前を未定義のままにした場合、「監視するMBeanタイプ」で指定したMBeanタイプのすべてのインスタンスが監視されます。

  MBeanインスタンスの完全なJMXオブジェクト名を入力しないでください。かわりに、インスタンス作成時に指定した値のみを入力します。一意なMBeanオブジェクト名を作成するには、WebLogic Serverは各オブジェクト名として、いくつかの名前と値の組合せをエンコードします。それらの組合せの1つに、Name=nameがあり、これはMBean Nameとして入力される値です。例:

  "MedRec:Name=MedRecServer
Type=ServerRuntime"

  前述の例では、MBeanインスタンスの名前として、MedRecServerを指定します。

• attributeMBeanType(optional): string

  監視する属性を定義するMBeanタイプ。MBeanサフィックスは付けないようにしてください。たとえば、ServerMBeanを監視するにはServerと指定します。

  WebLogic Serverでは、属性変更通知による実行時属性の監視はサポートしていません。実行時MBeanの名前には、必ずRuntimeという単語が含まれています。たとえば、ServerRuntime MBeanでは実行時属性にアクセスでき、Server MBeanでは構成属性にアクセスできます。名前にRuntimeを含んだMBeanの変更を監視するには、文字列監視、ゲージ監視またはカウンタ監視を使用します。

• attributeName(optional): string

  監視する属性の名前。この属性は、WebLogic Server MIB内に存在している必要があります。

• 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)
  読取り専用: true

  このMBeanインスタンスの一意のIDを返します

• name(optional): string
  読取り専用: true

  このMBeanインスタンスのユーザー定義の名前。

  この名前は、MBeanのjavax.management.ObjectNameに、主要なプロパティとして含まれています

  Name=user-specified-name

  制約

  • 有効なnull
• notes(optional): string

  この構成の説明として任意に入力できる情報。

  WebLogic Serverは、ドメインの構成ファイル(config.xml)に、このメモをXML PCDATAとして保存します。すべての左山カッコ(<)はXMLエンティティ<に変換されます。キャリッジ・リターンとライン・フィードは維持されます。

  注意: 管理コンソールからメモを作成または編集した場合、キャリッジ・リターンとライン・フィードは維持されません。

• tags(optional): array Items
  タイトル: Items

  この構成MBeanのすべてのタグを返します

• type(optional): string
  読取り専用: true

  MBeanのタイプを戻します。

  制約

  • 収集不可

{
    "type":"object",
    "properties":{
        "attributeMBeanName":{
            "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>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 <code>Name=<i>name</i></code>, and this is the value that you enter for MBean Name. 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>"
        },
        "attributeMBeanType":{
            "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, specify <code>Server</code> to monitor a ServerMBean.</p><p>WebLogic Server does not support using Attribute Change notifications to monitor run-time attributes. Runtime MBeans always include the word <code>Runtime</code> in their names. For example, the <code>ServerRuntime</code> MBean provides access to runtime attributes while the <code>Server</code> MBean provides access to configuration attributes. To monitor changes in an MBean that includes <code>Runtime</code> in its name, use a String Monitor, Gauge Monitor, or Counter Monitor.</p>"
        },
        "attributeName":{
            "type":"string",
            "description":"<p>The name of the attribute that you want to monitor. This attribute must be in the WebLogic Server MIB.</p>"
        },
        "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>"
        },
        "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>&lt;</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>"
        },
        "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>"
        }
    },
    "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エージェントが管理対象サーバーに割り当てられている場合には適用されません。この場合、トラップはエージェントがデプロイされたそれぞれの管理対象サーバーによって生成されたログ・メッセージを基準に送信されます。

ソースを表示

• 配列: object Server Reference
  タイトル: Server Reference

  サーバー参照を含みます。

{
    "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>"
}

ネストされたスキーマ: Items

タイプ: array

タイトル: Items

この構成MBeanのすべてのタグを返します

ソースを表示

• 配列: string

{
    "title":"Items",
    "type":"array",
    "items":{
        "type":"string",
        "description":""
    },
    "description":"<p>Return all tags on this Configuration MBean</p>"
}

ネストされたスキーマ: Server Reference

タイプ: object

タイトル: Server Reference

サーバー参照を含みます。

ソースを表示

• identity(optional): array Identity
  タイトル: Identity

  DOC TEAM TBD - アイデンティティの説明 - 別のWLS RESTリソースへの参照です。

{
    "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."
}

ネストされたスキーマ: Identity

タイプ: array

タイトル: Identity

DOC TEAM TBD - アイデンティティの説明 - 別のWLS RESTリソースへの参照です。

ソースを表示

• 配列: string

{
    "title":"Identity",
    "type":"array",
    "items":{
        "type":"string",
        "description":""
    },
    "description":"DOC TEAM TBD - describe an identity - it's a reference to another WLS REST resource."
}

セキュリティ

• 管理者: 基本
  タイプ: basic

  説明: A user in the Admin security role.

トップに戻る

レスポンス

200レスポンス

トップに戻る