cpareport
機能
各種情報を標準出力に出力します。
形式
cpareport [-c { system [-f {csv|xml}] | job [-t all] [-b 開始日] [-e 終了日] [-f {csv|xml}] [-i ジョブ名] | job -t detail -i ジョブ名 [-o ジョブ実行ID] [-f {csv|xml}] | job -t output -i ジョブ名 [-o ジョブ実行ID] -p アクション名 [-q {stdout|stderr}] | jds | item }]
実行権限
なし。
引数
- -c system
-
システムの稼働情報はCSV形式またはXML形式で出力できます。
-
-f csv(CSV形式)を指定した場合
項番
行数
項目名
表示内容
1
1
タイトル
PRJNAME,STATUS,IESC
2
2〜
プロジェクト名
PRJNAME
システム設定ファイル(config.xml)のプロジェクト名の設定値
3
ジョブ実行サービス状態
STATUS
UP(ジョブ実行サービス稼働状態)
DOWN(ジョブ実行サービス停止状態)
4
メッセージ通信サービス状態
IESC
UP(メッセージ通信サービス稼働状態)
DOWN(メッセージ通信サービス停止状態)
- <表示例>
PRJNAME,STATUS,IESC project,UP,DOWN
-
-f xml(XML形式)を指定した場合
項番
行数
タグ名
表示内容
1
1
xml
XMLタグ
2
2
PRJNAME
CSV形式と同じ
3
STATUS
4
IESC
- <表示例>
<?xml version="1.0" encoding="utf-8"?> <PRJNAME>project</PRJNAME><STATUS>UP</STATUS><IESC>DOWN</IESC>
-
- -c job
-
このオプションを指定して実行する場合は,-tオプションを指定して実行してください。
-tオプションを指定しないで実行した場合は,このコマンドを実行した日のジョブの状態の一覧を,次の表に示す優先順に従って表示します。状態がない場合は一覧を表示しません。
優先順位
状態
同一優先順位の状態が複数ある場合の優先順位
1
開始時刻待ち
−
2
実行中
−
3
終了(正常)
開始日時が遅いジョブ(最近開始したジョブ)
4
警告終了
開始日時が遅いジョブ(最近開始したジョブ)
5
異常終了,イベント監視停止中
開始日時が遅いジョブ(最近開始したジョブ)
6
異常終了(キャンセル)
開始日時が遅いジョブ(最近開始したジョブ)
7
監視中
−
-tオプションを指定しない場合の出力形式を次の表に示します。
-
-f csv(CSV形式)を指定した場合
項番
行数
項目名
表示内容
1
1
タイトル
JDSNAME,JCSID,STATUS,STARTTIME,ENDTIME
2
2〜
ジョブ名
JDSNAME
登録されているジョブのジョブ名。
3
ジョブ実行ID
JCSID
nnnnnnnnnnnnnnnn(40桁以内の文字列)
ジョブの実行予定が生成されるときに割り振られるID。
詳細は「1.3 ジョブの実行単位とジョブ実行ID」を参照してください。
4
ジョブの状態
STATUS※
-
RUN(実行中)
-
WAIT(開始時刻待ち)
-
MONITORING(イベント監視中,イベントオーバーフロー中)
-
QUEUEING(開始待ち)
-
ENDN(正常終了)
-
ENDW(警告終了)
-
ENDE(異常終了,異常終了(キャンセル),イベント監視停止中)
-
ENDK(異常終了(キャンセル))
5
開始日時
STARTTIME
YYYY/MM/DD HH:MM:SS.sss
ジョブの状態に応じて表示される内容を次に示す。
-
WAIT:次回実行予定の日時を表示する。
-
MONITORING:実行条件の成立の監視を開始した日時を表示する。
-
QUEUEING:実行条件が成立し,ジョブが実行している間に次のイベントが成立した日時を表示する。
-
その他:ジョブの開始日時を表示する。
6
終了日時
ENDTIME
YYYY/MM/DD HH:MM:SS.sss
ジョブの状態に応じて表示される内容を次に示す。
-
ENDN,ENDE,ENDK:ジョブの終了日時を表示する。
-
その他:表示しない。
注※ ジョブの状態の詳細については「1.1.4 ジョブまたはアクションの状態管理」を参照してください。
-
-
-f xml(XML形式)を指定した場合
項番
行数
タグ名
属性名
表示内容
1
1
xml
XMLタグ
2
2〜
JDS
NAME
CSV形式と同じ
3
JCSID
4
STATUS※
5
STARTTIME
6
ENDTIME
注※ ジョブの状態の詳細については「1.1.4 ジョブまたはアクションの状態管理」を参照してください。
-
- -t all
-
登録されているすべてのジョブの,状態の一覧を表示します。
1つのジョブで表示される順番は,開始日時または開始予定日時(出力情報のSTARTTIME)の降順です。
出力形式は,-tオプションを指定しない場合と同じです。なお,ジョブの状態の開始日時に応じて出力する状態の範囲を,-bオプションと-eオプションで変更できます。指定を省略した場合は,このコマンドを実行した日の状態だけ表示します。詳細は,-bオプションと-eオプションの項目を参照してください。
- -i ジョブ名
-
ジョブ名で指定したジョブの,状態の一覧を表示します。
出力形式は,-t allオプションを指定した場合と同じです。
- -t detail -i ジョブ名
-
ジョブ名で指定したジョブの,ジョブ状態とアクション状態を表示します。
-oオプションを指定しない場合は,割り振られた最新のジョブ実行ID(JCSID)のジョブ状態とアクション状態を表示します。
ジョブ名には,1〜45バイトのマルチバイト文字,半角英数字および_(アンダーバー)が指定できます。
出力形式を次の表に示します。
-
-f csv(CSV形式)を指定した場合
項番
行数
項目名
表示内容
1
1
タイトル
-tオプションを指定しない場合と同じ
2
2
ジョブ名
JDSNAME
3
ジョブ実行ID
JCSID
4
ジョブの状態
STATUS
5
開始日時
STARTTIME
6
終了日時
ENDTIME
7
3
タイトル
TYPE,ACTNAME,STATUS,STARTTIME,ENDTIME
8
4〜
ユニット種別
-
ACT:アクションまたはイベントモニターである。
-
FLW:アクションフロー(配下に0個以上のアクションを含むグループ)である。
9
アクション名
ACTNAME
アクション名を次の形式で出力する。
[/アクションフロー名]/アクション名
アクション名の表示順は不定
10
アクションの状態
STATUS※
-
RUN(実行中)
-
WAIT(開始待ち)
-
ENDN(正常終了)
-
ENDW(警告終了)
-
ENDE(異常終了)
-
ENDK(異常終了(キャンセル))
11
開始日時
STARTTIME
YYYY/MM/DD HH:MM:SS.sss
-
WAIT:表示しない。
-
その他:アクションの開始日時を表示する。
12
終了日時
ENDTIME
YYYY/MM/DD HH:MM:SS.sss
-
ENDN,ENDE,ENDK:アクションの終了日時を表示する。
-
その他:表示しない。
注※ アクションの状態の詳細については「1.1.4 ジョブまたはアクションの状態管理」を参照してください。
-
-
-f xml(XML形式)を指定した場合
項番
行数
タグ名
属性名
表示内容
1
1
xml
XMLタグ
2
2
JDS
NAME
CSV形式と同じ
3
JCSID
4
STATUS※
5
STARTTIME
6
ENDTIME
7
3〜
ACT
NAME
8
TYPE
9
STATUS
10
STARTTIME
11
ENDTIME
注※ アクションの状態の詳細については「1.1.4 ジョブまたはアクションの状態管理」を参照してください。
このオプションを指定した場合の,ジョブ名で指定したジョブのジョブ状態を終了コードで示します。
表9‒4 終了コード一覧 終了コード
意味
0
実行中
2
起動待ち,監視中,監視中断
3
終了
-
- -t output
-
アクションの標準出力/標準エラー出力の内容を表示します。
- -o ジョブ実行ID
-
操作対象のジョブのジョブ実行IDを指定します。
指定を省略した場合は最新のジョブ実行IDを仮定します。
ジョブ実行IDには,1〜40バイトの英数字と-(ハイフン)が指定できます。
- -p アクション名
-
ジョブ実行時のアクション名を次の形式(-t detailを指定した場合に出力される形式)で指定します。
[/アクションフロー名]/アクション名
アクション名には,先頭の"/"を含めて1〜256バイトのマルチバイト文字,半角英数字および_(アンダーバー)が指定できます。
- -q {stdout|stderr}
-
出力対象を指定します。
指定を省略した場合は,標準出力を出力したあとに標準エラー出力を出力します。
stdoutを指定した場合は,標準出力だけを出力します。
stderrを指定した場合は,標準エラー出力だけを出力します。
- -b 開始日 -e 終了日
-
表示する時間の範囲をYYYYMMDD形式で指定します。
指定可能な値は19940101〜20991231です。
開始日と終了日を指定した場合は,開始日から終了日までに開始したジョブのジョブ一覧を表示します。
開始日を省略した場合は,終了日以前に開始したジョブのジョブ一覧を表示します。
終了日を省略した場合は,開始日以降に開始したジョブのジョブ一覧を表示します。
開始日と終了日を省略した場合は,コマンド実行当日に開始したジョブのジョブ一覧を表示します。
開始日と終了日を指定し,終了日が開始日より前のときは引数エラーになります。
- -f csv
-
CSV形式で出力します。
- -f xml
-
XML形式で出力します。
- -c jds
-
登録されているジョブのジョブ名,登録日の一覧を表示します。
- -c item
-
登録されているすべてのアイテムの種類,アイテム名,登録日の一覧を表示します。
戻り値
0 |
成功 -t detailを指定した場合,ジョブが実行中 |
2 |
-t detailを指定した場合,ジョブが起動待ち,監視中,監視中断 |
3 |
-t detailを指定した場合,ジョブが停止(次回起動予定なし) |
40 |
リソース不足 |
50 |
システム設定ファイル(config.xml)にアクセス権がない |
52 |
ファイルアクセスでエラーが発生した |
58 |
引数の形式が不正 |
86 |
レコードなし (指定されたジョブまたはジョブ実行IDにはまだレコードが存在しないため何も表示できない) |
94 |
システム設定ファイル(config.xml)が不正 |
109 |
システム設定ファイル(config.xml)が存在しない |
111 |
ファイルアクセスエラー |
121 |
システム限界値オーバーエラー (ファイルのオープン数がシステムの限界値に達している) |
123 |
実行環境不正 (ディレクトリが削除されていたり,ファイルが壊れていたりすることにより,当該ファイルの削除や,再インストールが必要な状態) |
124 |
I/Oエラー(ディスクに問題がありファイルがオープンできない) |
125 |
システムエラー(OSのAPIでエラーが発生) |
126 |
その他エラー |
環境設定
ジョブ実行サービスが開始・停止どちらの状態でも実行できます。
格納場所
インストールパス\bin
ただし,デフォルトでは次に示す場所に格納されます。
- 32ビット版のOSの場合
-
%ProgramFiles%\Hitachi\JP1CPA\bin
- 64ビット版のOSの場合
-
%ProgramFiles(x86)%\Hitachi\JP1CPA\bin