Create consistency group

The create consistencyGroup command creates a new, empty consistency group that can contain snapshot groups. You must add the snapshot groups using the set consistencyGroup addCGMember command.

Supported Arrays

This command applies to any individual storage array, including the E2700, E5600, E2800, E5700, EF600 and EF300 arrays, as long as all SMcli packages are installed.

Roles

To execute this command on an E2800, E5700, EF600, or EF300 storage array, you must have the Storage Admin role.

Syntax

create consistencyGroup userLabel="consistencyGroupName" 
[repositoryFullPolicy=(failBaseWrites | purgeSnapImages)] 
[repositoryFullLimit=percentValue] 
[autoDeleteLimit=numberOfSnapImages] 
[enableSchedule=(TRUE | FALSE)] 
[schedule (immediate | snapSchedule)] 
[rollbackPriority=(lowest | low | medium | high | highest)]

Parameters

Parameter Description
userLabel The name of the new consistency group that you want to create. Enclose the new consistency group name in double quotation marks (" ").
repositoryFullPolicy How you want snapshot processing to continue if the snapshot repository volumes are full. You can choose to fail writes to the base volume (failBaseWrites) or delete (purge) the snapshot images (purgeSnapImages). The default action is purgeSnapImages.
repositoryFullLimit

The percentage of repository capacity at which you receive a warning that the snapshot repository volume is nearing full. Use integer values. For example, a value of 70 means 70 percent. The default value is 75.

autoDeleteLimit

Each snapshot group can be configured to perform automatic deletion of its snapshot images to keep the total number of snapshot images in the snapshot group at or below a designated level. When this option is enabled, then any time a new snapshot image is created in the snapshot group, the system automatically deletes the oldest snapshot image in the group to comply with the limit value. This action frees repository capacity so it can be used to satisfy ongoing copy-on-write requirements for the remaining snapshot images.

enableSchedule

Whether the ability to schedule a snapshot operation is turned on or turned off. To turn on snapshot scheduling, set this parameter to TRUE. To turn off snapshot scheduling, set this parameter to FALSE.

rollBackPriority

Determines whether system resources should be allocated to the rollback operation at the expense of system performance. A value of high indicates that the rollback operation is prioritized over all other host I/O. A value of low indicates that the rollback operation should be performed with minimal impact to host I/O.

Notes

A consistency group is a logical entity that enables you to manage in batch form all of the snapshot images that you add to the collection. The consistency group is a collection of snapshot groups that have mutual consistency requirements or dependencies for their snapshot images. Any snapshot images that you create and use for this collection must be managed in accordance with the consistency dependencies.

