WebSphere Message Broker バージョン 8.0.0.5 オペレーティング・システム: AIX、HP-Itanium、Linux、Solaris、Windows、z/OS

製品の最新バージョンについては、IBM Integration Bus バージョン 9.0 をご覧ください。

mqsiapplybaroverride コマンド

mqsiapplybaroverride コマンドを使用して、ブローカー・アーカイブ (BAR) デプロイメント記述子の構成可能値を、プロパティー・ファイルで指定した新しい値に置き換えます。

サポートされるオペレーティング・システム

  • Windows
  • Linux および UNIX システム
  • z/OS®. BIPOBAR をカスタマイズして実行依頼することにより、このコマンドを実行します。

目的

mqsireadbar コマンドは、mqsiapplybaroverride コマンドで構成できるプロパティーを確認するために使用します。

mqsiapplybaroverride コマンドと mqsicreatebar コマンドを併用することにより、BAR ファイルを作成するスクリプトを記述したり、ブローカー・デプロイメント記述子アーカイブ・ファイルに異なるオーバーライド値を適用したりすることができます。 メッセージ・フロー・ノード・プロパティーのリストと、それに対応する mqsiapplybaroverride コマンド・プロパティーについては、構成可能プロパティーを参照してください。 mqsiapplybaroverride コマンドのプロパティーについては、影響を受ける各ノードの参照トピックにあるプロパティー表にもリストされています。

構文

構文図を読む構文図をスキップする
>>-mqsiapplybaroverride-- -b --BarFile-------------------------->

>--+-----------------------+--+-----------------------+--------->
   '- -k --applicationName-'  '- -m --manualOverrides-'   

>--+------------------+--+---------------------+--+------+------>
   '- -o --outputFile-'  '- -p --overridesFile-'  '- -r -'   

>--+---------------------+--+-------------------+--------------><
   '- -v --traceFileName-'  '- -y --libraryName-'   

パラメーター

-b BarFile
(必須) オーバーライド値を適用する BAR ファイル (圧縮フォーマット) へのパス。 パスは絶対パスか、実行可能コマンドに対する相対パスとします。
-k applicationName
(オプション) オーバーライド値を適用する BAR ファイル内のアプリケーションの名前。

このパラメーターと –p (オーバーライド・ファイル) および –m (手動オーバーライド) パラメーターを一緒に使用して、BAR ファイルの特定のアプリケーションでオーバーライドのターゲットを指定できます。 –p パラメーターで指定したオーバーライド・ファイルが BAR ファイルの場合、–k パラメーターを設定すると、アプリケーションの .appzip ファイルがソースおよびターゲット BAR ファイルに配置されます。 両方の場所で .appzip ファイルが見つかった場合、アプリケーションのデプロイメント記述子は、ソース BAR ファイルに基づいて更新されます。 同様に、–p パラメーターで指定したオーバーライド・ファイルがデプロイメント記述子の場合、–k パラメーターを設定すると、アプリケーションのデプロイメント記述子が更新されます。 –m パラメーターと –k パラメーターを両方設定すると、指定のアプリケーションに手動オーバーライドが適用されます。

アプリケーション内の特定のライブラリーにオーバーライドを適用するには、–k パラメーターと –y (ライブラリー名) パラメーターを併用します。

アプリケーションのデプロイメント記述子とそのアプリケーションにネストされたすべてのライブラリーにオーバーライドを適用するには、–k パラメーターと –r パラメーターを同時に使用します。

-m manualOverrides
(オプション) BAR ファイルに適用される、property-name=override の対、current-property-value=override の対、またはそれらの組み合わせのリスト。 リスト内の各対はコンマ (,) で区切ります。 Windows では、リストを引用符 (" ") で囲む必要があります。 overridesFile (–p) パラメーターと併用する場合、–p パラメーターで指定されたすべてのオーバーライドが行われた後に、manualOverrides (–m) パラメーターで指定されたオーバーライドが実行されます。
-o outputFile
(オプション) BAR ファイルへの変更が行われる際の出力先 BAR ファイルの名前。 出力ファイルが指定されない場合は、入力ファイルが上書きされます。
-p overridesFile
(オプション) 以下のいずれかのリソースへのパス。
  • BAR ファイルへのオーバーライドを適用するために使用されるデプロイメント記述子が入っている BAR ファイル。
    デプロイメント記述子ファイルに対しては、XML を使用できます。 EBCDIC で記述されている XML プロパティー・ファイルを z/OS で使用する場合は、XML ヘッダーから encoding="UTF-8" を削除するようにしてください。変更例として、例えば以下のような記述があるとします。
    <?xml version="1.0" encoding="UTF-8"?>
    その場合は、以下のように変更します。
    <?xml version="1.0"?>
  • 各行に property-name=override または current-property-value=new-property-value の対が入っているプロパティー・ファイル。
  • BAR ファイルへのオーバーライドを適用するために使用されるデプロイメント記述子。
