jobctl

共通

概要

ジョブの実行制御を行うjavaコマンドです。

パス

${BS_HOME}/bin

権限

本コマンドを実行するには、アカウントに以下のいずれかのロールが必要です。

書式
jobctl <サブコマンド> <接続オプション> <コマンドオプション>
サブコマンド
サブコマンド一覧
サブコマンド名 説明
start ジョブを開始します。
stop ジョブを停止します。
result ジョブの結果を取得します。
status ジョブの状態を取得します。
list-status ジョブの状態の一覧を取得します。
version Batch Serverのバージョン情報を標準出力に出力します。
help 本コマンドのhelpを標準出力に出力します。
接続オプション

WebOTX Batch Serverのコマンドは、バッチドメインエージェントを経由して各バッチコンテナへ指示を行います。
そのため、WebOTX Batch Serverが提供する主なコマンドはバッチドメインエージェントへの接続オプションの指定が必要です。

{--user <user> --password <password> [--host <host>] [--port <port>]}
接続オプション
オプション名 説明
--user <user> バッチドメインエージェントに接続するアカウント名を指定します。
バッチドメインエージェントが稼働しているサーバ上のOSユーザのアカウント名を指定します。
--password <password> アカウントのパスワードを指定します。
バッチドメインエージェントが稼働しているサーバ上のOSユーザのパスワードを指定します。
--host <host> 接続先のバッチドメインエージェントのIPアドレス、または、ホスト名を指定します。
ドメインセットアップ時に ${BS_HOME}/<domainName>.properties 中の domain.admin.host に指定したIPアドレス、または、ホスト名を指定します。
オプション未指定時に使用される既定値はlocalhostです。
--port <port> 接続先のバッチドメインエージェントのポート番号(既定値:6312)を指定します。
ドメインセットアップ時に ${BS_HOME}/<domainName>.properties 中の domain.admin.port に指定したポート番号を指定します。
オプション未指定時に使用される既定値は6312です。
コマンドオプション

各サブコマンドの コマンドオプション を参照してください。

戻り値
コマンド共通戻り値一覧
戻り値 説明
0 正常終了
200 ジョブリクエストキューイングエラー
キューがあふれたためジョブリクエストの投入に失敗
201 指定したジョブがデプロイされていない
202 指定したジョブが実行されていない(JobRepositoryが初期化された場合を含む)
210 ジョブの開始エラー
指定したジョブのコンテナ上での開始に失敗
211 ジョブの開始要求が取り消された
230 指定したコンテナが存在していない
231 利用可能なコンテナが存在していない
240 コマンドとバッチドメインエージェントとの通信でエラー
241 バッチドメインエージェントとコンテナ間での通信エラー
242 JobRepositoryからの状態取得エラー
243 環境上の問題(設定ミス等)によるエラー
244 認証エラー
指定したアカウントの認証に失敗
245 権限エラー
指定したアカウントに当該操作を行う権限が割り当てられていない
250 コマンドエラー (コマンド解析エラー)
255 異常終了。コマンド実行エラー
実行例
${BS_HOME}\bin\> jobctl.cmd <サブコマンド> <接続オプション> <コマンドオプション>
[root@localhost bin]# jobctl.sh <サブコマンド> <接続オプション> <コマンドオプション>
関連

start

概要

ジョブを開始します。
ジョブを開始させるために必ずジョブ名(--jobname)を指定します。
バッチアプリケーション名(--batchap)が指定されない場合、既定値の default が暗黙的に指定されます。
バッチアプリケーショングループ名(--batchapgroup)が指定されない場合、既定値の default が暗黙的に指定されます。

ジョブ再実行(--restart指定)時には、アカウント名、ジョブ名、ジョブパラメータから、ジョブ再実行の際にやり直す必要がある前回のジョブ実行を特定します。
ジョブの実行を特定する為に使用するジョブパラメータには、--parametersfileオプションで指定したファイルに含まれる全てのプロパティ、コマンド引数のjobParameters、および、--reqidオプションの値が含まれます。
ジョブを再実行する(--restartを指定する)際は、ジョブ実行を開始した際と同一のジョブパラメータを指定してください。
ジョブの開始(start)時に--reqidオプションを指定している場合は、ジョブの再実行時にも--reqidを指定して再実行を行ってください。
また、ジョブ再実行時にはジョブを再開する方法(--type)を選択することができます。

