13.15 dcmstat.exe(ジョブの実行状況の取得)
ジョブの実行結果を取得するdcmstatコマンドについて説明します。
機能
配布管理システムで、パラメタファイルに指定されたジョブの実行状態を取得します。ジョブの実行状況は、リターンコードで判別します。
ジョブの実行状態 |
リターンコード |
---|---|
ジョブがすべて正常終了した。 |
0 |
一部のジョブがエラーとなった。 |
30 |
ジョブは実行中。 |
31 |
ジョブは実行中で、一部のジョブがエラーとなっている。 |
32 |
ジョブは削除中で、一部のジョブが削除完了待ちとなっている。 |
33 |
JP1/IT Desktop Management 2 - Managerの配布管理システムで、ジョブの実行状態を指定して、その実行状態にあるホストの数を調べます。リターンコードの値から10,000を引いた値が、指定した実行状態にあるホストの数です。
形式
dcmstat.exe [ジョブ実行状態] /i パラメタファイル名 [/LC {ON|OFF}]
引数
-
ジョブ実行状態
特定の実行状態にあるホストの数を調べる場合に、ジョブの実行状態を指定します。下記の引数の中から1つ以上を、コマンド名の直後に指定してください。指定したジョブ実行状態にあるホストの総数に10,000を足した数がリターンコードとして返ります。
指定できるジョブ実行状態を次の表に示します。
ジョブ実行状態
説明
TRANS_WAIT
配布管理システムで転送待ち状態。
TRANSMITTED
管理対象のコンピュータへ転送中または実行中。
REGISTERED
IDジョブをID管理中継へ転送中。
CLT_NOTREADY
起動に失敗した。
CLT_SERVICE_OFF※
エージェントが停止しているため、起動に失敗した。
CLT_POWER_OFF※
PCの電源がオフのため、起動が失敗した。
CLT_NETWORK_ERR※
ネットワーク障害などの理由のため、起動が失敗した。
SUSPENDED
中断指示があった。
INST_WAIT
インストールまたは収集待ち。
HOLD_EXEC
ジョブが保留された。
ID_NOPKG
IDジョブで中継保管パッケージが削除された。
CONNECT_ERROR
通信エラーが発生した。
ERROR
ジョブ実行エラーが発生した。
DELETING
中継するシステムまたは管理対象のコンピュータでジョブを削除中。
- 注※
-
JP1/IT Desktop Management 2 - Managerのセットアップで、[リモートインストールマネージャを使用した配布のセットアップ]画面の[サーバカスタマイズオプション]パネルの「起動失敗要因を細分化する」チェックボックスがオンの場合に指定できます。ただし、「CLT_NOTREADY」と同時に指定しても無視されます。
なお、チェックボックスがオフの場合は、これらの引数を指定しても、ホストの総数にカウントされません。
ジョブ実行状態を指定しなかった場合は、パラメタファイルで指定したジョブの実行状態を調べ、実行状態に対応するリターンコード(0〜33)を返します。
-
/i
パラメタファイルのフルパスを指定してください。
dcmcollコマンド(/s指定なし)、dcminstコマンド(/s指定なし)、dcmjexeコマンド、またはdcmsuspコマンド(/s指定なし)の結果出力ファイルを、パラメタファイルとして使用することもできます。
-
/LC
タスクスケジューラやJP1/AJSを使用してコマンドをバックグラウンドサービスとして実行している場合にWindowsをログオフしても、コマンド処理を継続するかどうかを「ON」または「OFF」で指定します。
-
ON
Windowsをログオフしても、コマンド処理を継続します。
-
OFF
Windowsをログオフすると、コマンド処理を強制終了します。
この引数は、次に示すOSでコマンドをサービスから実行した場合に、有効となります。
-
Windows Server 2003
コマンドプロンプトからコマンドを実行する場合は、フォアグラウンドプログラムとして実行されるため、「/LC ON」を指定しないでください。
Windowsをログオフしてもコマンド処理を継続するかどうかは、レジストリでも設定できます。
なお、/LCでの指定と、レジストリでの設定の組み合わせで、動作が異なります。詳細については、「13.20 レジストリ設定とログオフオプションによるログオフ時のコマンドの動作」を参照してください。
-
パラメタファイルの指定内容
dcmstatコマンドでのパラメタファイルの指定内容を次の表に示します。このコマンドで使用するパラメタファイルの内容は、コマンドの引数で指定することはできません。
パラメタファイルの指定内容 |
内容 |
指定の有無 |
コマンドの引数 |
|
---|---|---|---|---|
タグ |
パラメタ |
|||
job_generator |
ジョブ名称 |
× |
− |
|
jobno |
ジョブ番号 |
◎ |
− |
|
job_folder |
ジョブ格納フォルダパス |
○※ |
− |
|
unsuspended |
中断中の配布の有無 |
× |
− |
- (凡例)
-
◎:必ず指定する ○:省略できる ×:不要(指定しても無視される)
−:コマンドの引数では指定できない
- 注※
-
省略した場合は、ルートフォルダ以下のすべてのフォルダまたはファイルを検索して、ジョブの実行状況を表示します。
リターンコード
dcmstatコマンド実行時のリターンコードを次の表に示します。
コード |
意味 |
対処 |
---|---|---|
0 |
ジョブがすべて正常終了した。 |
なし。 |
1 |
パラメタファイルをオープンできない、またはファイル形式が不正。 |
パラメタファイルの指定または記述形式を確認してください。 |
2 |
パラメタファイルに不正な値が指定されている。 |
パラメタファイルの値を確認してください。 |
3 |
データベースの接続に失敗した。 |
配布管理システムのセットアップで、データベースの設定を確認してください。 |
5 |
JP1/IT Desktop Management 2のサービスの接続に失敗した。 |
JP1/IT Desktop Management 2 - Managerのサービスが開始しているかどうかを確認してください。 |
12 |
そのほかのエラーが発生した。 |
イベントログを参照してください。 |
30 |
少なくとも一部のジョブがエラーになった。 |
なし。 |
31 |
ジョブは実行中で、エラーのジョブは検知されていない。 |
なし。 |
32 |
ジョブは実行中で、一部のジョブがエラーとなっている。 |
なし。 |
33 |
ジョブは削除中で、一部のジョブが削除完了待ちとなっている。 |
なし。 |
また、ジョブの実行状態を指定した場合は、指定したジョブの実行状態にあるホストの総数+10,000がリターンコードとして返ります。
注意事項
-
パラメタファイルには、dcmcollコマンド(/s指定なし)、dcminstコマンド(/s指定なし)、dcmjexeコマンド、またはdcmsuspコマンド(/s指定なし)の結果出力ファイルに出力されたジョブ番号を指定してください。
-
実行状況を取得するジョブのジョブ番号が不明な場合、dcmstatコマンドは実行できません。配布管理システムの[ジョブ実行状況]ウィンドウで、該当するジョブ名の実行状況を確認してください。
実行例
dcmjexeコマンドで実行した「伝票ファイル0001収集」ジョブの実行状況を取得する例を次に示します。
- パラメタファイルの作成
-
dcmjexeコマンドの結果出力ファイルに出力されたジョブ番号を、次のようにパラメタファイルに指定します。
なお、dcmjexeコマンドの結果出力ファイルが保存されていれば、このファイルをパラメタファイルとして指定できます。
** dcmjexe output -> dcmstat input JOB_ATTRIBUTE{ job_generator= 伝票ファイル0001収集 jobno= JB03121113315383 job_folder= \バッチ定義 }
- コマンドの実行
-
dcmjexeコマンドを実行したときの結果出力ファイルが、C:\Dmbat\out.txtに保存されている場合、次のようにコマンドを指定してください。
dcmstat.exe /i C:\Dmbat\out.txt
dcmstatコマンドを実行すると、特定の状態のホスト数を調査できます。例えば、起動失敗のホスト数、および中断指示があったホスト数を調べる場合は、次のように指定してください。
dcmstat.exe CLT_NOTREADY SUSPENDED /i C:\Dmbat\out.txt