-p パラメーターで指定したファイルが、アプリケーションまたはライブラリーを含む BAR ファイルの場合、デフォルトでは、ソース BAR ファイルのデプロイメント記述子のみがターゲット BAR ファイルに適用されます。 ソース BAR ファイルとターゲット BAR ファイルの両方にあるアプリケーションおよびライブラリーのデプロイメント記述子をコピーするには、-k-y、および -r パラメーターを使用できます。
  • ソース BAR ファイルにあり、ターゲット BAR ファイルにも存在するすべてのデプロイメント記述子をコピーするには、再帰的 (-r) パラメーターを使用できます。
  • アプリケーション (-k) およびライブラリー (-y) パラメーターを使用して、異なる開始点からコピーを開始できます。
  • 再帰的 (-r) パラメーターを指定しないで -k パラメーターまたは -y パラメーターを使用すると、アプリケーションのデプロイメント記述子のみ、またはライブラリーのデプロイメント記述子のみがコピーされます。
  • 再帰的パラメーターを指定して -k パラメーターを使用する場合、アプリケーションとそのすべてのライブラリー・デプロイメント記述子がコピー対象であると見なされます。
  • アプリケーション (-k) またはライブラリー (-y) パラメーターを使用する場合、指定されたアプリケーションまたはライブラリーのスコープ外部には、デプロイメント記述子はコピーされません。 例えば、BAR ファイル・デプロイメント記述子は、ターゲット BAR ファイルには転送されません。
-r
(オプション) ネストされたアプリケーション内のデプロイメント記述子ファイル (.appzip ファイル)、およびネストされたライブラリー内のデプロイメント記述子ファイル (.libzip ファイル) を含め、すべてのデプロイメント記述子ファイルを再帰的に更新するように指定します。

-r パラメーターの開始点は、BAR ファイルまたはアプリケーションに設定できます。 -r および -k (アプリケーション名) パラメーターを設定すると、指定のアプリケーションとそのアプリケーションにネストされたすべてのライブラリーのデプロイメント記述子が更新されます。 -r および -y (ライブラリー名) パラメーターを設定した場合、ライブラリーにアプリケーションまたはライブラリーがネストされることはないため、-r パラメーターには何も効果がありません。 したがって、デプロイメント記述子はそのライブラリーについてのみ更新されます。 -k-y のいずれのパラメーターも設定しないで -r パラメーターを指定すると、BAR ファイルに含まれるすべてのアプリケーションおよびライブラリー内のデプロイメント記述子が更新されます。

-v traceFileName
(オプション) 指名されたファイルに内部トレースが送信されることを指定します。
-y libraryName
(オプション) オーバーライドを適用する BAR ファイルにあるライブラリーの名前。

このパラメーターと –p (オーバーライド・ファイル) および –m (手動オーバーライド) パラメーターを一緒に使用して、BAR ファイルの特定のライブラリーでオーバーライドのターゲットを指定できます。 –p パラメーターで指定したオーバーライド・ファイルが BAR ファイルの場合、–y パラメーターを設定すると、ライブラリーの .libzip ファイルがソースおよびターゲット BAR ファイルに配置されます。 両方の場所で .libzip ファイルが見つかった場合、ライブラリーのデプロイメント記述子は、ソース BAR ファイルに基づいて更新されます。 同様に、–p パラメーターで指定したオーバーライド・ファイルがデプロイメント記述子の場合、–y パラメーターを設定すると、ライブラリーのデプロイメント記述子が更新されます。 –m パラメーターと –y パラメーターを両方設定すると、指定のライブラリーに手動オーバーライドが適用されます。

アプリケーション内の特定のライブラリーにオーバーライドを適用するには、–y パラメーターと –k (アプリケーション名) パラメーターを併用します。