権限

本コマンドを実行するには、アカウントに以下のいずれかのロールが必要です。

書式

常駐モード

jobctl start <接続オプション> <コマンドオプション>
コマンドオプション

開始

{--jobname <jobname> [--batchap <batchap>] [--batchapgroup <batchapgroup>]
 [--reqid <reqid>] [--exitcodemapping <exitcodeMappingFile>] [--silent]
 [--alerttime <alerttime>] [--priority <priority>] 
 [--parametersfile <parametersFile>] [jobParameters] | --help}

再実行

{--restart [--type {JOB | STEP | CHECKPOINT}]
 --jobname <jobname> [--batchap <batchap>] [--batchapgroup <batchapgroup>]
 [--reqid <reqid>] [--exitcodemapping <exitcodeMappingFile>] [--silent]
 [--parametersfile <parametersFile>] [jobParameters] | --help}
コマンドオプション一覧
オプション名 説明
--jobname <jobName> ジョブ名を指定します。
--priority <priority> 複数のジョブがキューにある場合に、実行するジョブを決める際の優先度を指定するオプションです。
1から5の数値で指定し、1が最も高く、5が最も低い優先度となります。
--alerttime <alerttime> ジョブが終了しない場合の警告時間を指定します。WebOTX Batch Serverではジョブの実行状態を監視し、このオプションによって指定された時間までにジョブの実行が完了しない場合に、OSのログに警告メッセージを出力します。
時間の指定は以下のように時刻形式と時間形式で行えます。
  • 時刻形式での指定
  • --alertitme yyyy-mm-ddThh:mm:ss
    yyyy : 西暦
    mm   : 月
    dd   : 日
    hh   : 時間(0 - 23)
    mm   : 分(0 - 59)
    ss   : 秒(0 - 59)								
    				
    				
    (例)2011/4/1の12:30:00を指定する場合
    --alerttime 2011-04-01T12:30:00
    				

  • 時間形式での指定
  • --alerttime <値>{h|m|s}
    h : 時間
    m : 分
    s : 秒
    
    
    (例)1.5時間を指定する場合
    --alerttime 90m
    				

--batchap <batchapName> バッチアプリケーション名を指定します。
指定を省略した場合は、既定値のバッチアプリケーション名 default が指定されます。
--batchapgroup <batchapGroupName> バッチアプリケーショングループ名を指定します。
指定を省略した場合は、既定値のバッチアプリケーショングループ名 default が指定されます。
--reqid <reqId> ジョブのリクエストIDを指定します。
リクエストIDには一意な値を指定する必要があります。
異なるジョブの実行において、同一のリクエストIDを指定すると、reqidのみの指定によるstatusコマンドやresultコマンドが利用できません。
--exitcodemapping <filePath> 戻り値定義ファイル名を含むファイルの絶対パスを指定します。
このオプションを指定した場合は、指定された戻り値定義ファイルの設定を利用して、コマンドの戻り値を決定します。
このオプションを指定しない場合は、${DOMAIN_HOME}/config/batch/exitcode/mapping.properties の設定に基づき、コマンドの戻り値を決定します。
--silent ジョブ実行ログを標準出力に表示しません。
--restart 前回実行時に異常終了したジョブの再実行を指示します
--type JOB | STEP | CHECKPOINT ジョブの再開ポイントを指定します。
JOB:ジョブの初めから処理をやり直します。
STEP:中断したステップの初めから処理をやり直します。
CHECKPOINT:チェックポイントから処理をやり直します。
再実行時に本オプションを省略した場合、CHECKPOINT指定での再実行を行います。
--parametersFile <filePath> ジョブパラメータファイル名を含むファイルの絶対パスを指定します。
ジョブパラメータファイルとは、ジョブのパラメータをkey=valueのプロパティファイル形式で記述したファイルです。
同一ファイル内に重複するkeyが指定された場合、後の行に記載されている値が優先されます。
<jobParameters>と重複するkeyがプロパティファイル内で指定された場合、<jobParameters>で指定された値が優先されます。
<jobParameters> ジョブパラメータをkey=valudeのプロパティ形式をコマンド引数として指定します。複数のパラメータを指定する場合、 (半角空白)区切りで指定します。
<jobParameters>内で重複するkeyが指定された場合、初めに記載された値が優先されます。
--parametersFileに指定したジョブパラメータファイルに含まれるkeyと重複するkeyが指定された場合、<jobParameters>で指定された値が優先されます。
再実行時に指定したパラメータは前回実行時に指定したパラメータに追加・上書きされます。
--domain <domainName> バッチドメインエージェント名を指定します。
${BS_HOME}/domains/<domainName>下の定義を利用してジョブを実行します。
指定を省略した場合は、既定値のバッチドメインエージェント名 batchDomain1 が指定されます。
非常駐モードで指定可能なオプションです
--domainHome <domainHome> バッチドメインエージェントのホームディレクトリの絶対パスを直接指定します。
指定を省略した場合は、既定値のバッチドメインエージェントのホームディレクトリ ${BS_HOME}/domains/batchDomain1 が指定されます。
非常駐モードで指定可能なオプションです
--container <containerName> コンテナ名を指定します。
${DOMAIN_HOME}/containers/<containerName> に格納されているコンテナの設定に従って初期化します。
指定を省略した場合は、既定値のコンテナ名 container1 が指定されます。
非常駐モードで指定可能なオプションです
--help コマンドのヘルプを表示します。
restartオプションに関する補足

