4.23 dcmsusp.exe(ファイル転送の中断と再開)
(1) 機能
ローカルホスト上の配布管理システムに接続し,指定した中継するシステムとその直下のシステム間のファイル転送を中断,再開します。また,接続先の配布管理システムとその直下のシステム間のファイル転送を中断,再開します。
(2) 形式
dcmsusp.exe [処理キー] [/s] /i パラメタファイル1 [パラメタファイル2]
[/o 結果出力ファイル名] [/LC {ON|OFF}]
(3) 引数
- 処理キー
実行する処理の種類を指定するキーです。コマンド名の直後に,次に示す四つの処理キーのうち一つを指定してください。省略した場合は,「NETM_SUSPEND」が仮定されます。
- NETM_SUSPEND
「ファイル転送の中断」ジョブを実行します。指定した中継するシステムとその直下のシステム間のファイル転送を中断します。パラメタファイル(またはコマンドの引数)で,ジョブのあて先(中継システムのクライアント機能)を指定してください。
- NETM_RESUME
「ファイル転送の再開」ジョブを実行します。指定した中継するシステムとその直下のシステム間のファイル転送を再開します。パラメタファイル(またはコマンドの引数)で,ジョブのあて先(中継システムのクライアント機能)を指定してください。
- NETM_MANSUSP
接続先の配布管理システムとその直下のシステム間のファイル転送を中断します。この処理キーを指定した場合,処理キー以外の引数はすべて無視します。
- NETM_MANRESU
接続先の配布管理システムとその直下のシステム間のファイル転送を再開します。この処理キーを指定した場合,処理キー以外の引数はすべて無視します。
- /s
ジョブを作成後,実行しないで保存します。処理キーが「NETM_MANSUSP」または「NETM_MANRESU」の場合は,指定しても無視されます。
ジョブの登録日時,実行日時,および実行期限を指定した場合は,これらのスケジュールも保存します。
- /i
使用するパラメタファイルのフルパスを,一つまたは二つ指定します。二つ指定する場合は間をスペースで区切ってください。三つ以上指定するとコマンドは失敗します。
- /o
結果出力ファイルのフルパスを指定します。処理キーが「NETM_SUSPEND」または「NETM_RESUME」の場合は,必ず指定してください。処理キーが「NETM_MANSUSP」または「NETM_MANRESU」の場合は,指定しても無視されます。
「NETM_SUSPEND」または「NETM_RESUME」を指定した場合,コマンドが正常終了すると,指定した結果出力ファイルに次の項目が出力されます。結果出力ファイルがすでに存在する場合は上書きされます。
/sを指定した場合の結果出力ファイルは,dcmjexeコマンドのパラメタファイルとして使用することもできます。また,/sを指定しなかった場合の結果出力ファイルは,dcmjbrmコマンド,dcmrtryコマンド,およびdcmstatコマンドのパラメタファイルとして使用することもできます。
- /LC
タスクスケジューラやJP1/AJSを使用してコマンドをバックグラウンドサービスとして実行している場合にWindowsをログオフしても,コマンド処理を継続するかどうかを「ON」または「OFF」で指定します。
- ON
Windowsをログオフしても,コマンド処理を継続します。
- OFF
Windowsをログオフすると,コマンド処理を強制終了します。
この引数は,次に示すOSでコマンドをサービスから実行した場合に,有効となります。
- Windows 2000
- Windows XP
- Windows Server 2003(Windows Server 2003 (IPF)を除く)
コマンドプロンプトからコマンドを実行する場合は,フォアグラウンドプログラムとして実行されるため,「/LC ON」を指定しないでください。
Windowsをログオフしてもコマンド処理を継続するかどうかは,レジストリでも設定できます。レジストリでの設定については,マニュアル「構築ガイド」の「4.6 レジストリの設定(JP1/NETM/DM Manager)」を参照してください。
なお,/LCでの指定と,レジストリでの設定の組み合わせで,動作が異なります。詳細については,「4.28 レジストリ設定とログオフオプションによるログオフ時のコマンドの動作」を参照してください。
(4) パラメタファイルの指定内容とコマンド引数との対応
このコマンドで使用できるパラメタファイルの内容は,コマンドの引数で指定することもできます。パラメタファイルの指定内容と,コマンドの引数との対応を次の表に示します。
表4-21 パラメタファイルとコマンドの引数の対応(dcmsuspコマンド)
パラメタファイルの指定内容 | 内容 | 指定の有無 | コマンドの引数 |
---|
タグ | パラメタ |
---|
JOB_ATTRIBUTE | job_generator | ジョブ名称 | ○※1 | /j 値 |
jobno | ジョブ番号 | × | - |
job_folder | ジョブ格納フォルダパス | ○ | /l 値 |
unsuspended | 中断中の配布の有無 | × | - |
JOB_DESTINATION | group | あて先グループ名 | ◎※2 | /g 値 |
host_name | ホスト名 | ◎※2 | /h 値 |
lower_clients | すべてのあて先指定の有無 | × | - |
JOB_DESTINATION_ID | destination_id | ID名 | ◎※2 | /X 値 |
JOB_SCHEDULE | job_entry_date | ジョブの登録日時 | ○ | /jst 値 |
job_execution_date | ジョブの実行日時 | ○ | /jsx 値 |
job_expiration_date | ジョブの実行期限 | ○ | /jsp 値 |
- (凡例)
- ◎:必ず指定する ○:省略できる ×:不要(指定しても無視される)
- -:コマンドの引数では指定できない
- 注※1
- job_generator(または/j)の指定を省略した場合,ジョブ名称として「処理キー+ジョブの実行日時」が自動的に設定されます。このため,同じ処理キーのコマンドを同時に複数実行すると,ジョブ名称が重複しジョブが正しく実行されないことがあります。同じ処理キーのコマンドを同時に複数実行する場合は,job_generator(または/j)で,異なるジョブ名称を指定することをお勧めします。
- 注※2
- JOB_DESTINATIONとJOB_DESTINATION_ID,/gおよび/hと/Xは,同時に指定できません。どちらかを必ず指定してください。groupとhost_name(/gと/h)は片方だけでも,両方同時に指定してもかまいません。
(5) リターンコード
dcmsuspコマンド実行時のリターンコードを次の表に示します。
コード | 意味 | 対処 |
---|
0 | 配布管理システムがジョブを開始した。または,配布管理システム自身の中断状態を変更した。 | なし。 |
1 | パラメタファイルをオープンできない,またはファイル形式に誤りがある。 | パラメタファイルの指定または記述形式を確認してください。 |
2 | コマンドの引数またはパラメタファイルに不正な値が設定されている。 | コマンドの引数またはパラメタファイルの設定値を確認してください。 |
3 | 配布管理システムへの接続でエラーが発生した。 | 配布管理システムのバージョンを確認してください。 |
4 | 結果出力ファイルをオープンできない。 | 結果出力ファイルの指定を確認してください。 |
5 | クライアント,配布管理システム間の通信に失敗した。 | 配布管理システムのセットアップで,通信環境の設定を確認してください。 |
12 | そのほかのエラーが発生した。 | イベントログを参照してください。 システムエラー,コマンドの引数の文法不正,または接続先配布管理システムに定義されていない値がパラメタファイルに指定され処理が拒否された,などの原因が考えられます。 |
また,JP1/Baseと連携してJP1/NETM/DMのユーザを管理している場合は,「1.3.3 コマンドを実行するための設定」も合わせて参照してください。
(6) 注意事項
JOB_DESTINATIONタグのhost_nameまたはコマンド引数の/hの指定時には,次のことに注意してください。
- ホスト識別子を使用している環境で,host_nameまたは/hに,ホスト名またはIPアドレスを指定した場合は,指定したホスト名またはIPアドレスをホスト識別子に引き当ててジョブが実行されます。
- host_nameまたは/hに指定した,ホスト名またはIPアドレスのノードがシステム構成に存在しない場合は,指定されたあて先名称でジョブが実行されます。この場合,ジョブが正常終了してもシステム構成にあて先ノードが存在しないため,リモートインストールマネージャなどであて先ノードの中断状態を確認することはできません。
- host_nameまたは/hに指定したホスト名またはIPアドレスのノードがシステム構成に複数存在する(ホスト識別子の異なる同名ノードが存在する)場合は,該当するすべての中継するシステムに対してジョブが実行されます。同名ノードの一部に対してジョブを実行したい場合は,実行したいあて先をあて先グループとして登録し,そのあて先グループに対してジョブを実行してください。
JOB_ATTRIBUTEタグのjob_folderまたはコマンド引数の/lの指定時には,次のことに注意してください。
- ジョブ格納フォルダパスに[ジョブ定義]ウィンドウで定義されていないフォルダを指定してコマンドを実行した場合,指定されたフォルダが作成されます。作成されたジョブ格納フォルダは,実行後も削除されないで残ります。使用しない場合は,ジョブが完了したら削除してください。