すべてのケースで、BAR ファイル内の既存のデプロイメント記述子は META-INF¥broker.xml.old に名前変更され、その名前の既存ファイルがあれば置き換えられます。

–p オーバーライド・ファイルまたは –m オーバーライド・リストに指定される各オーバーライドは、以下の構文のいずれかに準拠する必要があります。
  • FlowName#NodeName.PropertyName=NewPropertyValue (または、「メッセージ・フロー」プロパティーの場合は FlowName#PropertyName=NewPropertyValue)。ここで、
    • FlowName はメッセージ・フローの名前です。.msgflow 拡張子または .cmf 拡張子は付けません (例: Flow1)。
    • NodeName は、プロパティーがオーバーライドされるノードのオプション名です (例: InputNode)。
    • PropertyName は、オーバーライドされるプロパティーの名前です (例: queueName)。
    • NewPropertyValue は、そのプロパティーに割り当てる値です (例: PRODUCTION_QUEUE_NAME)。
  • OldPropertyValue=NewPropertyValue。 この構文によって、プロパティー値 OldPropertyValue に対して一括検索と置換が行われます。 デプロイメント記述子内の OldPropertyValue の値フィールドは、NewPropertyValue でオーバーライドされます。
  • FlowName#NodeName.PropertyName (または、「メッセージ・フロー」プロパティーの場合は FlowName#PropertyName)。 この構文によって、指定された名前のプロパティーに適用されたすべてのオーバーライドが取り除かれます。
  • applicationPropertyName=propertyValue。 メッセージ・フローの構成可能プロパティーは flowName および nodeName で修飾されますが、それとは異なり、アプリケーションの構成可能プロパティーはアプリケーション名で修飾されません。 アプリケーション・プロパティーをオーバーライドするには、この構文を使用し、更新するアプリケーションを -k パラメーターで指名します。

プロパティー・ファイルでは、変数およびコメントは許可されません。

注: BAR ファイルにアプリケーションとライブラリーが含まれている場合は、-k-y、または -r パラメーターを使用して、適用する指定変更の有効範囲を定義します。これらのパラメーターが指定されなかった場合は、アプリケーションまたはライブラリーで構成可能プロパティーが更新されません。アプリケーションまたはライブラリーに含まれていないリソースの構成可能プロパティーのみが更新され、そのようなリソースが存在しない場合は、更新が行われません。
mqsiapplybaroverride コマンドの実行時には、他の事柄を行う前に、 使用中のコマンドのバージョン (ランタイム環境またはWebSphere® Message Broker Toolkit) をまず表示します。 以下に例を示します。
BIP1138I: Overriding BAR File using runtime mqsiapplybaroverride

許可

Windows 7 および Windows Server 2008 システムでは、このコマンドを実行するためのユーザー ID は、以下のようにローカル・システム上で高位の特権が付与されて実行される必要があります。
  • ユーザー ID は、管理者グループのメンバーでなければなりません。
  • このコマンドは、「管理者として実行」権限がある環境から開始する必要があります。

特権が付与された環境からコマンドを実行しないと、継続するかどうかの確認が表示されます。 「OK」をクリックすると、新しく特権を付与されたコマンド・コンソールが作成されてコマンドが完了しますが、この特権が付与された環境にすべての応答が書き込まれ、コマンドが完了してコンソールが閉じるとすべての応答は失われます。

すべてのオペレーティング・システムで、このコマンドを呼び出すのに使用するユーザー ID には、ローカル・システム上の BAR ファイルに書き込む権限がなければなりません。

応答

このコマンドは、以下の応答を戻します。
0
コマンドが正常に完了しました。
99
指定した 1 つ以上のパラメーターが無効です。
Windows platformこのコマンドはバッチ・ファイルとして指定されています。 コマンドを自動化システムで、またはスクリプトから実行している場合、次のように Windows CALL コマンドを使用して、正しい ERRORLEVEL が戻されるかを確認してください。
...
CALL mqsiapplybaroverride
...

-k、-y、または -r パラメーターを指定しない例では、アプリケーションまたはライブラリーでないリソースのデプロイメント記述子に対してのみ、構成可能プロパティーの更新が実行されます。このような場合は、アプリケーションまたはライブラリーに含まれているリソースは更新されません。

