adshevtoutコマンド(ジョブ定義スクリプトの稼働実績情報を出力する)
- 〈このページの構成〉
形式
adshevtout [-s ジョブの実行開始日時の下限] [-e ジョブの実行開始日時の上限] [-c JP1/AJSのスケジューラーサービス名] [-r JP1/AJSのルートジョブネット名] [-k JP1/AJSのジョブ実行ID] [-n JP1/AJSのジョブ番号] [-g JP1/AJSのジョブ名] [-u JP1/Advanced Shellの実行ユーザー名] [-p ジョブ定義スクリプトファイルのパス名] [-i JP1/Advanced Shellのジョブ識別子] [-j JP1/Advanced Shellのジョブ名] [-t] [-d] [-m] [-z] [-h 論理ホスト名]
機能
指定された条件に該当するジョブのジョブ定義スクリプト稼働実績情報をイベントファイルから検索し,CSV形式で出力します。出力先は標準出力(stdout)です。
このコマンドは,JP1/Advanced Shell - Developerでは使用できません。
出力条件の指定
次に示す引数で,ジョブ定義スクリプト稼働実績情報を出力するジョブを指定します。
[-s ジョブの実行開始日時の下限] [-e ジョブの実行開始日時の上限] [-c JP1/AJSのスケジューラーサービス名] [-r JP1/AJSのルートジョブネット名] [-k JP1/AJSのジョブ実行ID] [-n JP1/AJSのジョブ番号] [-g JP1/AJSのジョブ名] [-u JP1/Advanced Shellの実行ユーザー名] [-p ジョブ定義スクリプトファイルのパス名] [-i JP1/Advanced Shellのジョブ識別子] [-j JP1/Advanced Shellのジョブ名]
出力条件を複数指定した場合は,すべての条件を満たすジョブのジョブ定義スクリプト稼働実績情報を出力します。
出力条件を指定しない場合,物理ホストまたは指定された論理ホストのすべてのジョブのジョブ定義スクリプト稼働実績情報を出力します。
出力条件としてジョブの属性(起動日時,ジョブ識別子,ジョブ名など)を指定した場合,ルートジョブの属性値で判定します。
すべての出力条件を満たすジョブに属するルートジョブ,すべての子孫ジョブのジョブ定義スクリプト稼働実績情報を出力します。ルートジョブまたは特定の子孫ジョブに限定してジョブ定義スクリプト稼働実績情報を出力することはできません。
ジョブ定義スクリプト稼働実績情報の出力内容
ジョブ定義スクリプト稼働実績情報は,標準の場合,1行目にはヘッダ情報,2行目以降に稼働実績情報やメッセージが出力されます。
adshevtoutコマンドの次に示す引数指定で出力情報を選択できます。
[-t] [-d] [-m] [-z]
稼働実績情報の出力例は,「3.7.9 ジョブ定義スクリプトの稼働実績情報の出力内容」を参照してください。
次の引数を指定した場合,論理ホストで実行したジョブの稼働実績情報を出力します。
[-h 論理ホスト名]
この引数を指定しない場合,物理ホストで実行したジョブの稼働実績情報を出力します。
引数
- -s ジョブの実行開始日時の下限
-
ジョブ定義スクリプト稼働実績情報を出力するジョブの条件として,ジョブの実行開始日時の下限を指定します。
日時の指定形式については,項目「ジョブの実行開始日時」を参照してください。
指定を省略した場合,出力するジョブの実行開始日時の下限は制限されません。
- -e ジョブの実行開始日時の上限
-
ジョブ定義スクリプト稼働実績情報を出力するジョブの条件として,ジョブの実行開始日時の上限を指定します。
日時の指定形式については,項目「ジョブの実行開始日時」を参照してください。
指定を省略した場合,出力するジョブの実行開始日時の上限は制限されません。
- -c JP1/AJSのスケジューラーサービス名
-
ジョブ定義スクリプト稼働実績情報を出力するジョブの条件として,JP1/AJSのスケジューラーサービス名を指定します。
次の2つが文字列として一致するジョブが出力できます。
-
この引数で指定したスケジューラーサービス名
-
ジョブを起動したJP1/AJSのスケジューラーサービス名(JP1/AJSがジョブを起動したときに設定した環境変数AJS_AJSCONFの値)
-
- -r JP1/AJSのルートジョブネット名
-
ジョブ定義スクリプト稼働実績情報を出力するジョブの条件として,JP1/AJSのルートジョブネット名を指定します。
次の2つが文字列として一致するジョブが出力できます。
-
この引数で指定したルートジョブネット名
-
ジョブを起動したときのJP1/AJSのルートジョブネット名(JP1/AJSがジョブを起動するときに設定した環境変数AJSNETNAMEの値)
-
- -k JP1/AJSのジョブ実行ID
-
ジョブ定義スクリプト稼働実績情報を出力するジョブの条件として,JP1/AJSのジョブ実行IDを指定します。
次の2つが文字列として一致するジョブが出力できます。
-
この引数で指定したジョブ実行ID
-
ジョブを起動したときのJP1/AJSのジョブ実行ID(JP1/AJSがジョブを起動したときに設定した環境変数AJSEXECIDの値)
-
- -n JP1/AJSのジョブ番号
-
ジョブ定義スクリプト稼働実績情報を出力するジョブの条件として,JP1/AJSのジョブ番号を指定します。
次の2つが文字列として一致するジョブが出力できます。
-
この引数で指定したジョブ番号
-
ジョブを起動したときのJP1/AJSのジョブ番号(JP1/AJSがジョブを起動するときに設定する環境変数JP1JobIDの値)
例えば,ジョブ番号「0000012345」のジョブを指定する場合,「-n 0000012345」と指定する必要があります。「-n 12345」と指定すると,ジョブ番号は一致しないと判定します。
ジョブ番号の形式はプラットフォーム間で異なる場合があります。
ジョブ番号の詳細は,JP1/AJSのマニュアルを参照してください。
-
- -g JP1/AJSのジョブ名
-
ジョブ定義スクリプト稼働実績情報を出力するジョブの条件として,JP1/AJSのジョブ名を指定します。
次の2つが文字列として一致するジョブが出力できます。
-
この引数で指定したジョブ名
-
ジョブを起動したときのJP1/AJSのジョブ名(JP1/AJSがジョブを起動するときに設定する環境変数AJSJOBNAMEの値)
-
- -u JP1/Advanced Shellの実行ユーザー名
-
ジョブ定義スクリプト稼働実績情報を出力するジョブの条件として,ジョブを実行したadshexecコマンドを実行したプロセスの実行ユーザー名を指定します。
次の2つが文字列として一致するジョブが出力できます。
-
この引数で指定したユーザー名
-
ジョブを実行したadshexecコマンドのプロセスのユーザー名
-
- -p ジョブ定義スクリプトファイルのパス名
-
ジョブ定義スクリプト稼働実績情報を出力するジョブの条件として,ジョブを実行するときにadshexecコマンドに指定したジョブ定義スクリプトファイルのパス名を指定します。
次の2つが文字列として一致するジョブが出力できます。
-
この引数で指定したパス名
-
adshexecコマンドに指定されたジョブ定義スクリプトファイルのパス名
同一のジョブ定義スクリプトファイルのパスとして解釈できるパス名であっても,文字列として一致しない場合,出力するジョブではないと判断します。
パス名が一致しないと判断する例を次に示します。
- adshexecコマンドの実行時のカレントディレクトリが/home/user1である場合
-
adshexecコマンドに指定したパス名:./test1.ash
adshevtoutコマンドに指定したパス名:/home/user1/test1.ash
-
- -i JP1/Advanced Shellのジョブ識別子
-
ジョブ定義スクリプト稼働実績情報を出力するジョブの条件として,JP1/Advanced Shellのジョブ識別子を指定します。
次の2つが文字列として一致するジョブが出力できます。
-
この引数で指定したジョブ識別子
-
ジョブのJP1/Advanced Shellのジョブ識別子(環境変数ADSH_JOBIDの値)
例えば,ジョブ識別子「000001」のジョブを指定する場合は,「-i 000001」と指定する必要があります。先頭の0は省略できません。
-
- -j JP1/Advanced Shellのジョブ名
-
ジョブ定義スクリプト稼働実績情報を出力するジョブの条件として,ジョブのJP1/Advanced Shellのジョブ名を指定します。
次の2つが文字列として一致するジョブが出力できます。
-
この引数で指定したジョブ名
-
ジョブのJP1/Advanced Shellのジョブ名(環境変数ADSH_JOB_NAMEの値)
-
- -t
-
ジョブ定義スクリプト稼働実績情報を出力する際,先頭にヘッダ情報を出力しないことを指定します。
- -d
-
ジョブ定義スクリプト稼働実績情報を出力しないことを指定します。
ヘッダ情報だけを出力したい場合に使用します。
- -m
-
ジョブ定義スクリプト稼働実績情報として,メッセージだけ出力することを指定します。
- -z
-
環境変数の情報をジョブ定義スクリプト稼働実績情報へ出力しないことを指定します。
- -h 論理ホスト名
-
ジョブ定義スクリプト稼働実績情報を出力するジョブを実行した論理ホスト名を指定します。
adshevtoutコマンドは,指定された論理ホストに対応するスプールにあるイベントファイルからジョブ定義スクリプト稼働実績情報を出力します。
Windowsの場合,196バイトを超える論理ホスト名は指定できません。また,論理ホスト名の長さは63バイト以下を推奨します。63バイトを超える名称を指定すると,動作しないことがあります。
この引数は実行環境を指定する引数です。ジョブ定義スクリプト稼働実績情報の出力するジョブの条件を指定する引数ではありません。
この引数に指定した論理ホスト名が環境ファイルに定義されていない場合,-hの指定を無視します。
終了コード
終了コード |
意味 |
---|---|
0 |
正常終了 |
1 |
コマンドラインの指定に誤りがあります。 |
2 |
環境変数の設定に誤りがあります。 |
3 |
環境変数LANGに設定している文字エンコーディングに対応していません。 |
4 |
処理をスキップしたイベントファイルがあります。 原因については,コマンドが出力したメッセージを確認してください。 |
5 |
スプールの参照で入出力エラーが発生し,参照できませんでした。 |
6 |
ほかのコマンドがアクセスしているため,スプールを参照できませんでした。 |
7 |
メッセージ出力処理でエラーが発生しました。 |
8 |
標準出力への出力処理でエラーが発生しました。 |
10 |
日時の取得でエラーが発生しました。 |
11 |
メモリ不足が発生しました。 |
12 |
内部処理矛盾を検出しました。 |
13 |
初期化処理でエラーが発生しました。 |
終了コードは基本的に,コマンド実行中に発生した事象に対する終了コードの中の最大値となります。ただし,終了コード4は,それ以外の事象が発生しなかった場合だけ出力されます。
同一引数の複数指定
同一の引数を複数回指定した場合,最後の指定を有効とします。
- (例)
-
次の場合,-s 19900401が指定されていると解釈します。
adshevtout -s 20120411 -s 19900401
異なる引数の組み合わせ
出力情報を選択する引数が組み合わせて指定された場合,引数は次の表の優先順位に従って解釈されます。
引数の優先順位※ |
引数 |
機能 |
---|---|---|
1 |
-d |
稼働実績情報を出力しない |
2 |
-m |
メッセージだけを出力する |
3 |
-z |
環境変数の情報を出力しない |
ジョブの実行開始日時
ジョブの実行開始日時の下限,上限の日時は次の3とおりの形式で指定できます。
YYYYに指定できる西暦年の範囲は1970〜2038です。
日時の指定形式 |
指定の解釈 |
---|---|
YYYYMMDD,hhmmss |
年月日と時分秒を指定する形式です。 上限の場合,指定された時分秒+1秒と解釈します。時分秒を「235959」と指定した場合,指定された年月日の翌日の00:00:00と解釈します。 |
YYYYMMDD |
年月日だけを指定する形式です。 時分秒は次のように解釈します。
|
,hhmmss |
時分秒だけを指定する形式です。 年月日はコマンドの実行日と解釈します。 上限の場合,指定された時分秒+1秒と解釈します。時分秒を「235959」と指定した場合,コマンドの実行日の翌日の00:00:00と解釈します。 |
日時の解釈の例を次の表に示します。表の項番5〜7は,adshevtoutコマンドを2012年10月23日に実行した場合の例です。
項番 |
コマンドでの指定 |
コマンドによって解釈される日時 |
|
---|---|---|---|
実行開始日時の下限の場合 |
実行開始日時の上限の場合 |
||
1 |
20120501,000000 |
2012年05月01日 00時00分00秒 |
2012年05月01日 00時00分01秒 |
2 |
20120501,100000 |
2012年05月01日 10時00分00秒 |
2012年05月01日 10時00分01秒 |
3 |
20120501,235959 |
2012年05月01日 23時59分59秒 |
2012年05月02日 00時00分00秒 |
4 |
20120501 |
2012年05月01日 00時00分00秒 |
2012年05月02日 00時00分00秒 |
5 |
,000000 |
2012年10月23日 00時00分00秒 |
2012年10月23日 00時00分01秒 |
6 |
,100000 |
2012年10月23日 10時00分00秒 |
2012年10月23日 10時00分01秒 |
7 |
,235959 |
2012年10月23日 23時59分59秒 |
2012年10月24日 00時00分00秒 |
コマンドに指定された日時は,コマンド実行時の環境変数TZに設定されたタイムゾーンに応じて解釈します。
コマンドで,文字列として同じ日時を指定しても,環境変数TZのタイムゾーンが異なると,コマンドが解釈した日時は異なります。注意してください。
指定できる日時は次のとおりです。
-
協定世界時(UTC)で表現した場合
1970年1月1日 00:00:00〜2038年1月19日 03:14:07
-
日本標準時(UTC+9)で表現した場合
1970年1月1日 09:00:00〜2038年1月19日 12:14:07
タイムゾーンが上記以外の場合,指定できる日時の範囲の表現は,使用しているタイムゾーンに応じて変わります。
また,各OSが提供する時刻関連の関数の実装の相違で,上記の範囲の日時であってもエラーとなる場合があります。次の場合はエラーとなります。
-
不当な日時が指定された場合
-
実行開始日時の下限が,実行開始日時の上限よりあとの場合
環境変数TZ
環境変数TZに設定されたタイムゾーンは,コマンド実行時に次に示す日時の解釈,日時の表現で参照します。
-
コマンドの引数に指定された日時の解釈
-
ジョブ定義スクリプト稼働実績情報内の日時の表現
タイムゾーンと日時の表現の関係は,「3.7.3 稼働実績情報の日時とタイムゾーンの関係」を参照してください。
環境変数TZは次に示すPOSIX形式で,符号に注意して指定してください。
- (例)
export TZ=JST-9
環境変数TZは,次のようなTime Zone Database形式では設定しないでください。
- (使用できない例)
export TZ=Asia/Tokyo export TZ=Japan
環境変数TZに,サマータイムの情報を設定して,adshevtoutコマンドを実行しないでください。adshevtoutコマンドはサマータイムには対応していません。
環境変数TZの設定の詳細については,使用しているOSの仕様を参照してください。
ジョブの実行開始日時の下限
-sでジョブの実行開始日時の下限が指定された場合,ジョブ定義スクリプト稼働実績情報を出力するジョブは,次に示す条件が成立する必要があります。
- ts≦tj
-
tj:ジョブの実行開始日時
ts:adshevtoutコマンドが解釈したジョブの実行開始日時の下限
ジョブの実行開始日時の上限
-eでジョブの実行開始日時の上限が指定された場合,ジョブ定義スクリプト稼働実績情報を出力するジョブは,次に示す条件が成立する必要があります。
- tj<te
-
tj:ジョブの実行開始日時
te:adshevtoutコマンドが解釈したジョブの実行開始日時の上限
出力できるジョブ定義スクリプト稼働実績情報
-
出力できるジョブ定義スクリプト稼働実績情報は,コマンドを実行したユーザーがアクセスできるイベントファイルに格納されているものです。コマンドを実行したユーザーがアクセスできない場合,メッセージを出力し,アクセスできないイベントファイルにあるジョブ定義スクリプト稼働実績情報を出力しません。
-
実行中のジョブ,adshexecコマンドがエラー終了したジョブのジョブ定義スクリプト稼働実績情報は出力しません。具体的には,スプールジョブのディレクトリ名が次の形式であるジョブのジョブ定義スクリプト稼働実績情報は出力しません。
-
「ジョブ識別子」
-
「ジョブ識別子-」
-
-
削除中のジョブのジョブ定義スクリプト稼働実績情報は出力しません。
スプールジョブのディレクトリの直下に次に示すスプールジョブ管理ファイルが存在しない場合,ジョブは削除中と判断します。
-
UNIXの場合:.sysout
-
Windowsの場合:sysout.ini
-
adshhkコマンドとの同時実行
-
adshevtoutコマンドとadshhkコマンド(スプールジョブの削除)は,スプールディレクトリを排他制御します。
-
同一のスプールディレクトリに対して,adshevtoutコマンドとadshhkコマンドは同時に実行できません。
-
同一のスプールディレクトリに対して,複数のadshevtoutコマンドは同時に実行できます。
-
スプールディレクトリが排他制御されているためにadshevtoutコマンドが実行できない場合,エラーメッセージを出力して処理を終了します。
注意事項
-
出力されるジョブ定義スクリプト稼働実績情報のサイズが大きい場合,コマンドの出力条件を日時単位などで分けて実行し,出力される稼働実績情報を分割してください。
使用例
-
JP1/Advanced Shellのジョブ識別子000100のジョブ定義スクリプト稼働実績情報をファイルout.csvに出力します。
adshevtout -i 000100 > out.csv