You can use any combination of alphanumeric characters, underscore (_), hyphen (-), and pound (#) for the names. Names can have a maximum of 30 characters.

The snapshot images in a consistency group can be deduced based on the existence of a snapshot image within a consistency group. All snapshot images that reside within a consistency group share a common time stamp and sequence number.

An operation on a snapshot image consistency group is treated as a single request, and causes all pending I/O operations to the associated base volume of each member to be drained and suspended before creating the snapshot images. If creation of the snapshot images cannot be completed successfully for all of the consistency group members, the operation fails and has no affect (that is, new snapshot images are not created).

Based on this behavior all members for a consistency group usually have the same number of snapshot images. However, when a new member is added to a consistency group, that new member lacks the snapshot images that were previously created on the established members of the consistency group. The lack of snapshot images is not considered an error condition. Ensuing requests for deletion or rollback of snapshot images that only exist on a subset of the consistency group members will only affect the members for which the specified snapshot images actually exists.

Auto delete

You can configure each snapshot group to automatically delete its snapshot images to keep the total number of snapshot images in the snapshot group at or below a maximum number of images. When the number of snapshot images in the snapshot group is at the maximum limit, the autoDeleteLimit parameter automatically deletes snapshot images whenever a new snapshot image is created in the snapshot group. The autoDeleteLimit parameter deletes the oldest snapshot images in the snapshot group until the maximum number of images defined with the parameter is met. This has the effect of freeing repository capacity so it can be used to satisfy ongoing copy-on-write requirements for the remaining snapshot images.

Scheduling snapshot images in a consistency group

The enableSchedule parameter and the schedule parameter provide a way for you to schedule snapshots. Using these parameters, you can schedule snapshots daily, weekly, or monthly (by day or by date). The enableSchedule parameter turns on or turns off the ability to schedule snapshots. When you enable scheduling, you use the schedule parameter to define when you want the snapshots to occur.

This table explains how to use the options for the schedule parameter:

Parameter Description
schedule Required for specifying schedule parameters.
immediate Start the operation immediately. This item is mutually exclusive with any other scheduling parameters.
enableSchedule
When set to true, scheduling is turned on. When set to false, scheduling is turned off.
Note: The default is false.
startDate A specific date on which to start the operation. The format for entering the date is MM:DD:YY. The default is the current date. An example of this option is startDate=06:27:11.
scheduleDay A day of the week on which to start the operation. Can either be all or one or more of the following values:
  • monday
  • tuesday
  • wednesday
  • thursday
  • friday
  • saturday
  • sunday
Note: Enclose the value in parentheses. For example, scheduleDay=(wednesday).

More than one day can be specified by enclosing the days in a single set of parentheses and separating each day with a space. For example, scheduleDay=(monday wednesday friday).

Note: This parameter is not compatible with a monthly schedule.
startTime The time of a day on which to start the operation. The format for entering the time is HH:MM, where HH is the hour and MM is the minute past the hour. Uses a 24-hour clock. For example, 2:00 in the afternoon is 14:00. An example of this option is startTime=14:27.
scheduleInterval An amount of time, in minutes, to have as a minimum between operations.

Schedule interval should not be more than 1440 (24 hours) and it should be a multiple of 30.

An example of this option isscheduleInterval=180.
endDate A specific date on which to stop the operation. The format for entering the date is MM:DD:YY. If no end date is desired, you can specify noEndDate. An example of this option is endDate=11:26:11.
timesPerDay The number of times to perform the operation in a day. An example of this option is timesPerDay=4.
timezone Specifies the time zone to be used for the schedule. Can be specified in two ways:
GMT±HH:MM
The time zone offset from GMT. Example: timezone=GMT-06:00.
Text String
Standard time zone text string, must be enclosed in quotes. Example:timezone="America/Chicago"
scheduleDate A day of the month on which to perform the operation. The values for the days are numerical and in the range of 1-31.
Note: This parameter is not compatible with a weekly schedule.
An example of the scheduleDate option is scheduleDate=("15").
month A specific month on which to perform the operation. The values for the months are:
  • jan - January
  • feb - February
  • mar - March
  • apr - April
  • may - May
  • jun - June
  • jul - July
  • aug - August
  • sep - September
  • oct - October
  • nov - November
  • dec - December
Note: Enclose the value in parentheses. For example, month=(jan).

More than one month can be specified by enclosing the months in a single set of parentheses and separating each month with a space. For example, month=(jan jul dec).

Use this parameter with the scheduleDate parameter to perform the operation on a specific day of the month.

Note: This parameter is not compatible with a weekly schedule.

This table explains how to use the timeZone parameter:

Timezone Name GMT offset
Etc/GMT+12 GMT-12:00
Etc/GMT+11 GMT-11:00
Pacific/Honolulu GMT-10:00
America/Anchorage GMT-09:00
America/Santa_Isabel GMT-08:00
America/Los_Angeles GMT-08:00
America/Phoenix GMT-07:00
America/Chihuahua GMT-07:00
America/Denver GMT-07:00
America/Guatemala GMT-06:00
America/Chicago GMT-06:00
America/Mexico_City GMT-06:00
America/Regina GMT-06:00
America/Bogota GMT-05:00
America/New_York GMT-05:00
Etc/GMT+5 GMT-05:00
America/Caracas GMT-04:30
America/Asuncion GMT-04:00
America/Halifax GMT-04:00
America/Cuiaba GMT-04:00
America/La_Paz GMT-04:00
America/Santiago GMT-04:00
America/St_Johns GMT-03:30
America/Sao_Paulo GMT-03:00
America/Buenos_Aires GMT-03:00
America/Cayenne GMT-03:00
America/Godthab GMT-03:00
America/Montevideo GMT-03:00
Etc/GMT+2 GMT-02:00
Atlantic/Azores GMT-01:00
Atlantic/Cape_Verde GMT-01:00
Africa/Casablanca GMT
Etc/GMT GMT
Europe/London GMT
Atlantic/Reykjavik GMT
Europe/Berlin GMT+01:00
Europe/Budapest GMT+01:00
Europe/Paris GMT+01:00
Europe/Warsaw GMT+01:00
Africa/Lagos GMT+01:00
Africa/Windhoek GMT+01:00
Asia/Anman GMT+02:00
Asia/Beirut GMT+02:00
Africa/Cairo GMT+02:00
Asia/Damascus GMT+02:00
Africa/Johannesburg GMT+02:00
Europe/Kiev GMT+02:00
Asia/Jerusalem GMT+02:00
Europe/Istanbul GMT+03:00
Europe/Minsk GMT+02:00
Asia/Baghdad GMT+03:00
Asia/Riyadh GMT+03:00
Africa/Nairobi GMT+03:00
Asia/Tehran GMT+03:30
Europe/Moscow GMT+04:00
Asia/Dubai GMT+04:00
Asia/Baku GMT+04:00
Indian/Mauritius GMT+04:00
Asia/Tbilisi GMT+04:00
Asia/Yerevan GMT+04:00
Asia/Kabul GMT+04:30
Asia/Karachi GMT+05:00
Asia//Tashkent GMT+05:00
Asia/Calcutta GMT+05:30
Asia/Colombo GMT+05:30
Asia/Katmandu GMT+05:45
Asia/Yekaterinburg GMT+06:00
Asia/Almaty GMT+06:00
Asia/Dhaka GMT+06:00
Asia/Rangoon GMT+06:30
Asia/Novosibirsk GMT+07:00
Asia/Bangkok GMT+07:00
Asia/Krasnoyarsk GMT+08:00
Asia/Shanghai GMT+08:00
Asia/Singapore GMT+08:00
Australia/Perth GMT+08:00
Asia/Taipei GMT+08:00
Asia/Ulaanbaatar GMT+08:00
Asia/Irkutsk GMT+09:00
Asia/Tokyo GMT+09:00
Asia/Seoul GMT+09:00
Australia/Adelaide GMT+09:30
Australia/Darwin GMT+09:30
Asia/Yakutsk GMT+10:00
Australia/Brisbane GMT+10:00
Australia/Sydney GMT+10:00
Pacific/Port Moresby GMT+10:00
Australia/Hobart GMT+10:00
Asia/Vladivostok GMT+11:00
Pacific/Guadalcanal GMT+11:00
Pacific/Auckland GMT+12:00
Etc/GMT-12 GMT+12:00
Pacific/Fiji GMT+12:00
Asia/Kamchatka GMT+12:00
Pacific/Tongatapu GMT+13:00

The code string for defining a schedule is similar to these examples:

enableSchedule=true schedule startTime=14:27
enableSchedule=true schedule scheduleInterval=180
enableSchedule=true schedule timeZone=GMT-06:00
enableSchedule=true schedule timeZone="America/Chicago"

If you also use the scheduleInterval option, the firmware chooses between the timesPerDay option and the scheduleInterval option by selecting the lowest value of the two options. The firmware calculates an integer value for the scheduleInterval option by dividing 1440 by a the scheduleInterval option value that you set. For example, 1440/180 = 8. The firmware then compares the timesPerDay integer value with the calculated scheduleInterval integer value and uses the smaller value.

To remove a schedule, use the delete volume command with the schedule parameter. The delete volume command with the schedule parameter deletes only the schedule, not the snapshot volume.

When performing a rollback in a consistency group, the default operation is to rollback all members of the consistency group. If a rollback cannot be started successfully for all of the members in the consistency group, the rollback fails and has no effect. The snapshot image is not rolled back.

Minimum firmware level

7.83

7.86 adds the scheduleDate option and the month option.