再実行処理では、コマンドで指定したパラメータ情報を基に前回実行したジョブの情報を取得し、前回の実行状態(Status)を確認し、正常な停止状態であると判断した場合のみ再実行処理を行います。ジョブの開始コマンドは、--restartオプションの有無により下記のような動作となります。

restartオプションの指定有無と動作
--restart指定 実行対象ジョブの前回実行状態 処理
あり 未実行 ジョブの先頭から処理を開始
処理中 実行中メッセージを出力し、処理を行わず終了
再実行可能状態で処理が停止状態 typeオプションによるリスタート処理
再実行不可状態で処理が停止状態 リスタート可能な実行状態でない旨のメッセージを出力し、処理を行わず終了
処理が完了 実行済みメッセージを出力し、処理を行わず終了
なし 未実行 ジョブの先頭から処理を開始(通常のジョブ実行処理)
処理中 実行中メッセージを出力し、処理を行わず終了
再実行可能状態で処理が停止状態 チェックポイントから処理を再実行
再実行不可状態で処理が停止状態 リスタート可能な実行状態でない旨のメッセージを出力し、処理を行わず終了
処理が完了 実行済みメッセージを出力し、処理を行わず終了
戻り値

コマンド共通の戻り値については、コマンド共通戻り値を参照してください
コマンド共通の戻り値は、ExitCodeマッピング機能では変更できません。

下表の戻り値は、jobctlコマンドのstart , result、および、start-jobコマンド、result-jobコマンド特有の戻り値です。これらのコマンドの戻り値は、ExitStatus との対応関係によって決まります。これらの戻り値は、戻り値定義ファイル の設定により変更可能です。
戻り値 と ExitStatus との対応関係については、ExitCodeMapping機能 を参照してください。
ジョブのExitStatusとBatchStatusの組み合わせ条件と、戻り値との詳細な対応関係は、機能ガイドの「2. ジョブの開始」-「2.4. 戻り値」 を参照してください。

戻り値一覧
戻り値 ExitStatus(BatchStatus) 説明
0 COMPLETED ジョブが正常に終了した
1 FAILED(FAILED以外) その他エラー
102 COMPLETED_WITH_SKIPS ジョブが正常に終了したが、一部処理をスキップ
106 STOPPED 停止
107 FAILED(FAILED) 異常終了
108 NOOP 停止 (何も処理を実行していない)
109 UNKNOWN 不明な状態 (内部状態の保存に失敗等)
実行例
例1:jobParameters, reqidを指定してジョブを開始します。
[root@localhost bin]# jobctl.sh start --user user --password pass --batchapgroup default --batchap default --jobname hello --reqid 1-5 jobParam1=value1 jobParam2=value2

