機能説明
指定した運用プロセスを実行し、終了を待ち合わせます。指定した運用プロセスに渡すパラメーターの個数分、運用プロセスを最大16多重(デフォルト:1多重)で実行します。
例えば、パラメーターが10個、多重度に4を指定した場合は、最大4多重で10個の運用プロセスを実行します。
オプション
基本オプション
実行する運用プロセスの名前を指定します。
ここで指定する名前はSystemwalker Runbook Automationの管理サーバに登録した運用プロセスの名前を指定する必要があります。
指定した名前に対応する運用プロセスが存在しない場合は、引数エラーとなります。
なお、指定した運用プロセスが正常ルートを通って終了したか/エラールートを通って終了したかを判断するためには、正常時に到達するExitノードとエラー時に到達するExitノードを分けておく必要があります。
実行する運用プロセスに渡すパラメーターを指定します。
以下の形式で値を指定する必要があります。
タグ | 説明 | 備考 | ||
|---|---|---|---|---|
ParameterSet | 運用プロセスに渡すパラメーター全体の集合を現すタグ | 出現回数:1 | ||
Parameter | 1度の運用プロセス実行時に渡すパラメーターを表すタグ | 出現回数:1～128 | ||
属性名:ID 1からの連番でパラメーターの番号を記載してください。実行された運用プロセスのプロセスインスタンス名の末尾に、IDの値が付加されます。 | 出現:必須 | |||
属性名:ProcessInstanceID ここでは指定する必要はありません。(指定しても無視されます。) | 出現:オプション | |||
属性名:Result 運用プロセスの実行結果が格納されます。ここでは指定する必要はありません。(指定しても無視されます。) | 出現:オプション | |||
属性名:ExitNodeName 運用プロセスが到達したExitノードの名前が格納されます。ここでは指定する必要はありません。(指定しても無視されます。) | 出現:オプション | |||
TargetUDA | 実行する運用プロセス上のユーザ定義属性に対応するタグ | 出現回数:1以上 | ||
属性名:Name 実行する運用プロセス上のユーザ定義属性の名前を指定してください。 | 出現:必須 ※今版ではタイプがSTRINGのユーザ定義属性のみをサポートします。 | |||
属性名:Value 実行する運用プロセス上のユーザ定義属性に設定する値を指定してください。 | 出現:必須 | |||
例
<?xml version="1.0" encoding="UTF-8"?>
<ParameterSet>
<Parameter ID="1">
<TargetUDA Name="hostname" Value="serverA"/>
<TargetUDA Name="patchId" Value="T999999XX-99,T888888XX-88"/>
</Parameter>
<Parameter ID="2">
<TargetUDA Name="hostname" Value="serverB"/>
<TargetUDA Name="patchId" Value="T999999XX-99"/>
</Parameter>
・・・
<Parameter ID="N">
<TargetUDA Name="hostname" Value="serverZ"/>
<TargetUDA Name="patchId" Value="T999999XX-99"/>
</Parameter>
</ParameterSet> |
拡張オプション
運用プロセスの実行多重度を指定します。
1～16の範囲で指定が可能です。
実行多重度を省略した場合は、1を指定します。
運用操作部品の実行の完了待ち合わせ時間(秒)です。
300～86,400(1日)の範囲で指定が可能です。
(例) 完了待ち合わせを10分間行う場合：600
指定した時間を経過しても運用操作部品の実行が完了しない場合は、運用操作部品の処理を復帰値：201で中断します。
運用操作部品の実行の起動リトライ回数です。
運用操作部品が復帰値：161で終了した場合に、起動リトライを行う回数を指定します。0～5の範囲で指定が可能です。
起動リトライにより再実行した結果、運用操作部品が161以外の復帰値で終了した場合は、指定した起動リトライ回数に達していなくても運用操作部品の実行は終了します。運用操作部品の復帰値は最後に実行した値になります。
(例) 起動リトライを2回行う場合：2
運用操作部品のリトライ間隔(秒)です。
運用操作部品が復帰値：161で終了した場合に、起動リトライを行うまでの間隔を指定します。1～14400の範囲で指定が可能です。
(例) 300秒間隔でリトライを行う場合：300
timeout、retry、およびretry_intervalについて、指定を省略した場合や、範囲外の値を入力した場合は、運用操作部品実行定義ファイルで指定した値が有効になります。詳細は、“2.5 運用操作部品実行定義ファイル”を参照してください。
復帰値
アイコン | シンボル名 | 復帰値 | 意味 |
|---|---|---|---|
| 成功 | 0 | 処理が正常終了しました。 |
| 失敗 | 1～128 | Exitノードに到達せずに終了した運用プロセスの個数を返します。 |
197 | オプションの内容に誤りがありました。 | ||
200 | 処理が異常終了しました。 | ||
－ | － | 201 | 運用操作部品の実行がタイムアウトしました。 |
202 | 運用操作部品が実行されませんでした。 | ||
203 | 運用操作部品の実行が失敗しました。管理サーバの環境に問題があります。 | ||
205 | 運用操作部品が実行されませんでした。運用操作部品の入力情報の指定情報の指定に問題があります。 | ||
206 | 運用操作部品を正常に実行できませんでした。運用操作部品の出力情報の指定情報の指定に問題があります。 | ||
207 | 運用操作部品が実行されませんでした。運用操作部品が管理サーバに登録されていない可能性があります。 | ||
208 | 運用操作部品の実行途中に自動運用プロセスのリカバリが行われたため、自動運用プロセスを中止状態にしました。 |
出力情報
変数 | 意味 |
|---|---|
message | 複数の運用プロセスの実行に成功した場合、以下のメッセージを設定します。 The operation component was successful. 複数の運用プロセスの実行に失敗した場合、エラー内容を文字列として設定します。 |
plural_designation_result | 複数の運用プロセスの実行に成功した場合、実行結果をXML形式の文字列として設定します。詳細は下記をご参照ください。 |
non_arrival_number | 実行した運用プロセスの中で、Exitノードに到達せずに終了した運用プロセスの個数を設定します。 |
returnCode | 復帰値を設定します。 |
plural_designation_resultのフォーマット
以下のフォーマットで実行結果を出力します。
タグ | 説明 | 備考 | ||
|---|---|---|---|---|
ParameterSet | 運用プロセスに渡すパラメーター全体の集合を現すタグ | 出現回数:1 | ||
Parameter | 1度の運用プロセス実行時に渡すパラメーターを表すタグ | 出現回数:1以上 | ||
属性名:ID 運用プロセス実行前に入力された値が入ります。 | 出現:必須 | |||
属性名:ProcessInstanceID 実行された運用プロセスのプロセスインスタンスIDが格納されます。 | 出現:必須 | |||
属性名:Result 運用プロセスの実行結果が格納されます。運用プロセスがExitノードまで到達した場合は"SUCCESS"、エラーが発生した場合は"ERROR"、運用プロセスが中断された場合は"ABORTED"が格納されます。 | 出現:必須 | |||
属性名:ExitNodeName 運用プロセスが到達したExitノードの名前が格納されます。Exitノードに到達しなかった場合、値は設定されません。 | 出現:オプション | |||
TargetUDA | 実行する運用プロセス上のユーザ定義属性に対応するタグ | 出現回数:1以上 | ||
属性名:Name 運用プロセス実行前に入力された値が入ります。 | 出現:必須 | |||
属性名:Value 運用プロセス実行後に、Nameに対応するユーザ定義属性に格納されている値が入ります。 | 出現:必須 | |||
例
<?xml version="1.0" encoding="UTF-8"?>
<ParameterSet>
<Parameter ID="1" ProcessInstanceID="1010" Result="SUCCESS" ExitNodeName="Exit1">
<TargetUDA Name="hostname" Value="serverA"/>
<TargetUDA Name="patchId" Value="T888888XX-88"/>
</Parameter>
<Parameter ID="2" ProcessInstanceID="1020" Result="SUCCESS" ExitNodeName="Exit2">
<TargetUDA Name="hostname" Value="serverB"/>
<TargetUDA Name="patchId" Value="T999999XX-99"/>
</Parameter>
<Parameter ID="3" ProcessInstanceID="1030" Result="ERROR">
<TargetUDA Name="hostname" Value="serverC"/>
<TargetUDA Name="patchId" Value="T999999XX-99"/>
</Parameter>
・・・
<Parameter ID="N" ProcessInstanceID="1040" Result="ABORTED">
<TargetUDA Name="hostname" Value="serverZ"/>
<TargetUDA Name="patchId" Value="T999999XX-99"/>
</Parameter>
</ParameterSet>
|
注意事項
本運用操作部品で指定する運用プロセス(subflownameで指定する運用プロセス)は、本運用操作部品を含む運用プロセスと同一のプロセスグループ内に格納し、subflownameで指定する運用プロセスを公開した状態にする必要があります。
各オプションには、半角カナ文字および以下の記号は使用しないでください。半角カナ文字および以下の記号を使用すると、運用操作部品の実行に失敗する場合があります。
“～”、“￡”、“―”、“∥”、“￠”、“￢”、“￣”、“￥”、“〃”
復帰値の確認は、Webコンソールで行います。詳細については、“Systemwalker Runbook Automation 運用ガイド”の“運用操作部品の実行状況・実行結果を確認する”を参照してください。
201～208の復帰値が出力された場合は自動運用プロセスが中止状態またはエラー状態となり、以下の場所にエラーメッセージが出力されます。
管理サーバのイベントログ(管理サーバがWindows(R)の場合)
管理サーバのシスログ(管理サーバがLinuxの場合)
BPMNのカスタムメッセージ
上記いずれかの場所でメッセージを確認し、適切な対処を実施してください。メッセージの詳細については、“Systemwalker Runbook Automation メッセージ集”を参照してください。
本運用操作部品を処理中の自動運用プロセスを一時停止、または中止した場合、本運用操作部品から実行された運用プロセスは一時停止、または中止状態になりません。必要に応じて、本運用操作部品から実行された運用プロセスの一時停止操作、または中止操作を行ってください。
本運用操作部品を処理中の自動運用プロセスを一時停止した場合、本運用操作部品から実行された運用プロセスの一時停止を行ったときは、再開操作は以下の順序で実施する必要があります。
本運用操作部品から実行された運用プロセスを再開する。
本運用操作部品を処理中の自動運用プロセスを再開する。
