modifySIBDestination コマンド
サービス統合バスのバス宛先のプロパティーを変更するには、modifySIBDestination コマンドを使用します。
コマンドを実行するには、wsadmin スクリプト・クライアントの AdminTask オブジェクトを使用します。
wsadmin スクリプト・クライアントは Qshell から実行されます。.
詳しくは、wsadmin スクリプトを使用した WebSphere スクリプトを実行するための Qshell の構成.
サービス統合バスのコマンドには、コマンド行ヘルプが用意されています。
- Jython で使用可能なサービス統合バス・コマンドのリストと、各コマンドの簡単な説明を見るには、wsadmin プロンプトで以下のコマンドを入力します。
print AdminTask.help('SIBAdminCommands')
- 特定のコマンドの概要ヘルプの場合は、wsadmin プロンプトで以下のコマンドを入力します。
print AdminTask.help('command_name')
コマンドの使用後に、マスター構成に変更を保存します。次のコマンドを使用します。
AdminConfig.save()
目的
modifySIBDestination コマンドは、サービス統合バスのバス宛先のプロパティーを変更します。
ターゲット・オブジェクト
バス宛先。
必須パラメーター
- -bus
- バス宛先が構成されているサービス統合バスの名前です。listSIBuses コマンドを使用して、既存のバスの名前をリストすることができます。
- -name
- 管理目的でこの宛先を識別するための ID。
条件付きパラメーター
なし。
オプション・パラメーター
- -description
- 管理を目的とした、バス宛先の説明を指定します。
- -reliability
- プロデューサー・アプリケーションによって明示的な信頼性が設定されていない場合に、この宛先に生成されるメッセージに割り当てられるデフォルトの信頼性レベルを指定します。サービス統合は、5 つの信頼性レベル (「配信オプション」または「サービスの品質」とも呼ばれる) をサポートします。
- BEST_EFFORT_NONPERSISTENT
- メッセージング・エンジンで処理の停止または障害が起こった場合、メッセージは廃棄されます。メッセージの送信に使用されている接続が使用不可になった場合、 またはシステム・リソースに制約があった場合にも、メッセージは廃棄される可能性があります。
- EXPRESS_NONPERSISTENT
- メッセージング・エンジンで処理の停止または障害が起こった場合、メッセージは廃棄されます。メッセージの送信に使用されている接続が使用不可になった 場合にも、メッセージは廃棄される可能性があります。
- RELIABLE_NONPERSISTENT
- メッセージング・エンジンで処理の停止または障害が起こった場合、メッセージは廃棄されます。
- RELIABLE_PERSISTENT
- メッセージング・エンジンで障害が起こった場合、メッセージは廃棄される可能性があります。
- ASSURED_PERSISTENT
- メッセージは廃棄されません。
注: 信頼性のレベルが高いほど、パフォーマンスに与える影響は大きくなります。サービス統合の信頼性レベルについて詳しくは 、メッセージの信頼性レベル - JMS デリバリー・モードとサービス統合のサービスの品質を参照してください。
- -overrideOfQOSByProducerAllowed TRUE | FALSE
- プロデューサーと宛先の間のメッセージ・フローのサービスの品質を制御します。宛先に対して定義されている品質の代わりに、 プロデューサーが指定したサービスの品質を使用する場合は、このオプションを選択してください。
- -defaultPriority number
- -maxFailedDeliveries number
- 0から 2147483647 までの範囲で値を指定します。 値 0 (ゼロ) に設定すると、メッセージが最初の志向で配信できなかった場合、-exceptionDestination パラメーターによる定義に従って、例外宛先に転送されるか、または廃棄されます。
- -exceptionDestination value
- デフォルトでは、この宛先に配信できないメッセージはすべて、
この宛先が割り当てられているメッセージング・エンジンのシステム・デフォルトの例外宛先 (_SYSTEM.Exception.Destination.messaging_engine_name) に転送されます。このパラメーターを使用して、デフォルト値をオーバーライドします。この宛先に特定の例外宛先を設定するか、または空ストリング ("") を入力することによって配信不能メッセージが例外宛先に転送されないように指定することができます。後者の場合には最大デリバリー失敗数は影響しません。 注: 配信不能メッセージは、同じ宛先への配信を待っている他のメッセージの処理をブロックします。
- このオプションを使用して例外宛先を指定しないと、メッセージの順序を保持することができます。
- -sendAllowed TRUE | FALSE
- プロデューサーがこの宛先にメッセージを送信できないようにする場合は、このオプションをクリアします (FALSE に設定します)。
- 仲介されていない宛先のキュー・ポイント、または仲介された宛先のメディエーション・ ポイントの場合、このオプションをクリアすると (接続されたプロデューサーの、または別の宛先から転送された) 新規メッセージは使用可能なメッセージ・ポイントにリダイレクトされます。 使用可能なメッセージ・ポイントがない場合、このバス上で既に受け入れられたメッセージ、および接続されたプロデューサーからの新規メッセージは、メッセージ・ポイントが使用可能になるまで、バスによって保持されます。これに対する例外は、プロデューサーが同じメッセージング・エンジンに接続されるメッセージ・ポイント (宛先が仲介されているか否かに応じてキュー・ポイントまたはメディエーション・ポイント) を 1 つだけ持つ宛先の場合のみです。 この場合、例外メッセージは各送信呼び出し上で生成されます。この例外メッセージは、唯一の現存するローカリゼーションが送信用に使用不可であることを示しています。 プロデューサーは通常どおりオープンされたままで、送信先の「送信許可」プロパティーが再選択 (TRUE にリセット) されている場合には、送信呼び出しが引き続き正常に行われます。
- 仲介されている宛先のキュー・ポイントの場合、このオプションをクリアするとメディエーション・インスタンスからのメッセージは、使用可能なメッセージ・ポイントにリダイレクトされます。使用可能なメッセージ・ポイントがない場合、メッセージは、メッセージ・ポイントが使用可能になるまでバスによって保持されます。メディエーション・インスタンス (つまり、メディエーション・ポイントを持つサーバー上にあるもの) については、同じサーバーがキュー・ポイントをホストし、そのキュー・ポイントがその宛先の唯一のキュー・ポイントである場合、そのメディエーションは「stopped on error」状態に変わります。
- -receiveAllowed TRUE | FALSE
- メッセージ・ポイントの場合、このオプションをクリアするとオープン・コンシューマーの状態が変わり、コンシューマーがメッセージを要求すると、例外が生成されます。メッセージは引き続き送信することができ、メッセージ・ポイント上で集計されます。
- -receiveExclusive TRUE | FALSE
- 1 つの宛先に 1 つのコンシューマーだけが接続できるようにするには、このオプションを選択します (TRUE に設定する)。このプロパティーを選択した場合、一度にキュー宛先の各キュー・ポイントに接続できるのは、単一のコンシューマーのみになります。 既にコンシューマーが接続されたキュー・ポイントに接続しようとする以降のコンシューマーは拒否されます。
- -maintainStrictMessageOrder TRUE | FALSE
- プロデューサーが宛先に送信するメッセージの順序を維持するには、このオプションを選択します (TRUE に設定する)。
- 実行時には、このプロパティーが他の構成プロパティー値よりも優先されます。実行時にオーバーライドされる構成プロパティーについては、バス宛先の厳密なメッセージの順序付けを参照してください。注: 厳密なメッセージ順序が既存のトピック宛先で使用可能になっている場合、既存の永続サブスクリプションと関連する メッセージが無効になります。厳密なメッセージ順序が使用可能であり、環境が再始動されると、既存の永続サブスクリプションが削除され、再作成されます。永続サブスクリプションに関連付けられているメッセージも削除されます。
- -topicAccessCheckRequired
- トピックへのアクセスに許可検査が必要な場合には、このオプションを含めます。
- -replyDestination
- このプロパティーは、応答メッセージについてのメディエーションでの使用を意図しています。このプロパティーの使用について詳しくは、宛先逆作業工程パスの構成を参照してください。
- -replyDestinationBus
- 応答宛先が構成されているバスの名前。このプロパティーは、応答メッセージ上のメディエーションでの使用を意図しています。このプロパティーの使用について詳しくは、宛先逆作業工程パスの構成を参照してください。
- -delegateAuthorizationCheckToTarget
- ターゲット宛先に対して許可検査を実行する場合は、このオプションを含めます。
- -auditAllowed TRUE | FALSE
- バスおよびアプリケーション・サーバーが監査を有効にしている場合に、バスがトピック・レベルでの許可検査の監査を行わないようにするには、このオプションをクリアします (FALSE に設定する)。デフォルト値は TRUE です。このパラメーターを使用するには、監査管理者の権限が必要です。宛先のその他のタイプの作成で使用する場合、このパラメーターは無視されます。
- -defaultForwardRoutingPath
- メッセージに転送ルーティング・パスが含まれていない場合に、メッセージの転送ルーティング・パスが設定される値。この値は、メッセージがターゲットのバス宛先に到達するまでに通過する必要のある中間のバス宛先の順次リストを識別します。フィールドのフォーマットは、bus_name:destination_name という形で指定されたバス宛先のリストです。
- -queuePoints
- 別名宛先の使用者によって使用されるキュー・ポイントのリスト。
特定のキュー・ポイントが指定されていない場合、すべてのキュー・ポイントを使用できます。
ターゲット宛先は、別名宛先の定義と同じバスのキュー宛先である必要があります。
また、ターゲット宛先は、複数のキュー・ポイントを持つキュー宛先である必要もあります。
キュー・ポイントは、以下の形式 destination_name@messaging_engine_name で指定します。
- -useAllQueuePoints TRUE | FALSE
- このオプションを TRUE に設定した場合、すべての使用可能なキュー・ポイントが使用されます。 このオプションを FALSE に設定した場合には、-queuePoints オプションで指定されたリストにあるキュー・ポイントのみが使用されます。
- -mediationPoints
- 別名宛先の使用者によって使用されるメディエーション・ポイントのリスト。
特定のメディエーション・ポイントが指定されていない場合、すべてのメディエーション・ポイントを使用できます。
ターゲット宛先は、別名宛先の定義と同じバスの仲介されたキュー宛先である必要があります。
また、ターゲット宛先は、複数のメディエーション・ポイントを持つキュー宛先である必要もあります。
メディエーション・ポイントは、以下の形式 destination_name@messaging_engine_name で指定します。
- -useAllMediationPoints TRUE | FALSE
- このオプションを TRUE に設定した場合、すべての使用可能なキュー・ポイントが使用されます。 このオプションを FALSE に設定した場合には、-mediationPoints オプションで指定されたリストにあるキュー・ポイントのみが使用されます。
- -persistRedeliveryCount TRUE | FALSE
- このオプションは、メッセージ・ストア内の JMS メッセージの失敗したデリバリー・カウントを保持する場合に選択します (TRUE に設定します)。このオプションの値は、デフォルトでは、FALSE に設定されています。重要: このプロパティーは、選択されても、 WebSphere® Application Server バージョン 9.0 以降の sibDBUpgrade コマンドを使用してデータベース・テーブルがアップグレードされるまで有効になりません。
例
- Jython の使用:
wsadmin>AdminTask.showSIBDestination(["-bus", "abus", "-name", "myqueue"]) "{receiveExclusive=false, defaultForwardRoutingPath=[], defaultPriority=0, exceptionDestination=_SYSTEM.Exception.Destination.node01.aserver-abus, uuid=97CC75AC71E5932CAB3417AC, overrideOfQOSByProducerAllowed=true, sendAllowed=true, maxFailedDeliveries=5, maxReliability=ASSURED_PERSISTENT, reliability=ASSURED_PERSISTENT, receiveAllowed=true, identifier=myqueue}" wsadmin>AdminTask.modifySIBDestination(["-bus", "abus", "-name", "myqueue", "-receiveAllowed", "FALSE"]) wsadmin>AdminTask.showSIBDestination(["-bus", "abus", "-name", "myqueue"]) "{receiveExclusive=false, defaultForwardRoutingPath=[], defaultPriority=0, exceptionDestination=_SYSTEM.Exception.Destination.node01.aserver-abus, uuid=97CC75AC71E5932CAB3417AC, overrideOfQOSByProducerAllowed=true, sendAllowed=true, maxFailedDeliveries=5, maxReliability=ASSURED_PERSISTENT, reliability=ASSURED_PERSISTENT, receiveAllowed=false, identifier=myqueue}"
- Jacl を使用:
wsadmin>$AdminTask showSIBDestination {-bus abus -name myqueue} {receiveExclusive=false, defaultForwardRoutingPath=[], defaultPriority=0, exceptionDestination=_SYSTEM.Exception.Destination.node01.aserver-abus, uuid=97CC75AC71E5932CAB3417AC, overrideOfQOSByProducerAllowed=true, sendAllowed=true, maxFailedDeliveries=5, maxReliability=ASSURED_PERSISTENT, reliability=ASSURED_PERSISTENT, receiveAllowed=true, identifier=myqueue} wsadmin>$AdminTask modifySIBDestination {-bus abus -name myqueue -receiveAllowed FALSE} (cells/9994GKCCell01/buses/abus|sib-destinations.xml#SIBQueue_1098215169998) wsadmin>$AdminTask showSIBDestination {-bus abus -name myqueue} {receiveExclusive=false, defaultForwardRoutingPath=[], defaultPriority=0, exceptionDestination=_SYSTEM.Exception.Destination.node01.aserver-abus, uuid=97CC75AC71E5932CAB3417AC, overrideOfQOSByProducerAllowed=true, sendAllowed=true, maxFailedDeliveries=5, maxReliability=ASSURED_PERSISTENT, reliability=ASSURED_PERSISTENT, receiveAllowed=false, identifier=myqueue}
例: 使用可能なキュー・ポイントおよびメディエーション・ポイントのサブセットを使用するように、別名宛先「MyAlias2」を変更する
- Jython の使用:
cluster=AdminConfig.list("ServerCluster").splitlines()[0] Qp1=AdminConfig.list("SIBQueueLocalizationPoint" , cluster).splitlines()[0] Mp1=AdminConfig.list("SIBMediationLocalizationPoint").splitlines()[0] AdminTask.modifySIBDestination(["-bus" , "bus1" , "-name" , "MyAlias2", "-queuePoints", [[Qp1]], "-mediationPoints" , [[Mp1]]])
- Jacl を使用:
set cluster [ lindex [ $AdminConfig list ServerCluster ] 1 ] set Qp1 [ lindex [ $AdminConfig list SIBQueueLocalizationPoint $cluster ] 0 ] set Mp1 [ lindex [ $AdminConfig list SIBMediationLocalizationPoint ] 0 ] $AdminTask modifySIBDestination {-bus bus1 -name MyAlias2 -queuePoints [[$Qp1]]-mediationPoints [[$Mp1]]}
例: 使用されるキュー・ポイントの制限をすべて除去するように別名宛先を変更する
- Jython の使用:
AdminTask.modifySIBDestination(["-bus" , "bus1" , "-name" , "MyAlias2", "-queuePoints", [[]]])
- Jacl を使用:
$AdminTask modifySIBDestination {-bus bus1 -name MyAlias2 -useAllQueuePoints=true -useAllMediationPoints=true}