2010/03/16 01:59:15 393  INFO  main AbstractJobControlCommand - [BS240341001] コマンドの処理を開始します。
2010/03/16 01:59:15 600  INFO  main StartJobCommand - [BS240341002] ジョブの開始を要求しています。
2010/03/16 01:59:15 653  INFO  main StartJobCommand - [BS240341004] ジョブが開始されるのを待機します。
2010/03/16 01:59:15 829  INFO  main StartJobCommand - [BS240341005] ジョブが開始されたことを検知しました。
2010/03/16 01:59:15 830  INFO  main StartJobCommand - [BS240341006] DomainName = batchDomain1, ContainerName = container1-1, JobInstanceId = 125, JobExecutionId = 125
2010/03/16 01:59:15 830  INFO  main StartJobCommand - [BS240341008] ジョブ実行ログを表示します :-

<ジョブ実行時のログが表示されます>

2010/03/16 03:45:07 837  INFO  main StartJobCommand - [BS240341009] ジョブが終了しました。 status = COMPLETED :-

Exit Code = 0
関連

stop

概要

ジョブを停止します。
ジョブを停止させる場合は、トランザクショナル停止モードと、強制停止モードを指定することができます。
トランザクショナル停止モードとは、実行中の処理をコミット(またはロールバック)したタイミングでジョブを停止させます。
一方、強制停止モードの場合は、仕掛かり中のトランザクションの状態によらず処理を中断し、トランザクションはロールバックしてジョブを停止させます。
ジョブ開始コマンドにリクエストID(--reqid)を指定している場合は、リクエストID指定でジョブを停止させることができます。
リクエストIDを利用しない場合は、ジョブ開始コマンド同様、ジョブ名とジョブパラメータの組合せによって停止させるジョブの実行を特定します。

権限

本コマンドを実行するには、アカウントに以下のいずれかのロールが必要です。

書式
jobctl stop <接続オプション> <コマンドオプション>
コマンドオプション
{[--transactional | --force] [--timeout <timeout>]
 --jobname <jobname> [--batchap <batchap>] [--batchapgroup <batchapgroup>]
 [--reqid <reqid>]
 [--parameterfile <parameterFile>] [jobParameters] | --help}
{[--transactional | --force] [--timeout <timeout>]
 --reqid <reqid> | --help}
コマンドオプション一覧
オプション名 説明
--jobname <jobName> ジョブ名を指定します。
--batchap <batchapName> バッチアプリケーション名を指定します。
指定を省略した場合は、既定値のバッチアプリケーション名 default が指定されます。
--batchapgroup <batchapGroupName> バッチアプリケーショングループ名を指定します。
指定を省略した場合は、既定値のバッチアプリケーショングループ名 default が指定されます。
--reqid <reqId> ジョブのリクエストIDを指定します。
リクエストIDには一意な値を指定する必要があります。
異なるジョブの実行において、同一のリクエストIDを指定すると異常終了します。
--transactional トランザクショナル停止モードを指定します。(デフォルト)
--force 強制停止モードを指定します。強制停止モードが有効になるためには、強制停止しようとするジョブのジョブ定義に強制停止リスナ(BSForceStopListenerまたはBSForceStopDetectionListener)が組み込まれている必要があります。 強制停止リスナを介した強制停止要求チェックのタイミング以外では、停止されません。
--timeout 停止タイムアウト秒 を指定します。
既定値は、 0 (無限)です。
--parametersFile <filePath> ジョブパラメータファイル名を含むファイルの絶対パスを指定します。
ジョブパラメータファイルとは、ジョブのパラメータをkey=valueのプロパティファイル形式で記述したファイルです。
同一ファイル内に重複するkeyが指定された場合、後の行に記載されている値が優先されます。
<jobParameters>と重複するkeyがプロパティファイル内で指定された場合、<jobParameters>で指定された値が優先されます。
<jobParameters> ジョブパラメータをkey=valudeのプロパティ形式をコマンド引数として指定します。複数のパラメータを指定する場合、 (半角空白)区切りで指定します。
<jobParameters>内で重複するkeyが指定された場合、初めに記載された値が優先されます。
--parametersFileに指定したジョブパラメータファイルに含まれるkeyと重複するkeyが指定された場合、<jobParameters>で指定された値が優先されます。
再実行時に指定したパラメータは前回実行時に指定したパラメータに追加・上書きされます。
--help コマンドのヘルプを表示します。
戻り値

