ネストされたスキーマ : SNMPエージェント・デプロイメント
型: object
ソースの表示
- authenticationProtocol(optional): string
デフォルト値: MD5
使用可能な値: [ "noAuth", "MD5", "SHA" ]
認可されたユーザーのみがWebLogic Serverドメインに関する情報をリクエストまたは受信できるように、このSNMPエージェントで使用するプロトコル。SNMPv3の場合にのみ適用可能。
このプロトコルでは、メッセージの整合性を保証して、なりすましやメッセージの並べ替え、遅延、リプレイなどを防ぎます。
SNMPマネージャからリクエストを受信するときにこのプロトコルを使用するには、WebLogic Serverセキュリティ・レルムで資格証明マッピングを構成する必要があります。レスポンスまたは通知を送信するときにこのプロトコルを使用するには、トラップ通知のセキュリティ・レベルを構成する必要があります。
認証プロトコルを選択しない場合、SNMPエージェントは受信するSNMPv3リクエストを認証しないので、誰でもSNMPv3を使用してWebLogic Serverドメインの情報を取得できるようになります。
制約
- deploymentOrder(optional): integer(int32)
最小値: 0
最大値: 2147483647
デフォルト値: 1000
デプロイの優先度。サーバーはこの値を使用して項目のデプロイ順を決定します。優先度は、同じタイプでデプロイ可能なアイテム間で決められます。
たとえば、サーバーではすべてのEJBを優先度に従ってデプロイしてから、起動クラスを優先度に従ってデプロイします。
「デプロイ順序」の値が小さい項目から順にデプロイされます。「デプロイ順序」の値が等しいデプロイメントの順序付けは保証されていません。クラスタ間の順序付けは保証されていません。
- dynamicallyCreated(optional): boolean
読取り専用: true
デフォルト値: false
MBeanが動的に作成されたか、config.xmlに対して永続化されているかが返されます
- enabled(optional): boolean
デフォルト値: false
このSNMPエージェントが有効化されているかどうかを指定します。
制約
- id(optional): integer(int64)
- informEnabled(optional): boolean
- informRetryInterval(optional): integer(int32)
- 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)
- name(optional): string
読取り専用: true
このMBeanインスタンスのユーザー定義の名前。
この名前は、MBeanのjavax.management.ObjectName
に、主要なプロパティとして含まれています
Name=user-specified-name
制約
- 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の場合にのみ適用可能。認証プロトコルも使用する必要があります。
レスポンスまたは通知を送信するときにこのプロトコルを使用するには、トラップ通知のセキュリティ・レベルを構成する必要もあります。
プライバシ・プロトコルを選択しない場合、このエージェントとマネージャの間の通信は認可されていないユーザーから参照可能になります(ただし、変更はできません)。
制約
- 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ドメインの名前です。管理対象サーバー上のエージェントの場合、デフォルトはそのサーバーの名前です。
制約
- 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 項目
- targets(optional): array ターゲット参照
タイトル: Target References
ターゲット参照の配列が含まれます。
現在のドメインでこの項目をデプロイできるターゲットのリストから、MBeanをデプロイするターゲットを選択する必要があります。ターゲットはサーバーまたはクラスタです。デプロイメントが重複している場合、デプロイメントは1回のみ行われます。
- type(optional): string
{
"type":"object",
"properties":{
"SNMPAccessForUserMBeansEnabled":{
"type":"boolean",
"description":"<p>Configures this SNMP agent to provide read-only access to MBean types that you have created and registered (custom MBeans).</p><p>If you enable this access, when you register a custom MBean in a WebLogic Server MBeanServer, this SNMP agent dynamically updates a runtime MIB module that WebLogic Server maintains for custom MBeans. </p><p>For each custom MBean type, WebLogic Server adds a table to the MIB module. For each instance of the custom MBean, it adds a table row. While WebLogic Server does not persist the MIB as a file or other data structure, the OIDs in the MIB remain constant across server sessions.</p><p>The MIB module for custom MBeans is managed by a subAgent. Its master agent is this WebLogic Server SNMP agent and it communicates with the master agent through the AgentX port.</p>"
},
"SNMPEngineId":{
"x-weblogic-legalNull":true,
"type":"string",
"description":"<p>An identifier for this SNMP agent that is unique amongst all other SNMP agents in the current WebLogic Server domain.</p><p>If you use SNMPv3 to send messages to this SNMP agent, you must specify the SNMP engine ID when you configure the SNMP manager.</p><p>For an SNMP agent on an Administration Server, the default value is the name of the WebLogic Server domain. For an agent on a Managed Server, the default is the name of the server.</p><p><h5>Constraints</h5></p><ul><li>legal null</li></ul>"
},
"SNMPPort":{
"default":161,
"minimum":1,
"maximum":65535,
"type":"integer",
"format":"int32",
"description":"<p>The port on which you want this SNMP agent to listen for incoming requests from SNMP managers that use the UDP protocol.</p><p>SNMP managers can use this port to ping the SNMP agent and request the status of specific attributes.</p><p>If you target this SNMP agent to multiple server instances, and if two or more servers are running on the same computer, WebLogic Server will automatically increment this UDP port value by 1 for each agent. WebLogic Server never assigns port 162 because it is the default port that an agent uses to send notifications. In addition, if any port is already in use, WebLogic Server skips the port and assigns the next available port.</p><p>For example, if you use the default value of this attribute and then target this agent to ManagedServer1 and ManagedServer2, and if both servers are running on the same computer, then the agent on ManagedServer1 will listen on UDP port 161 and the agent on ManagedServer2 will listen on UDP port 163.</p><p>The incremented port number is not persisted in the domain's configuration; when WebLogic Server increments port numbers, it does so in the order in which servers are started on the same computer.</p><p>If WebLogic Server re-assigns the UDP port for an SNMP agent, look in the agent's SNMPAgentRuntimeMBean to see the agent's runtime UDP port.</p><p>SNMP agents can also communicate through the host server's TCP listen port (7001 by default) or through a TCP port that is configured by a custom network channel.</p>"
},
"SNMPTrapVersion":{
"default":3,
"enum":[
1,
2,
3
],
"type":"integer",
"format":"int32",
"description":"<p>The SNMP notification version that this SNMP agent generates.</p>"
},
"authenticationProtocol":{
"default":"MD5",
"enum":[
"noAuth",
"MD5",
"SHA"
],
"x-weblogic-legalNull":true,
"type":"string",
"description":"<p>The protocol that this SNMP agent uses to ensure that only authorized users can request or receive information about your WebLogic Server domain. Applicable only with SNMPv3.</p><p>The protocol also ensures message integrity and prevents masquerading and reordered, delayed, or replayed messages.</p><p>To use this protocol when receiving requests from SNMP managers, you must configure credential mapping in the WebLogic Server security realm. To use this protocol when sending responses or notifications, you must configure the security level of your trap destinations.</p><p>If you do not choose an authentication protocol, then the SNMP agent does not authenticate incoming SNMPv3 requests; anyone can use SNMPv3 to retrieve information about your WebLogic Server domain.</p><p><h5>Constraints</h5></p><ul><li>legal null</li></ul>"
},
"deploymentOrder":{
"default":1000,
"minimum":0,
"maximum":2147483647,
"type":"integer",
"format":"int32",
"description":"<p>A priority that the server uses to determine when it deploys an item. The priority is relative to other deployable items of the same type.</p><p>For example, the server prioritizes and deploys all EJBs before it prioritizes and deploys startup classes.</p><p>Items with the lowest Deployment Order value are deployed first. There is no guarantee on the order of deployments with equal Deployment Order values. There is no guarantee of ordering across clusters.</p>"
},
"dynamicallyCreated":{
"readOnly":true,
"default":false,
"type":"boolean",
"description":"<p>Return whether the MBean was created dynamically or is persisted to config.xml</p>"
},
"enabled":{
"x-weblogic-secureDefault":false,
"default":false,
"type":"boolean",
"description":"<p>Specifies whether this SNMP agent is enabled.</p><p><h5>Constraints</h5></p><ul><li>secure default : false</li></ul>"
},
"id":{
"readOnly":true,
"type":"integer",
"format":"int64",
"description":"<p>Return the unique id of this MBean instance</p>"
},
"informEnabled":{
"default":false,
"type":"boolean",
"description":"<p>Configures this SNMP agent to send notifications as an INFORM instead of a TRAP. Requires you to specify the agent's SNMPTrapVersion as SNMPv2 or SNMPv3.</p><p>When an agent sends an INFORM notification, it waits for a confirmation response from the SNMP manager. If it does not receive a response, it resends the INFORM notification.</p>"
},
"informRetryInterval":{
"default":10000,
"minimum":3000,
"maximum":30000,
"type":"integer",
"format":"int32",
"description":"<p>The number of milliseconds that this SNMP agent will wait for a response to an INFORM notification.</p><p>If the agent does not receive a response within the specified interval, it will resend the notification.</p>"
},
"listenAddress":{
"type":"string",
"description":"<p>The listen address on which you want this SNMP agent to listen for incoming requests from SNMP managers that use the UDP protocol.</p><p>If not specified the Server's ListenAddress is used as the ListenAddress for the SNMPAgent.</p>"
},
"localizedKeyCacheInvalidationInterval":{
"default":3600000,
"maximum":86400000,
"type":"integer",
"format":"int64",
"description":"<p>The number of milliseconds after which WebLogic Server invalidates its cache of SNMP security keys. Setting a high value creates a risk that users whose credentials have been removed can still access SNMP data.</p><p>An SNMP security key is an encrypted version of an SNMP agent's engine ID and an authentication password or privacy password. WebLogic Server generates one security key for each entry that you create in the SNMP credential map. When a WebLogic Server SNMP agent receives an SNMPv3 request, it compares the key that is in the request with its WebLogic Server keys. If it finds a match, it processes the request. The SNMP agent also encodes these keys in its responses and notifications. (You configure which keys are encoded when you create a trap destination.)</p><p>Instead of regenerating the keys for each SNMPv3 communication, WebLogic Server caches the keys. To make sure that the cache contains the latest set of SNMP credentials, WebLogic Server periodically invalidates the cache. After the cache is invalidated, the next time an SNMP agent requests credentials, WebLogic Server regenerates the cache.</p><p>Note that making a change to the credential map does not automatically update the cache. Instead, the cache is updated only after it has been invalidated.</p><p>For example, if you update a privacy password in an existing entry in the SNMP credential map, the SNMP agent is not aware of the new password until the key cache is invalidated and regenerated. An SNMP user with the old security password can still access WebLogic Server data until the cache is invalidated.</p><p>You can invalidate a key immediately instead of waiting for this invalidation interval to expire. </p>"
},
"masterAgentXPort":{
"default":705,
"minimum":1,
"maximum":65535,
"type":"integer",
"format":"int32",
"description":"<p>The port that this SNMP agent uses to communicate with its subagents.</p><p>The agent uses subagents to provide access to custom MBeans (MBeans that you create and register) and to other software components. WebLogic Server SNMP agents do not enable users to register their own subagents.</p>"
},
"maxInformRetryCount":{
"default":1,
"minimum":1,
"maximum":3,
"type":"integer",
"format":"int32",
"description":"<p>The maximum number of times that this SNMP agent will resend INFORM notifications for which it has not received a response.</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>"
},
"privacyProtocol":{
"default":"AES_128",
"enum":[
"noPriv",
"DES",
"AES_128"
],
"x-weblogic-legalNull":true,
"type":"string",
"description":"<p>The protocol that this SNMP agent uses to encrypt and unencrypt messages. Applicable only with SNMPv3. Requires you to also use an authentication protocol.</p><p>To use this protocol when sending responses or notifications, you must also configure the security level of your trap destinations.</p><p>If you do not choose a privacy protocol, then communication between this agent and managers can be viewed (but not altered) by unauthorized users.</p><p><h5>Constraints</h5></p><ul><li>legal null</li></ul>"
},
"sendAutomaticTrapsEnabled":{
"default":true,
"type":"boolean",
"description":"<p>Specifies whether this SNMP agent sends automatically generated notifications to SNMP managers.</p><p>The SNMP agent generates automatic notifications when any of the following events occur:</p><ul><li><p>The WebLogic Server instance that is hosting the SNMP agent starts.</p><p>This type of notification (coldStart) has no variable bindings.</p></li><li><p>A server instance starts or stops.</p><p>An SNMP agent on a Managed Server generates these notifications only when its host Managed Server starts or stops. An SNMP agent on an Administration Server generates these notifications when any server in the domain starts or stops.</p><p>These notification types (serverStart and serverShutdown) contain variable bindings to identify the server that started or stopped and the time at which the notification was generated.</p></li></ul>"
},
"tags":{
"title":"Items",
"type":"array",
"items":{
"type":"string",
"description":""
},
"description":"<p>Return all tags on this Configuration MBean</p>"
},
"targets":{
"title":"Target References",
"type":"array",
"items":{
"title":"Target 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 target reference."
},
"description":"Contains the array of target references. <p>You must select a target on which an MBean will be deployed from this list of the targets in the current domain on which this item can be deployed. Targets must be either servers or clusters. The deployment will only occur once if deployments overlap.</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":""
}