BAR ファイル myflow.bar を開き、そのデプロイメント記述子 (通常は broker.xml) の構成可能値を、プロパティー・ファイル mychanges.properties で指定した値に置き換えます。
mqsiapplybaroverride -b myflow.bar -p mychanges.properties 
BAR ファイル myflow.bar の値を、BAR ファイル myOriginalBarFile.bar の値でオーバーライドします。
mqsiapplybaroverride -b myflow.bar -p myOriginalBarFile.bar
アプリケーション application1 とその参照ライブラリーのデプロイ記述子を、BAR ファイル myOriginalBarFile.bar に基づいて更新します。
mqsiapplybaroverride -b myflow.bar -k application1 -p myOriginalBarFile.bar -r
アプリケーション application1 に含まれるライブラリー library1 のデプロイメント記述子を更新します。
mqsiapplybaroverride -b myflow.bar -k application1 -y library1 -p myOtherBroker.xml
アプリケーション application1 の開始モードを更新します。
mqsiapplybaroverride -b myApp.bar -k application1 -m startMode=automatic -o myAppManual.bar
c:¥my.properties で指定された key=value の対を使用して、c:¥test.bar の中のデプロイメント記述子をオーバーライドします。
mqsiapplybaroverride -b c:¥test.bar -p c:¥my.properties 
c:¥previous.bar に含まれるデプロイメント記述子を使用して、c:¥test.bar の中のデプロイメント記述子をオーバーライドします。
mqsiapplybaroverride –b c:¥test.bar –p c:¥previous.bar  
c:¥broker.xml に含まれるデプロイメント記述子を使用して、c:¥test.bar の中のデプロイメント記述子をオーバーライドします。
mqsiapplybaroverride –b c:¥test.bar –p c:¥broker.xml  
c:¥test.bar の中で値が OLDA および OLDB に設定されたすべてのプロパティーを、値 NEWA および NEWB にオーバーライドします。
mqsiapplybaroverride –b c:\test.bar –m OLDA=NEWA,OLDB=NEWB  
プロパティー名 sampleFlow#MQInput.queueName の値を NEWC にオーバーライドします。
mqsiapplybaroverride –b c:\test.bar –m sampleFlow#MQInput.queueName=NEWC  
以下のように、プロパティー・ファイルを使用して、sampleFlow#MQInput.queueName プロパティーの値を NEWC にオーバーライドします。また、値が OLDA および OLDB に設定されているすべてのプロパティーを NEWA および NEWB にオーバーライドします。
mqsiapplybaroverride –b c:\test.bar –p c:\mynew.properties
ファイル mynew.properties には次の行が含まれます。
sampleFlow#MQInput.queueName=NEWC
OLDA=NEWA
OLDB=NEWB
次の例では、BAR ファイル test.bar にメッセージ・フロー・ファイル sampleFlow.msgflow が格納されています。 このメッセージ・フローにはサブフロー sampleSubflow1.subflow が格納され、サブフロー sampleSubflow1.subflow にはサブフロー sampleSubflow2.subflow が格納されます。 プロパティー・ファイルを使用して以下のプロパティーをオーバーライドします。
  • メッセージ・フロー sampleFlow.msgflow で、ノード MQ Input 上の入力キューを NEW_INPUT_QUEUE にオーバーライドします。
  • メッセージ・フロー sampleFlow.msgflow で、sampleSubflow1.subflow を表すサブフロー・ノード上で設定された、プロモートされたプロパティー queueName の値をクリアします。
  • サブフロー sampleSubflow1.subflow で、フロー・レベルのプロモートされたプロパティー queueName の値をクリアします。
  • すべてのメッセージ・フローおよびサブフローで、値が SUBOUT に設定されていたプロパティーがあればその値を NEWSUBOUT にオーバーライドします。
mqsiapplybaroverride –b c:\test.bar –p c:\override.properties
ファイル override.properties には次の行が含まれます。
sampleFlow#MQ Input.queueName=NEW_INPUT_QUEUE
sampleFlow#sampleSubflow1.queueName
sampleSubflow1#queueName
SUBOUT=NEW_SUBOUT

プロパティー・ファイルに含まれている詳細情報の例については、構成可能プロパティーの編集を参照してください。

特記事項 | 商標 | ダウンロード | ライブラリー | サポート | フィードバック

Copyright IBM Corporation 1999, 2014Copyright IBM Corporation 1999, 2014.

        
        最終更新:
        
        最終更新: 2015-02-28 17:47:44


参照トピック参照トピック | バージョン 8.0.0.5 | an19545_