このSNMPエージェント・デプロイメントの表示
/management/weblogic/{version}/serverConfig/SNMPAgentDeployments/{name}
このSNMPエージェント・デプロイメントを表示します。
リクエスト
- name: string
コレクション内のインスタンスのnameプロパティ。
- version: string
WebLogic RESTインタフェースのバージョン。
- excludeFields(optional): string
'excludeFields'問合せパラメータは、レスポンスで返されるフィールドを制限するために使用します。これは、フィールド名のカンマ区切りリストです。存在する場合は、名前がリストにないフィールドのみが返されます。存在しない場合は、すべてのフィールドが返されます('fields'問合せパラメータが指定されていない場合)。ノート: 'excludeFields'が指定されている場合、'fields'を指定しないでください。
- excludeLinks(optional): string
'excludeLinks'問合せパラメータは、レスポンスで返されるリンクを制限するために使用します。これは、リンク関係名のカンマ区切りリストです。存在する場合は、関係名がリストにないリンクのみが返されます。存在しない場合は、すべてのリンクが返されます('links'問合せパラメータが指定されていない場合)。ノート: 'excludeLinks'が指定されている場合、'links'を指定しないでください。
- fields(optional): string
'fields'問合せパラメータは、レスポンスで返されるフィールドを制限するために使用します。これは、フィールド名のカンマ区切りリストです。存在する場合は、名前が一致するフィールドのみが返されます。存在しない場合は、すべてのフィールドが返されます('excludeFields'問合せパラメータが指定されていない場合)。ノート: 'fields'が指定されている場合、'excludeFields'を指定しないでください。
- links(optional): string
'links'問合せパラメータは、レスポンスで返されるリンクを制限するために使用します。これは、リンク関係名のカンマ区切りリストです。存在する場合は、関係名が一致するリンクのみが返されます。存在しない場合は、すべてのリンクが返されます('excludeLinks'問合せパラメータが指定されていない場合)。ノート: 'links'が指定されている場合、'excludeLinks'を指定しないでください。
- Admin: basic
型:
Basic
説明:A user in the Admin security role.
- デプロイヤ: 基本
型:
Basic
説明:A user in the Deployer security role.
- モニター: 基本
型:
Basic
説明:A user in the Monitor security role.
- オペレータ: 基本
型:
Basic
説明:A user in the Operator security role.
レスポンス
- application/json
200レスポンス
このSNMPエージェント・デプロイメントを返します。
このメソッドは次のリンクを返すことができます。
- rel=SNMPAttributeChanges uri=/management/weblogic/{version}/serverConfig/SNMPAgentDeployments/{name}/SNMPAttributeChanges
このリソースのSNMPAttributeChangesコレクション・リソース。
- rel=SNMPCounterMonitors uri=/management/weblogic/{version}/serverConfig/SNMPAgentDeployments/{name}/SNMPCounterMonitors
このリソースのSNMPCounterMonitorsコレクション・リソース。
- rel=SNMPGaugeMonitors uri=/management/weblogic/{version}/serverConfig/SNMPAgentDeployments/{name}/SNMPGaugeMonitors
このリソースのSNMPGaugeMonitorsコレクション・リソース。
- rel=SNMPLogFilters uri=/management/weblogic/{version}/serverConfig/SNMPAgentDeployments/{name}/SNMPLogFilters
このリソースのSNMPLogFiltersコレクション・リソース。
- rel=SNMPProxies uri=/management/weblogic/{version}/serverConfig/SNMPAgentDeployments/{name}/SNMPProxies
このリソースのSNMPProxiesコレクション・リソース。
- rel=SNMPStringMonitors uri=/management/weblogic/{version}/serverConfig/SNMPAgentDeployments/{name}/SNMPStringMonitors
このリソースのSNMPStringMonitorsコレクション・リソース。
- rel=SNMPTrapDestinations uri=/management/weblogic/{version}/serverConfig/SNMPAgentDeployments/{name}/SNMPTrapDestinations
このリソースのSNMPTrapDestinationsコレクション・リソース。
object
- authenticationProtocol(optional): string
デフォルト値:
MD5
使用可能な値:[ "noAuth", "MD5", "SHA" ]
認可されたユーザーのみがWebLogic Serverドメインに関する情報をリクエストまたは受信できるように、このSNMPエージェントで使用するプロトコル。SNMPv3の場合にのみ適用可能。
このプロトコルでは、メッセージの整合性を保証して、なりすましやメッセージの並べ替え、遅延、リプレイなどを防ぎます。
SNMPマネージャからリクエストを受信するときにこのプロトコルを使用するには、WebLogic Serverセキュリティ・レルムで資格証明マッピングを構成する必要があります。レスポンスまたは通知を送信するときにこのプロトコルを使用するには、トラップ通知のセキュリティ・レベルを構成する必要があります。
認証プロトコルを選択しない場合、SNMPエージェントは受信するSNMPv3リクエストを認証しないので、誰でもSNMPv3を使用してWebLogic Serverドメインの情報を取得できるようになります。
制約
- 有効なnull
- deploymentOrder(optional): integer(int32)
最小値:
0
最大値:2147483647
デフォルト値:1000
デプロイの優先度。サーバーはこの値を使用して項目のデプロイ順を決定します。優先度は、同じタイプでデプロイ可能なアイテム間で決められます。
たとえば、サーバーではすべてのEJBを優先度に従ってデプロイしてから、起動クラスを優先度に従ってデプロイします。
「デプロイ順序」の値が小さい項目から順にデプロイされます。「デプロイ順序」の値が等しいデプロイメントの順序付けは保証されていません。クラスタ間の順序付けは保証されていません。
- dynamicallyCreated(optional): boolean
読取り専用:
true
デフォルト値:false
MBeanが動的に作成されたか、config.xmlに対して永続化されているかが返されます
- enabled(optional): boolean
デフォルト値:
false
このSNMPエージェントが有効化されているかどうかを指定します。
制約
- セキュア・デフォルト: false
- id(optional): integer(int64)
読取り専用:
true
このMBeanインスタンスの一意のIDを返します
- informEnabled(optional): boolean
デフォルト値:
false
通知をTRAPではなくINFORMとして送信するようにこのSNMPエージェントを構成します。エージェントのSNMPTrapVersionとしてSNMPv2またはSNMPv3を指定する必要があります。
エージェントはINFORM通知を送信すると、SNMPマネージャからの確認レスポンスを待機します。レスポンスを受信しない場合は、INFORM通知を再送信します。
- informRetryInterval(optional): integer(int32)
最小値:
3000
最大値:30000
デフォルト値:10000
このSNMPエージェントがINFORM通知のレスポンスを待機するミリ秒数。
指定された期間内にレスポンスを受信しない場合、エージェントは通知を再送信します。
- listenAddress(optional): string
UDPプロトコルを使用するSNMPマネージャからの受信リクエストをリスニングするためにこのSNMPエージェントが使用するリスニング・アドレス。
指定しない場合、サーバーのListenAddressがSNMPAgentのListenAddressとして使用されます。
- localizedKeyCacheInvalidationInterval(optional): integer(int64)
最大値:
86400000
デフォルト値:3600000
WebLogic ServerがSNMPセキュリティ・キーのキャッシュを無効にするまでのミリ秒数。大きな値を設定すると、資格証明を削除されたユーザーがSNMPデータに引き続きアクセス可能となるおそれが生じます。
SNMPセキュリティ・キーは、SNMPエージェントのエンジンIDと認証パスワードまたはプライバシ・パスワードを暗号化したものです。WebLogic Serverは、SNMP資格証明マップ内に作成された各エントリごとに1つのセキュリティ・キーを生成します。WebLogic Server SNMPエージェントはSNMPv3リクエストを受信すると、リクエストに含まれるキーとWebLogic Serverのキーを比較します。一致した場合はそのリクエストを処理します。また、SNMPエージェントはレスポンスや通知の中でこれらのキーをエンコードします。(トラップ通知を作成するときに、エンコードするキーを構成します。)
各SNMPv3ごとにキーを再生成するかわりに、WebLogic Serverはキーをキャッシュします。キャッシュに必ず最新のSNMP資格証明のセットが含まれるように、WebLogic Serverは定期的にキャッシュを無効にします。キャッシュが無効にされると、次にSNMPエージェントが資格をリクエストしたときに、WebLogic Serverはキャッシュを再生成します。
資格証明マップを変更した場合、キャッシュは自動的に更新されません。キャッシュが更新されるのは、無効化を経た場合のみです。
たとえば、SNMP資格証明マップ内の既存のエントリの秘密パスワードを更新した場合、SNMPエージェントは、キャッシュが無効になり再生成されるまで、新しいパスワードを認識しません。キャッシュが無効になるまでは、古いセキュリティ・パスワードを持つSNMPユーザーが引き続きWebLogic Serverのデータにアクセスできます。
この無効化間隔が経過するのを待機するかわりに、ただちにキーを無効にすることもできます。
- masterAgentXPort(optional): integer(int32)
最小値:
1
最大値:65535
デフォルト値:705
このSNMPエージェントがサブエージェントとの通信に使用するポート。
エージェントはサブエージェントを使用して、カスタムMBean (ユーザーが作成および登録するMBean)や他のソフトウェア・コンポーネントへのアクセスを提供します。WebLogic Server SNMPエージェントでは、ユーザーが独自のサブエージェントを登録することはできません。
- maxInformRetryCount(optional): integer(int32)
最小値:
1
最大値:3
デフォルト値:1
このSNMPエージェントがレスポンスを受信しなかったINFORM通知を再送信する最大回数。
- name(optional): string
読取り専用:
true
このMBeanインスタンスのユーザー定義の名前。
この名前は、MBeanの
javax.management.ObjectName
に、主要なプロパティとして含まれていますName=user-specified-name
制約
- 有効なnull
- notes(optional): string
この構成の説明として任意に入力できる情報。
WebLogic Serverは、ドメインの構成ファイル(
config.xml
)に、このノートをXML PCDATAとして保存します。すべての左山カッコ(<) are converted to the xml entity<)は、xmlエンティティに変換されます。キャリッジ・リターンとライン・フィードは維持されます。)>
ノート: 管理コンソールからノートを作成または編集した場合、キャリッジ・リターンとライン・フィードは維持されません。
- privacyProtocol(optional): string
デフォルト値:
AES_128
使用可能な値:[ "noPriv", "DES", "AES_128" ]
このSNMPエージェントがメッセージの暗号化および復号化に使用するプロトコル。SNMPv3の場合にのみ適用可能。認証プロトコルも使用する必要があります。
レスポンスまたは通知を送信するときにこのプロトコルを使用するには、トラップ通知のセキュリティ・レベルを構成する必要もあります。
プライバシ・プロトコルを選択しない場合、このエージェントとマネージャの間の通信は認可されていないユーザーから参照可能になります(ただし、変更はできません)。
制約
- 有効なnull
- sendAutomaticTrapsEnabled(optional): boolean
デフォルト値:
true
このSNMPエージェントが、自動生成された通知をSNMPマネージャに送信するかどうかを指定します。
SNMPエージェントは、次のいずれかのイベントが発生した場合に、自動通知を生成します。
SNMPエージェントをホストしているWebLogic Serverインスタンスが起動する。
このタイプの通知(coldStart)には変数バインドはありません。
サーバー・インスタンスが起動または停止する。
管理対象サーバー上のSNMPエージェントは、ホストの管理対象サーバーが起動または停止した場合にのみこの通知を生成します。管理サーバー上のSNMPエージェントは、ドメイン内のいずれかのサーバーが起動または停止した場合にこの通知を生成します。
これらのタイプの通知(serverStartとserverShutdown)には、起動または停止したサーバーと通知の生成時刻を特定する変数バインドが含まれています。
- SNMPAccessForUserMBeansEnabled(optional): boolean
ユーザーが作成および登録したMBeanタイプ(カスタムMBean)への読取り専用アクセスを提供するように、このSNMPエージェントを構成します。
このアクセスを有効にした場合、ユーザーがWebLogic Server MBeanServerでカスタムMBeanを登録すると、このSNMPエージェントは、WebLogic ServerがカスタムMBeanを保持している実行時MIBモジュールを動的に更新します。
各カスタムMBeanタイプについて、WebLogic ServerではMIBモジュールに表が追加されます。カスタムMBeanの各インスタンスごとに、表の行が追加されます。WebLogic ServerはMIBをファイルまたは他のデータ構造として永続化しませんが、MIB内のOIDはサーバー・セッション間で一定です。
カスタムMBeanのMIBモジュールはサブエージェントによって管理されます。マスター・エージェントはこのWebLogic Server SNMPエージェントであり、サブエージェントはAgentXポートを通じてマスター・エージェントと通信します。
- SNMPEngineId(optional): string
現在のWebLogic ServerドメインのすべてのSNMPエージェントにわたって一意な、このSNMPエージェントの識別子。
SNMPv3を使用してこのSNMPエージェントにメッセージを送信する場合は、SNMPマネージャを構成するときにSNMPエンジンIDを指定する必要があります。
管理サーバー上のSNMPエージェントの場合、デフォルト値はWebLogic Serverドメインの名前です。管理対象サーバー上のエージェントの場合、デフォルトはそのサーバーの名前です。
制約
- 有効なnull
- SNMPPort(optional): integer(int32)
最小値:
1
最大値:65535
デフォルト値:161
UDPプロトコルを使用するSNMPマネージャからの受信リクエストをリスニングするためにこのSNMPエージェントが使用するポート。
SNMPマネージャは、このポートを使用してSNMPエージェントをpingし、特定の属性のステータスをリクエストできます。
このSNMPエージェントを複数のサーバー・インスタンスにターゲット指定し、複数のサーバーが同じコンピュータ上で動作してる場合、WebLogic Serverは自動的に、このUDPポートの値をエージェントごとに1ずつ増やします。エージェントが通知の送信に使用するデフォルト・ポートであるため、ポート162は割り当てません。また、ポートがすでに使用中である場合、WebLogic Serverはそのポートをスキップして、使用可能な次のポートを割り当てます。
たとえば、この属性のデフォルト値を使用し、このエージェントをManagedServer1とManagedServer2に割り当てた場合に、両方のサーバーが同じコンピュータ上で動作しているとき、ManagedServer1上のエージェントはUDPポート161でリスニングし、ManagedServer2上のエージェントはUDPポート163でリスニングします。
値を増やされたポート番号はドメインの構成に永続化されません。WebLogic Serverがポート番号の値を増やす場合は、同じコンピュータ上でサーバーが起動された順序で、値の増加が行われます。
WebLogic Serverは、SNMPエージェントのUDPポートを再び割り当てる場合、エージェントのSNMPAgentRuntimeMBeanを調べて実行時のUDPポートを確認します。
SNMPエージェントは、ホスト・サーバーのTCPリスニング・ポート(デフォルトは7001)、またはカスタム・ネットワーク・チャネルで構成されているTCPポートを通じて通信できます。
- SNMPTrapVersion(optional): integer(int32)
デフォルト値:
3
使用可能な値:[ 1, 2, 3 ]
このSNMPエージェントが生成するSNMP通知のバージョン。
- tags(optional): array 項目
タイトル:
Items
この構成MBeanのすべてのタグを返します
- targets(optional): array ターゲット参照
タイトル:
Target References
ターゲット参照の配列が含まれます。現在のドメインでこの項目をデプロイできるターゲットのリストから、MBeanをデプロイするターゲットを選択する必要があります。ターゲットはサーバーまたはクラスタです。デプロイメントが重複している場合、デプロイメントは1回のみ行われます。
- type(optional): string
読取り専用:
true
MBeanのタイプを戻します。
制約
- 収集不可
array
Target References
現在のドメインでこの項目をデプロイできるターゲットのリストから、MBeanをデプロイするターゲットを選択する必要があります。ターゲットはサーバーまたはクラスタです。デプロイメントが重複している場合、デプロイメントは1回のみ行われます。
- 配列: object ターゲット参照
タイトル:
Target Reference
ターゲット参照が含まれます。
object
Target Reference
- identity(optional): array アイデンティティ
タイトル:
Identity
DOC TEAM TBD - アイデンティティの説明 - 別のWLS RESTリソースへの参照です。
array
Identity