コマンド共通の戻り値については、コマンド共通戻り値を参照してください。

実行例
例1:ジョブ名を指定してジョブを停止します。

<停止処理の実行画面>
[root@hestia bin]# ./jobctl.sh stop --user user --password pass  --batchapgroup default --batchap default --jobname hello --reqid 1-5 jobParam1=value1 jobParam2=value2 --transactional

2010/03/20 16:28:50 825  INFO  main AbstractJobControlCommand - [BS240341001] コマンドの処理を開始します。
Exit Code = 0
<停止処理が行われたジョブの実行画面>
[root@hestia bin]# ./jobctl.sh start --user user --password pass  --batchapgroup default --batchap default --jobname hello --reqid 1-5 jobParam1=value1 jobParam2=value2

2010/03/19 17:24:45 200  INFO  main AbstractJobControlCommand - [BS240341001] コマンドの処理を開始します。
2010/03/19 17:24:45 411  INFO  main StartJobCommand - [BS240341002] ジョブの開始を要求しています。
2010/03/19 17:24:45 482  INFO  main StartJobCommand - [BS240341004] ジョブが開始されるのを待機します。
2010/03/19 17:24:46 133  INFO  main StartJobCommand - [BS240341005] ジョブが開始されたことを検知しました。
2010/03/19 17:24:46 134  INFO  main StartJobCommand - [BS240341006] DomainName = batchDomain1, ContainerName = container1-1, JobInstanceId = 22, JobExecutionId = 22
2010/03/19 17:24:46 134  INFO  main StartJobCommand - [BS240341008] ジョブ実行ログを表示します :-

  〜snip〜

2010/03/20 16:28:52 422 ERROR WorkManager-2 ThreadStepInterruptionPolicy - Step interrupted
2010/03/20 16:28:52 424 ERROR WorkManager-2 AbstractStep - Encountered an error executing the step
org.springframework.batch.core.JobInterruptedException: Job interrupted status detected.
        at org.springframework.batch.core.step.ThreadStepInterruptionPolicy.checkInterrupted(ThreadStepInterruptionPolicy.java:44)

  〜snip〜

2010/03/20 16:28:53 173  INFO  main StartJobCommand - [BS240341009] ジョブが終了しました。 status = STOPPED :-

com.nec.webotx.batch.core.execution.RuntimeJobStatus$UserException : original Exception is org.springframework.batch.core.JobInterruptedException : Job interrupted by step execution
original stack trace is :-
Exit Code = 106
関連

result

概要

ジョブの結果を取得します。
startコマンドで指定したオプションと同一のアカウント名、ジョブ名、ジョブパラメータを指定して、そのジョブの実行結果(コマンドの戻り値とジョブ実行ログ)を取得します。
ジョブを投入する事を除けば、startコマンドと同様の動作を行います。
ジョブが開始されていない場合、ジョブが開始されることを待機します。
指定されたジョブをバッチドメインエージェントが受け付けていない場合はエラーとなります。

権限

本コマンドを実行するには、アカウントに以下のいずれかのロールが必要です。

