mqsiapplybaroverride コマンド

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

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

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

目的

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

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

構文

パラメーター

-b バーファイル

(必須) オーバーライド値を適用する BAR ファイル (圧縮フォーマット) へのパス。パスは絶対パスか、実行可能コマンドに対する相対パスとします。

-k applicationName

(オプション) オーバーライド値を適用する BAR ファイル内のアプリケーションの名前。

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

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

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

-m (M) マヌアルオーバーリデス

(オプション) 以下のリストproperty-name=overrideペアcurrent-property-value=overrideまたはそれらの組み合わせが BAR ファイルに適用されます。リスト内のペアは、コンマ (,) で区切ります。 Windows の場合では、リストを引用符 ("") で囲む必要があります。 overridesFile ( P-) パラメーターと一緒に使用すると、manualOverrides (-m (M)) パラメーターによって指定されたオーバーライドは、 P- パラメーターによって指定されたオーバーライドが行われた後に実行されます。

- 出力ファイル

(オプション) BAR ファイルへの変更が行われる際の出力先 BAR ファイルの名前。出力ファイルが指定されない場合は、入力ファイルが上書きされます。

P- オーバーライド・ファイル

(オプション) 以下のいずれかのリソースへのパス。

BAR ファイルへのオーバーライドを適用するために使用されるデプロイメント記述子が入っている BAR ファイル。
デプロイメント記述子ファイルに対しては、XML を使用できます。 z/OS上で EBCDIC で作成された XML プロパティー・ファイルを使用する場合は、必ず削除してください。encoding="UTF-8"XML ヘッダーから。例えば、次のように変更します。
```
<?xml version="1.0" encoding="UTF-8"?>
```
終了
```
<?xml version="1.0"?>
```
各行に以下が含まれているプロパティー・ファイルproperty-name=overrideORcurrent-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 (V) トレース・ファイル名

(オプション) 指名されたファイルに内部トレースが送信されることを指定します。

-y ライブラリー名

(オプション) オーバーライドを適用する 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 (K) パラメーターを使用して、更新するアプリケーションの名前を指定します。

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

注: BAR ファイルにアプリケーションおよびライブラリーが含まれている場合は、 -k (K)、 -y (Y) 、または - パラメーターを使用して、適用されるオーバーライドの有効範囲を定義します。これらのパラメーターが指定されなかった場合は、アプリケーションまたはライブラリーで構成可能プロパティーが更新されません。アプリケーションまたはライブラリーに含まれていないリソースの構成可能プロパティーのみが更新され、そのようなリソースが存在しない場合は、更新が行われません。

mqsiapplybaroverride コマンドを実行すると、他のことを行う前に、使用されているコマンドのバージョン (ランタイム環境または IBM® Integration Toolkitのいずれか) が表示されます。以下に例を示します。

BIP1138I: Overriding BAR File using runtime mqsiapplybaroverride

許可

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

応答

このコマンドは、以下の応答を戻します。

0: コマンドが正常に完了しました。
99: 指定した 1 つ以上のパラメーターが無効です。

このコマンドはバッチ・ファイルとして指定されています。自動化システムまたはスクリプトからコマンドを実行する場合は、 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

メッセージ・フロー最大速度を設定します。これにより、合計入力メッセージ比率が 1 秒当たり 100 メッセージを超えると、処理遅延が発生します。

mqsiapplybaroverride -b c:\test.bar -m sampleFlow#maximumRateMsgsPerSec=100

メッセージ・フロー通知しきい値を設定します。これにより、1 秒当たりの入力メッセージの合計比率がメッセージ数 150 を超えると、レポートが生成されます。

mqsiapplybaroverride -b c:\test.bar -m sampleFlow#notificationMsgsPerSec=150

以下のように、プロパティー・ファイルを使用して、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 にオーバーライドします。
メッセージ・フロー サンプル・フロー.msgflowで、 sampleSubflow1 (sampleSubflow1).サブフローを表すサブフロー・ノードに設定されているプロモートされたプロパティーキュー名の値をクリアします。
サブフロー 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

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