Skip to main content

Dell Unity™ Family Unisphere® Command Line Interface User Guide

PDF

Create task rules

Create a task rule and add to an existing schedule. If a schedule does not exist, a new one is created.

NOTE: gmtoff switch cannot be used if user already configured schedule time zone.

Format

/sys/task/rule create {–schedId <value> | -schedName <value>} -type {hoursinterval -every <value> [-at <value>] | hourslist -hours <value> [-at <value>] | daysinterval -every <value> [-at <value>] | weekdayslist -days <value> [-at <value>] | monthdayslist -days <value> [-at <value>]} [{-keepFor <value> | -allowAutoDelete {yes | no}}] [-access {ckpt | share}] [-syncRep {yes | no}]

Action qualifiers

Qualifier	Description
-schedId	Type the ID of an existing protection schedule to which to assign the rule. View protection schedules explains viewing details about existing schedules, including their IDs.
-schedName	Type a name for a new protection schedule to which to assign the rule.
-type	Specify the type of rule, which indicates how often the task will execute. Valid values are: hoursinterval — Task executes on an interval of the specified number of hours or minutes within an hour. hourslist — Task executes everyday on the specified hours and, optionally, on a specific minute within the specified hour. Supports up to two specified hours. daysinterval — Task executes on an interval of the specified number of days and, optionally, on a specific hour of each specified day. weekdayslist— Task executes on the specified days of the week or on a specific hour of each specified day. Supports up to seven specified values, including all the days in a week. monthdayslist— Task executes each month on a specified day and time. Supports one day value only.
-every (used with -type)	If the value of -type is hoursinterval or daysinterval, type the time interval when the task will execute. Valid values are: hoursinterval — Number of hours within the range 1 - 24. daysinterval — Number of days within the range 1 - 31.
-hours (used with -type)	If the value of -type is hourslist, type a comma-separated list of the hours of the day when the task will execute. The range is 0 - 23.
-at (used with -type)	Type the specific number of minutes of an hour and the minutes of a day when the task will execute based on the value of -type. Valid values are: hoursinterval or hourslist - Type the number of minutes after the hour within the range 0 - 59. Default is 0. daysinterval, weekdayslist, or monthdayslist - Type the time of a day in the following format: <`HH`>[:`MM`] where `HH` is the hour of the day and `MM` represents the minutes within the specified hour. Value range is 0:00 - 23:59. Default value is 0:00.
-days (used with -type)	If the value of -type is weekdayslist or monthdayslist, type the days of the week or the day of the month when the task will execute: weekdayslist— Type a comma-separated list of the days of the week. Valid values are: mon — Monday tue — Tuesday wed — Wednesday thu — Thursday fri — Friday sat — Saturday sun — Sunday monthdayslist — Type the day of the month within the range 1 – 31. NOTE:For monthdayslist, you can specify only one day of the month.
-keepFor	Type the number of days or hours the system will retain a snapshot before deleting it. Use the following format: <`value`>[<`qualifier`>] where: `value` — Type the number of hours or days. Value is: hours — Number of hours within the range 1 - 8760. days — Number of days within the range 1 - 365. `qualifier` — Type the value qualifier. Value is one of the following: h — Indicates hours. d — Indicates days. Default value is 1h (1 hour).
-allowAutoDelete	Specify whether the system can automatically delete the snapshot or snapshot set. Valid values are: yes (default) no
-access	Specify whether the snapshot is a read-only checkpoint, or read/write for CIFS (SMB) shares or NFS exports. Valid values are: ckpt (default) share
-syncRep	Specify whether this schedule is synchronously replicated. All changes done to the replicated schedule on the local system apply to the remote system automatically and conversely. Valid values are: yes no NOTE: If a synchronous remote connection is established, the default value is yes, otherwise it is no.

Example 1

The following command creates a task rule with these settings:

Assigns the rule to the new protection schedule MyScheduleID.
Takes a snapshot every 12 hours and 30 minutes.
Keeps the snapshot for 10 hours before deleting it:

uemcli -d 10.0.0.1 -u Local/joe -p MyPassword456! /sys/task/rule create –schedName MyScheduleID -type hoursinterval -every 12 –at 30 –keepFor 10h

Storage system address: 10.0.0.1
Storage system port: 443
HTTPS connection

ID = RULE_1
Schedule ID = MyScheduleID
Operation completed successfully.

Example 2

The following command creates a task rule with these settings:

Assigns the rule to the existing protection schedule MySchedID.
Takes a snapshot everyday at 8:30 a.m., and 8:30 p.m.:

uemcli -d 10.0.0.1 -u Local/joe -p MyPassword456! /sys/task/rule create –schedId MySchedID -type hourslist –hours “8,20” –at 30

Storage system address: 10.0.0.1
Storage system port: 443
HTTPS connection

ID = RULE_2
Operation completed successfully.

Example 3

The following command creates a task rule with these settings:

Assigns the rule to the existing protection schedule MySchedID.
Takes a snapshot every 2 days at 1:20 p.m.
Keeps the snapshot for 1 week (7 days) before deleting it:

uemcli -d 10.0.0.1 -u Local/joe -p MyPassword456! /sys/task/rule create –schedId MySchedID -type daysinterval -every 2 –at 13:20 –keepFor 7d

Storage system address: 10.0.0.1
Storage system port: 443
HTTPS connection

ID = RULE_3
Operation completed successfully.

Example 4

The following command creates a task rule with these settings:

Assigns the rule to the existing protection schedule MySchedID.
Takes a snapshot every Monday, Wednesday, and Friday at 6 a.m.:

uemcli -d 10.0.0.1 -u Local/joe -p MyPassword456! /sys/task/rule create –schedId MySchedID -type weekdayslist -days “Mon,Wed,Fri” –at 6

Storage system address: 10.0.0.1
Storage system port: 443
HTTPS connection

ID = RULE_4
Operation completed successfully.

Example 5

The following command creates a task rule with these settings:

Assigns the rule to the existing protection schedule MySchedID.
Takes a snapshot on the first day of every month at 12 p.m.:

uemcli -d 10.0.0.1 -u Local/joe -p MyPassword456! /sys/task/rule create –schedId MySchedID -type monthdayslist -days 1

Storage system address: 10.0.0.1
Storage system port: 443
HTTPS connection

ID = RULE_5
Operation completed successfully.

Example 6

The following command creates a task rule with these settings:

Assigns the rule to the existing protection schedule MySchedID.
Takes a snapshot on the first day of every month at 12 p.m. to the existing schedule by using gmtoff switch:

uemcli -d 10.0.0.1 -u Local/joe -p MyPassword456! -gmtoff -4 /sys/task/rule create –schedId MySchedID -type monthdayslist -days 1

Storage system address: 10.0.0.1
Storage system port: 443
HTTPS connection

Operation failed. Error code: 0x6401f5e
"-gmtoff" is not allowed when schedule time zone is configured. Either remove it or clear schedule time zone. (Error Code:0x6401f5e)