書式
jobctl result <接続オプション> <コマンドオプション>
コマンドオプション
{--jobname <jobname> [--batchap <batchap>] [--batchapgroup <batchapgroup>] [--reqid <reqid>]
 [--exitcodemapping <exitcodeMappingFile>] [--silent]
 [--parametersfile <parametersFile>] [jobParameters] | --help}
{--reqid <reqid> [--exitcodemapping <exitcodeMappingFile>] [--silent] | --help}
コマンドオプション一覧
オプション名 説明
--jobname <jobName> ジョブ名を指定します。
--batchap <batchapName> バッチアプリケーション名を指定します。
指定を省略した場合は、既定値のバッチアプリケーション名 default が指定されます。
--batchapgroup <batchapGroupName> バッチアプリケーショングループ名を指定します。
指定を省略した場合は、既定値のバッチアプリケーショングループ名 default が指定されます。
--reqid <reqId> ジョブのリクエストIDを指定します。
リクエストIDには一意な値を指定する必要があります。
異なるジョブの実行において、同一のリクエストIDを指定すると異常終了します。
--exitcodemapping <filePath> 戻り値定義ファイル名を含むファイルの絶対パスを指定します。
このオプションを指定した場合は、指定された戻り値定義ファイルの設定を利用して、コマンドの戻り値を決定します。
このオプションを指定しない場合は、${DOMAIN_HOME}/config/batch/exitcode/mapping.properties の設定に基づき、コマンドの戻り値を決定します。
--silent ジョブ実行ログを標準出力に表示しません。
--parametersFile <filePath> ジョブパラメータファイル名を含むファイルの絶対パスを指定します。
ジョブパラメータファイルとは、ジョブのパラメータをkey=valueのプロパティファイル形式で記述したファイルです。
同一ファイル内に重複するkeyが指定された場合、後の行に記載されている値が優先されます。
<jobParameters>と重複するkeyがプロパティファイル内で指定された場合、<jobParameters>で指定された値が優先されます。
<jobParameters> ジョブパラメータをkey=valudeのプロパティ形式をコマンド引数として指定します。複数のパラメータを指定する場合、 (半角空白)区切りで指定します。
<jobParameters>内で重複するkeyが指定された場合、初めに記載された値が優先されます。
--parametersFileに指定したジョブパラメータファイルに含まれるkeyと重複するkeyが指定された場合、<jobParameters>で指定された値が優先されます。
再実行時に指定したパラメータは前回実行時に指定したパラメータに追加・上書きされます。
--help コマンドのヘルプを表示します。
戻り値

コマンド共通の戻り値については、コマンド共通戻り値を参照してください
コマンド共通の戻り値は、ExitCodeマッピング機能では変更できません。

下表の戻り値は、jobctlコマンドのstart , result、および、start-jobコマンド、result-jobコマンド特有の戻り値です。これらのコマンドの戻り値は、ExitStatus との対応関係によって決まります。これらの戻り値は、戻り値定義ファイル の設定により変更可能です。
戻り値 と ExitStatus との対応関係については、ExitCodeMapping機能 を参照してください。
ジョブのExitStatusとBatchStatusの組み合わせ条件と、戻り値との詳細な対応関係は、機能ガイドの「2. ジョブの開始」-「2.4. 戻り値」 を参照してください。

戻り値一覧
戻り値 ExitStatus(BatchStatus) 説明
0 COMPLETED ジョブが正常に終了した
1 FAILED(FAILED以外) その他エラー
102 COMPLETED_WITH_SKIPS ジョブが正常に終了したが、一部処理をスキップ
106 STOPPED 停止
107 FAILED(FAILED) 異常終了
108 NOOP 停止 (何も処理を実行していない)
109 UNKNOWN 不明な状態 (内部状態の保存に失敗等)
実行例
例1:ジョブ名を指定してジョブの処理結果を取得します。
[root@localhost bin]# ./jobctl.sh result --user user --password pass --batchapgroup default --batchap default --jobname hello --reqid 1-5 jobParam1=value1 jobParam2=value2

2010/03/17 09:35:57 634  INFO  main AbstractJobControlCommand - [BS240341001] コマンドの処理を開始します。
2010/03/17 09:36:05 597  INFO  main StartJobCommand - [BS240341005] ジョブが開始されたことを検知しました。
2010/03/17 09:36:05 597  INFO  main StartJobCommand - [BS240341006] DomainName = batchDomain1, ContainerName = null, JobInstanceId = 125, JobExecutionId = 125
2010/03/17 09:36:05 597  INFO  main StartJobCommand - [BS240341008] ジョブ実行ログを表示します :-

<ジョブ実行時のログが表示されます>

2010/03/17 09:36:10 617  INFO  main StartJobCommand - [BS240341009] ジョブが終了しました。 status = COMPLETED :-

Exit Code = 0
関連

status

概要

