A.1 DM コマンドの概要
A.1.10 指示要求のキャンセル
DMに対し、以下の指示要求のキャンセル要求を行います。
・ソフトウェアの配信
・ソフトウェアの適用
・ソフトウェアの配信および適用
・ソフトウェアの集信
・BACKUPの復元
A.1.10.1 指示要求のキャンセル（dmcancel）
コマンド形式:
●Format Type 1
dmcancel [-m name] -f1 infile [-o outfile] [-e {stop|cont}] [-t time]
[-i interval]
●Format Type 2
dmcancel [-m name] -reqid <reqid1>[,<reqid2>[,…]] [-o outfile] [-e {stop|cont}]
[-t time] [-i interval]
機能説明:
入力ファイルのパラメータ、またはオプションに指定したIDに従って、キャンセル要求を 発行します。このとき、キャンセル処理の対象となる要求種別は以下の通りです。
・ソフトウェアの配信
・ソフトウェアの適用
・ソフトウェアの配信および適用
・ソフトウェアの集信
・BACKUPの復元
要求先のDMマネージャ名を指定します。
省略時はローカルコンピュータに接続します。
-f1 infile
入力するパラメータファイル（Format Type 1形式）の名前を指定します。
指示要求発行コマンド(dmreq)の結果出力ファイルを指定可能です。
Format Type 1 形式で指定する場合、省略できません。
-reqid オプションを同時に指定した場合はエラーとします。
-reqid <reqid1>[,<reqid2>[,…]]
キャンセル対象の要求ID（Format Type 2形式）を直接指定します。
要求IDとは、マネージャが指示要求を受け付けた際に払い出されるIDのことです。
指示要求の発行コマンド(dmreq)の結果、または処理要求一覧にて確認してください。
要求IDを複数指定する場合は、要求ID間をカンマで区切ってください。
指定する要求IDは、大文字、小文字を区別しません。
Format Type 2 形式で指定する場合、省略できません。
-f1オプションを同時に指定した場合はエラーとします。
-o outfile
結果情報を出力するファイル名を指定します。
省略時は、コンソールに出力します。
-e {stop|cont}
実行時の動作を指定します。
stop エラーを検出した時点で処理を停止します。
停止するまでに行われた処理は、有効になります。
cont エラーを検出した場合も次のパラメータの処理を継続します。
省略時はstop指定と見なします。
-t time
処理完了待ち時間を秒単位(10進数)で指定します。
0を指定した場合、タイムアウト監視は行わず、処理完了まで待ち合わせを行います。
省略時も処理完了まで待ち合わせを行います。
-i interval
処理完了結果のチェック間隔を秒単位(10進数)で指定します。
0を指定した場合、エラーとします。
省略時は10を指定したものと見なします。
-t オプションを指定せずに本オプションを指定した場合、または -tオプションで指定し た値以上の値を指定した場合はエラーとします。
入力パラメータのフォーマット:
●Format Type 1 [1]行番号, [2]要求 ID
要求種別 1 2 キャンセル △ ◎
◎：必須 △：任意（省略可） −：無効
１ 項目名 行番号
設定値 パラメータファイルの行番号
省略 省略可
備考 指示要求発行コマンド(dmreq)の結果出力ファイルをそのまま利用可能 とするためのフィールドです。ここで指定された値はキャンセル処理の 中では利用されません。
２ 項目名 要求 ID
設定値 マネージャが指示要求を受け付けた際に払い出される ID
省略 省略不可
備考 指示要求の発行コマンド(dmreq)の結果、または処理要求一覧より取得
結果出力フォーマット:
処理した入力パラメータ毎の処理結果を指定ファイルに順次出力します。
[1]結果,[2]番号,[3]要求 ID,[4]クライアント名,[5]適用先名,[6]ファイル名,[7]リビジョン 名,[8]結果,[9]状態,[10]システム,[11]結果コード,[12]詳細コード,[13]理由
１ 結果 SUCCESS、WARNING、ERROR のいずれか。
２ 行番号 処理した入力パラメータの行番号(注 1) ３ キャンセル対象
要求 ID
キャンセル対象の要求 ID
４ クライアント名 クライアント名
５ 適用先名 適用先名
６ ファイル名 ファイル名 ７ リビジョン リビジョン
８ 結果 キャンセル指示の結果
９ 状態 キャンセル指示の状態
10 システム キャンセルを実行したシステム 11 結果コード 結果コード(16 進 8 桁(0xXXXXXXXX)) 12 詳細コード 結果詳細コード(16 進 8 桁(0xXXXXXXXX)) 13 理由 結果理由を示す文字列
(注 1) Format Type 2 の形式を指定した場合、何も表示しません。
コマンド実行結果:
コンソールにコマンド実行結果を以下の形式で出力します。
コマンド名 {SUCCESS | WARNING | ERROR}
実行結果文字列（結果コード）
［実行結果詳細文字列（詳細コード）］
コマンド返却値:
2 致命的１ パラメータの処理を中断しました。(結果出力有り。)
-e オプションに STOP を指定時、パラメータ処理に失敗した場合は このエラーとなります。
3 致命的２ コマンドの引数が不正です。(結果出力無し。) Usage をコンソールに表示します。
4 致命的３ 結果出力ができませんでした。
5 致命的４ 処理完了の待ち合わせに失敗しました。
パラメータ処理に失敗したものが含まれている場合もあります。
6 致命的５ 処理完了を待ち合わせましたが、処理完了結果に失敗したものが含 まれています。
パラメータ処理に失敗したものが含まれている場合もあります。
7 致命的６ 処理完了を待ち合わせましたが、指定した時間内に処理が完了しな かったためタイムアウトしました。
処理完了結果に失敗が含まれているもの、パラメータ処理に失敗し たものが含まれている場合もあります。
8 致命的７ 指定した要求 ID の書式が全て誤っています。
9 致命的８ 指定した要求 ID の要求種別は、全てキャンセル処理の対象外です。
10 致命的９ 指定した要求 ID の配布は、全てすでに完了しています。
11 致命的 10 指定した要求 ID にはキャンセル可能な対象が存在しません。
指定した要求 ID の配布はすでに完了しているか、またはキャンセル 処理の対象外の要求種別の ID を指定しています。
12 致命的 11 DMAPI バージョンが不正です。
13 致命的 12 上記以外のエラーが発生しました。