Tiered Storage Manager Software CLI リファレンスガイド

5.6.2 ModifyTask

ModifyTaskコマンドは，タスクの情報（タスクの説明文およびイベント通知先のアドレス）を変更します。

次の状態のタスクは情報を変更できません。

終了状態（End）であるタスク

リフレッシュの状態が「実行中」または「終了（失敗）」であるストレージドメインの中にあるタスク

この項の構成

(1) 記述形式

(2) オプション

(3) パラメーター

(4) 出力項目

(5) コマンド指定例と実行結果

(1) 記述形式

  
htsmcli [ サーバのロケーション] ModifyTask
    [ 共通オプション ]
    [ { -d | --detail } ]
    id=タスクID
    [ newnotifytourl=イベント通知先アドレス ]
    [ newdescription=タスクの説明文 ]

(2) オプション

-dまたは--detail

CLIコマンド実行後に，詳細情報を標準出力に表示したいときに指定します。

省略した場合，標準出力には何も表示されません。

(3) パラメーター

表5-59 ModifyTaskコマンドのパラメーター

パラメーター名説明

id タスクIDを指定します。
タスクIDは，GetTasksコマンドなどで，タスクの情報が出力される時にID属性として表示されます。

[newnotifytourl] イベント発生時に，イベントを通知する先のアドレスを指定します。省略時には，イベント通知先のアドレスは変更されません。
アドレスは，"mailto:"とメールアドレス文字列を合わせた値で指定します。
空文字列を指定すると，以前に設定したイベント通知先のアドレスの内容は消去されます。

[newdescription] タスクの説明文を指定します。省略時には，タスクの説明文は変更されません。空文字列を指定すると，以前に設定したタスクの説明文は消去されます。

（凡例）

[ ]：指定は任意です。

パラメーター名	説明
`id`	タスクIDを指定します。タスクIDは，`GetTasks`コマンドなどで，タスクの情報が出力される時にID属性として表示されます。
[`newnotifytourl`]	イベント発生時に，イベントを通知する先のアドレスを指定します。省略時には，イベント通知先のアドレスは変更されません。アドレスは，"`mailto:`"とメールアドレス文字列を合わせた値で指定します。空文字列を指定すると，以前に設定したイベント通知先のアドレスの内容は消去されます。
[`newdescription`]	タスクの説明文を指定します。省略時には，タスクの説明文は変更されません。空文字列を指定すると，以前に設定したタスクの説明文は消去されます。

(4) 出力項目

ModifyTaskコマンドは，複数種類のタスクのプロパティを変更できます。そのため，タスクの種類によって出力項目が変わります。

出力項目はタスク作成時と同じです。

マイグレーションタスク：CreateMigrationTaskコマンドの「(4) 出力項目」を参照してください。

ロッキングタスク：CreateLockingTaskコマンドの「(4) 出力項目」を参照してください。

アンロッキングタスク：CreateUnlockingTaskコマンドの「(4) 出力項目」を参照してください。

シュレッディングタスク：CreateShreddingTaskコマンドの「(4) 出力項目」を参照してください。

(5) コマンド指定例と実行結果

コマンド指定例：
タスクIDがTK1f2lymqvのマイグレーションタスクの説明文を変更します。
```
  
htsmcli ModifyTask --detail id="TK1f2lymqv" newdescription="This property was changed."
  
```

実行結果：

  
RESPONSE:
An instance of Task(1 of 1)
  ID=TK1f2lymqv
  taskType=Migration
  status=Standby
  timeEstimate=0:02:02
  creationTime=2014/01/25 16:53:11
  endTime=
  ownerID=user
  storageDomainName=MegaTechUSP600-Primary
  migrationGroupName=MG011
  previousTargetStorageTierName=
  targetStorageTierName=MegaTech-HighCost
  eraseData=No
  zeroDataDiscard=No
  notifyToURL=mailto:test@example.com
  description=This property was changed.
  List of 2 MigrationInfo elements:
    An instance of MigrationInfo(1 of 2)
      sourceControllerDeviceNumber=3:A6
      targetControllerDeviceNumber=2:80
      timeEstimate=0:01:01
    An instance of MigrationInfo(2 of 2)
      sourceControllerDeviceNumber=3:A7
      targetControllerDeviceNumber=2:84
      timeEstimate=0:01:01

[目次] [前へ] [次へ]