ジョブの状態を取得します。
開始済みジョブの状態に応じたコマンドの戻り値を返します。
ジョブパラメータの指定を省略した場合、指定したジョブ名で実行された全ての実行結果の一覧を取得します。
オプションを指定することで、状態を表示させるジョブを限定することができます。
ジョブ開始コマンドにリクエストID(--reqid)を指定している場合は、リクエストID指定で状態を表示するジョブ実行を特定することができます。

権限

本コマンドを実行するには、アカウントに以下のいずれかのロールが必要です。

書式
jobctl status <接続オプション> <コマンドオプション>
コマンドオプション
{--jobname <jobname> [--batchap <batchap>] [--batchapgroup <batchapgroup>]
 [--reqid <reqid>]
 [--parametersfile <parametersFile>] [jobParameters] | --help}
{--reqid <reqid> | --help}
コマンドオプション一覧
オプション名 説明
--jobname <jobName> ジョブ名を指定します。
--batchap <batchapName> バッチアプリケーション名を指定します。
指定を省略した場合は、既定値のバッチアプリケーション名 default が指定されます。
--batchapgroup <batchapGroupName> バッチアプリケーショングループ名を指定します。
指定を省略した場合は、既定値のバッチアプリケーショングループ名 default が指定されます。
--reqid <reqId> ジョブのリクエストIDを指定します。
リクエストIDには一意な値を指定する必要があります。
異なるジョブの実行において、同一のリクエストIDを指定すると異常終了します。
--parametersFile <filePath> ジョブパラメータファイル名を含むファイルの絶対パスを指定します。
ジョブパラメータファイルとは、ジョブのパラメータをkey=valueのプロパティファイル形式で記述したファイルです。
同一ファイル内に重複するkeyが指定された場合、後の行に記載されている値が優先されます。
<jobParameters>と重複するkeyがプロパティファイル内で指定された場合、<jobParameters>で指定された値が優先されます。
<jobParameters> ジョブパラメータをkey=valudeのプロパティ形式をコマンド引数として指定します。複数のパラメータを指定する場合、 (半角空白)区切りで指定します。
<jobParameters>内で重複するkeyが指定された場合、初めに記載された値が優先されます。
--parametersFileに指定したジョブパラメータファイルに含まれるkeyと重複するkeyが指定された場合、<jobParameters>で指定された値が優先されます。
再実行時に指定したパラメータは前回実行時に指定したパラメータに追加・上書きされます。
--help コマンドのヘルプを表示します。
戻り値

statusコマンド特有の戻り値です。

コマンド共通の戻り値については、コマンド共通戻り値を参照してください。
ジョブのExitStatusとBatchStatusの組み合わせ条件と、戻り値との詳細な対応関係は、機能ガイドの「4. ジョブの状態参照」-「4.1.1. 戻り値」 を参照してください。

戻り値一覧
戻り値 ExitStatus(BatchStatus) 説明
1 FAILED(FAILED以外) その他エラー
100 QUEUING キューイングされた状態
101 COMPLETED ジョブが正常に終了している
102 COMPLETED_WITH_SKIPS ジョブが正常に終了したが、一部処理をスキップ
103 EXECUTING(STARTING) 実行中 (開始前)
104 EXECUTING(STARTED) 実行中
105 EXECUTING(STOPPING) 実行中 (停止待ち)
106 STOPPED 停止
107 FAILED(FAILED) 異常終了
108 NOOP 停止 (何も処理を実行していない)
109 UNKNOWN 不明な状態 (内部状態の保存に失敗等)
実行例
例1:ジョブ名を指定してジョブの状態を取得します。
[root@localhost bin]# ./jobctl.sh status --user user --password pass --batchapgroup default --batchap default --jobname hello --reqid 1-5 jobParam1=value1 jobParam2=value2

2010/03/19 15:32:23 951  INFO  main AbstractJobControlCommand - [BS240341001] コマンドの処理を開始します。
Exit Code = 101
関連

list-status

概要

ジョブの状態の一覧を取得します。
開始済みジョブの状態に応じたコマンドの戻り値を返します。
バッチドメインエージェントにデプロイされたジョブ毎の最後の実行結果(最後に開始されたもの)の状態一覧を表示します。
--jobname、--batchap、--batchapgroupを指定することで表示対象のジョブを絞り込むことができます。

