配布タスク停止

登録済みの配布タスクを停止します。

配布タスク種別がputの場合は、エージェントのステータスも実行中(running)から停止中(stopped)に更新します。配布タスクを終了状態とするだけで、エージェントで実行中のタスクの停止は行いません。

配布タスク種別がgetの場合、受け付け可能状態の配布タスクを停止し、エージェントからの配布リクエストを受け付け不可な状態とします。配布タスクを受け付け不可状態とするだけで、エージェントで実行中のタスクの停止は行いません。

書式

DistributionCmd --task --stop --id:<配布タスクID>

必須オプション

  • --task, -t
    配布タスクに対する操作時に指定します。

  • --stop, -O
    停止操作時に指定します。

  • --id, -i
    停止する配布タスクIDを指定します。
    (配布タスク登録時に返却された配布タスクIDを指定します。)

戻り値

成功時には、０を返します。失敗時には、０以外を返します。

戻り値 説明
0 正常終了です。
1 パラメータエラーです。
2 コマンドは既に実行中です。
3 マネージャに接続できません。
4 該当の配布タスクが存在しません。
5 該当の配布タスクが実行中(running)または受付中(started)ではありません。
254 サービスのエラーです。
255 その他の異常終了です。

注意事項

  • 配布タスク種別がputの場合、ステータスが実行中(running)の配布タスクを停止できます。

  • 配布タスク種別がgetの場合、ステータスが受付中(started)の配布タスクを停止できます。

メッセージ

正常終了時は標準出力に「Success.」を出力します。

$ DistributionCmd --task --stop --id:"T160901001"
Success.

エラー時は標準エラー出力に以下のメッセージを表示します。

戻り値 メッセージ
1 
Invalid parameter.
2 
DistributionCmd is already started.
3 
Failed to connect to the manager. Error code is XX.
YY
(XXはエラーコード、YYはエラーメッセージ)
4 
The task is not exist.
5 
Invalid status.
254 
Service error. Error code is XX.
(XXはエラーコード)
255 
Internal error. Error code is XX.
(XXはエラーコード)