CLI Guide

set task
Description
Changes parameters for a TakeSnapshot or VolumeCopy task. For these types of tasks, you can
change parameters other than name, type, or associated volumes. If you change the parameters for a
running task, the changes will take effect the next time the task runs.
If you want to change parameters for a ResetSnapshot task or the name, type, or associated volumes
for another type of task, create a new task to replace the existing one.
Minimum role manage
Syntax
set task
[last-snapshot]
[replication-set]
[retention-count #]
[snapshot-prefix prefix]
name
Parameters
[last-snapshot]
Optional. For a Replicate task this specifies to replicate the most recent snapshot of the primary
volume. This snapshot may have been created either manually or by the snapshot history feature.
[replication-set]
Optional. For a Replicate task this specifies the ID of the replication set to replicate.
[retention-count #]
Optional. For a TakeSnapshot task this specifies the number of snapshots created by this task to
retain, from 1 to 8 if the large-pools feature is enabled, or from 1 to 16 if the large-pools feature
is disabled. When a new snapshot exceeds this limit, the oldest snapshot with the same prefix is
deleted. If you reduce the retention count for a task, excess snapshots will be removed the next time
the task runs.
[snapshot-prefix prefix]
Optional. For a TakeSnapshot task this specifies a label to identify snapshots created by this task.
Input rules:
● The value is case sensitive.
● The value can have a maximum of 32 bytes.
● The value can include spaces and printable UTF-8 characters except: " , < \
● A value that includes a space must be enclosed in double quotes.
name
The name of the task to change. Input rules:
● The value is case sensitive.
● The value can have a maximum of 32 bytes.
● The value can include spaces and printable UTF-8 characters except: " , < \
● A value that includes a space must be enclosed in double quotes.
Examples
Change parameters for a TakeSnapshot-type task named Snap.
# set task snapshot-prefix VD1v1 retention-count 2 Snap
See also
create task
delete task
set schedule
show schedules
show tasks
Alphabetical list of commands 157