権限

本コマンドを実行するには、アカウントに以下のいずれかのロールが必要です。

書式
jobctl list-status <接続オプション> <コマンドオプション>
コマンドオプション
{--jobname <jobname> [--batchap <batchap>] [--batchapgroup <batchapgroup>] [--execuser] | --help}
コマンドオプション一覧
オプション名 説明
--jobname <jobName> ジョブ名を指定します。
--batchap <batchapName> バッチアプリケーション名を指定します。
指定を省略した場合は、既定値のバッチアプリケーション名 default が指定されます。
--batchapgroup <groupName> バッチアプリケーショングループ名を指定します。
指定を省略した場合は、既定値のバッチアプリケーショングループ名 default が指定されます。
--execuser ジョブ実行ユーザを指定します。指定を省略した場合は、全ユーザが対象となります。
--help コマンドのヘルプを表示します。
戻り値

コマンド共通の戻り値については、コマンド共通戻り値を参照してください。

実行例
例1:ジョブ名を指定してジョブの処理結果一覧を取得します。
[root@localhost bin]# ./jobctl.sh list-status --user mc1dev --password ved1cm --jobname hello
2010/03/19 15:49:02 239  INFO  main AbstractJobControlCommand - [BS240341001] コマンドの処理を開始します。

ReqId  JobRequestPath               JobInstanceId  JobExecutionId  ExitStatus  BatchStatus  JobRequestStatus
req1   root/default/default/hello   1              1               COMPLETED   COMPLETED    COMPLETED
req2   root/default/default/hello   2              2               COMPLETED   COMPLETED    COMPLETED

  〜snip〜

Exit Code = 0
関連

version

概要

Batch Serverのバージョン情報を標準出力に出力します。

権限

本コマンドは権限管理の対象外です。

書式
jobctl version <コマンドオプション>
コマンドオプション
[--verbose]
コマンドオプション一覧
オプション名 説明
verbose Batch Serverに含まれるSpring Framework、および、Spring Batchのバージョン情報も合わせて表示します。
戻り値

コマンド共通の戻り値については、コマンド共通戻り値を参照してください。

実行例
[root@localhost bin]# ./jobctl.sh version
WebOTX Batch Server (バージョン情報)
関連

なし

help

概要

本コマンドのヘルプを標準出力に出力します。

権限

本コマンドは権限管理の対象外です。

書式
jobctl help [サブコマンド名]
コマンドオプション
コマンドオプション一覧
オプション名 説明
サブコマンド名 指定したサブコマンドのヘルプのみを表示します。
省略した場合、全てのサブコマンドに関するヘルプを表示します。
戻り値

コマンド共通の戻り値については、コマンド共通戻り値を参照してください。

実行例
[root@localhost bin]# ./jobctl.sh help

USAGE :
  jobctl help [commandName]

  jobctl version [--verbose]

  jobctl start --jobname <jobName> {--user <userName> --password <password>}
               [--host <host>] [--port <portNum>] [--batchap <apName>
               [--batchapgroup <groupName>]] [--reqid <reqId>] [--silent]
               [--help] [--parametersfile <filePath>] [--exitcodemapping
               <filePath>] [jobParameters ...]

  jobctl start --restart --jobname <jobName> {--user <userName> --password
               <password>} [--host <host>] [--port <portNum>] [--batchap
               <apName> [--batchapgroup <groupName>]] [--reqid <reqId>]
               [--silent] [--help] [--type <JOB | STEP | CHECKPOINT>]
               [--parametersfile <filePath>] [--exitcodemapping <filePath>]
               [jobParameters ...]

  〜snip〜

DESCRIPTION :
    help
      Show help.

    version
      Show version.

    start
      Start job. --restart options specified, then restart job.

    stop
      Stop job. If specified job is not running, this command is failed.

  〜snip〜

OPTIONS :

       --user <userName>                   user name
       --password <password>               password
       --restart                           restart
       --jobname <jobName>                 job name
       --host <host>                       host name or ip address. "localhost"
                                           as default.
       --port <portNum>                    port number. "16212" as default.

  〜snip〜

関連

なし