jobctl

共通

概要

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

パス

${BS_HOME}/bin

権限

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

• Administrator
• JobExecutor

書式

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

サブコマンド

接続オプション

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

{--user <user> --password <password> [--host <host>] [--port <port>]}

コマンドオプション

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

戻り値

実行例

${BS_HOME}\bin\> jobctl.cmd <サブコマンド> <接続オプション> <コマンドオプション>

[root@localhost bin]# jobctl.sh <サブコマンド> <接続オプション> <コマンドオプション>

関連

• start-job
  
• stop-job
  
• result-job
  
• status-job
  

start

概要

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

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

権限

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

• Administrator
• JobExecutor

書式

常駐モード

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}

restartオプションに関する補足

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

戻り値

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

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

実行例

[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

関連

• コマンドリファレンス
  • jobctl stop
    
  • jobctl result
    
  • jobctl status
    
  • jobctl list-status
    
  • start-job
    
• 運用・利用ガイド
  • バッチアプリケーションの運用・利用ガイド
    • ジョブの実行
      • ジョブを実行する
      • ジョブを再実行する
      • ジョブ終了時のコマンド戻り値を設定する
• 機能ガイド
  • ジョブ実行制御
    • ジョブの開始
  • ExitCodeMapping機能
• 定義ファイルリファレンス
  • DOMAIN_HOME/config/batch/exitcode/
    • mapping.properties

stop

概要

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

権限

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

• Administrator
• JobExecutor

書式

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}

戻り値

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

実行例

[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

関連

• コマンドリファレンス
  • jobctl start
    
  • jobctl result
    
  • jobctl status
    
  • jobctl list-status
    
  • stop-job
    
• 運用・利用ガイド
  • バッチアプリケーションの運用・利用ガイド
    • ジョブの実行
      • 実行中のジョブを停止する
• 機能ガイド
  • ジョブ実行制御
    • ジョブの停止

result

概要

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

権限

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

• Administrator
• JobExecutor
• JobObserver

書式

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

コマンドオプション

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

{--reqid <reqid> [--exitcodemapping <exitcodeMappingFile>] [--silent] | --help}

戻り値

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

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

実行例

[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

関連

• コマンドリファレンス
  • jobctl start
    
  • jobctl stop
    
  • jobctl status
    
  • jobctl list-status
    
  • result-job
    
• 運用・利用ガイド
  • バッチアプリケーションの運用・利用ガイド
    • ジョブの実行
      • ジョブの実行結果を取得する
      • ジョブ終了時のコマンド戻り値を設定する
• 機能ガイド
  • ジョブ実行制御
    • ジョブの実行結果取得
  • ExitCodeMapping機能
• 定義ファイルリファレンス
  • DOMAIN_HOME/config/batch/exitcode/
    • mapping.properties

status

概要

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

権限

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

• Administrator
• JobExecutor
• JobObserver

書式

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

コマンドオプション

{--jobname <jobname> [--batchap <batchap>] [--batchapgroup <batchapgroup>]
 [--reqid <reqid>]
 [--parametersfile <parametersFile>] [jobParameters] | --help}

{--reqid <reqid> | --help}

戻り値

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

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

関連

• コマンドリファレンス
  • jobctl start
    
  • jobctl stop
    
  • jobctl result
    
  • jobctl list-status
    
  • status-job
    
• 運用・利用ガイド
  • バッチアプリケーションの運用・利用ガイド
    • ジョブの実行
      • ジョブの状態を取得する
• 機能ガイド
  • ジョブ実行制御
    • ジョブの状態参照

list-status

概要

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

権限

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

• Administrator
• JobExecutor
• JobObserver

書式

jobctl list-status <接続オプション> <コマンドオプション>

コマンドオプション

{--jobname <jobname> [--batchap <batchap>] [--batchapgroup <batchapgroup>] [--execuser] | --help}

戻り値

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

実行例

[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

関連

• コマンドリファレンス
  • jobctl start
    
  • jobctl stop
    
  • jobctl result
    
  • jobctl status
    
  • status-job
    

version

概要

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

権限

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

書式

jobctl version <コマンドオプション>

コマンドオプション

[--verbose]

戻り値

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

実行例

[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〜

関連

なし