Description
This command creates a snapshot virtual disk. When you use this command,
you can define the snapshot virtual disk in one of three ways:
- User-defined physical disks
- User-defined disk group
- User-defined number of physical disks for the snapshot virtual
disk
If you choose to define a number of physical disks, the RAID
controller module firmware chooses which physical disks to use for
the snapshot (legacy) virtual disk.
Syntax (User-Defined
Physical Disks)
create snapshotVirtualDisk baseVirtualDisk="
baseVirtualDiskName"
[repositoryRAIDLevel=(0 | 1 | 5 | 6)]
[repositoryPhysicalDisks=(
enclosureID1,slotID1 ... enclosureIDn,slotIDn)]
[repositoryDiskGroupUserLabel="
repositoryDiskGroupName"]
[enclosureLossProtect=(TRUE | FALSE)]
[freeCapacityArea=
freeCapacityIndexNumber]
[userLabel="
snapshotVirtualDiskName"]
[warningThresholdPercent=
percentValue]
[repositoryPercentOfBase=
percentValue]
[repositoryUserLabel="
repositoryName"]
[repositoryFullPolicy=(failBaseWrites | failSnapshot)]
[enableSchedule=(TRUE | FALSE)]
[schedule=(immediate |
snapshotSchedule)]
Syntax (User-Defined
Number Of Physical Disks)
create snapshotVirtualDisk baseVirtualDisk="
baseVirtualDiskName"
[repositoryRAIDLevel=(0 | 1 | 5 | 6)]
[repositoryPhysicalDiskCount=
numberOfPhysicalDisks ]
[repositoryDiskGroupUserLabel="
repositoryDiskGroupName"]
[physicalDiskMediaType=(HDD | SSD | unknown | allMedia)]
[physicalDiskType=(SAS)]
[enclosureLossProtect=(TRUE | FALSE)]
[userLabel="
snapshotVirtualDiskName"]
[warningThresholdPercent=
percentValue]
[repositoryPercentOfBase=
percentValue]
[repositoryUserLabel="
repositoryName"]
[repositoryFullPolicy=(failBaseWrites | failSnapshot)]
[enableSchedule=(TRUE | FALSE)]
[schedule=(immediate |
snapshotSchedule)]
Syntax (Existing Repository
Disk Group)
create snapshotVirtualDisk baseVirtualDisk="
baseVirtualDiskName"
[repositoryDiskGroup="
repositoryDiskGroupName"]
[repositoryUserLabel="
repositoryName"]
[freeCapacityArea=
freeCapacityIndexNumber]
[userLabel="
snapshotVirtualDiskName"]
[warningThresholdPercent=
percentValue]
[repositoryPercentOfBase=
percentValue]
[repositoryFullPolicy=(failBaseWrites | failSnapshot)]
[enableSchedule=(TRUE | FALSE)]
[schedule=(immediate |
snapshotSchedule)]
Parameters
Parameter |
Description |
baseVirtualDisk
|
The name of the base virtual disk from which you want to take
a snapshot (legacy). Enclose the base virtual disk name in double
quotation marks (" ").
|
repositoryRAIDLevel
|
Use this parameter when you create a new disk group.
The
RAID level for the snapshot (legacy) repository disk group. Valid
values are
0,
1,
5, or
6.
|
repositoryPhysicalDisks
|
Use this parameter when you create a new disk group.
The
physical disks that you want to assign to the snapshot (legacy) repository
disk group. Specify the enclosure ID value and the slot ID value for
each physical disk that you assign to the snapshot (legacy) repository
virtual disk. Enclosure ID values are
0 to
99. Slot ID values are
0 to
31. Enclose
the enclosure ID values and the slot ID values in parentheses.
|
repositoryPhysicalDiskCount
|
Use this parameter when you create a new disk group.
The
number of unassigned physical disks that you want to use for the snapshot
(legacy) repository disk group.
|
repositoryDiskGroupUserLabel
|
Use this parameter when you create a new disk group.
The
name of a new disk group to be used for the repository virtual disk.
Enclose the repository disk group name in double quotation marks (“
”).
|
repositoryDiskGroup
|
The name of an existing disk group where you want to place
the repository virtual disk. Use this parameter if you do not want
to put the repository virtual disk in the same disk group as the base
virtual disk. The default is to use the same disk group for both the
base virtual disk and the repository virtual disk. Enclose the name
of the repository disk group in double quotation marks (" ").
|
userLabel
|
The name that you want to give to the snapshots (legacy) virtual
disk. If you do not want to provide a name, the CLI creates a name
using the base virtual disk user label that you provide.
|
enclosureLossProtect
|
The setting to enforce enclosure loss protection when you create
the snapshot (legacy) repository virtual disk. To enforce enclosure
loss protection, set this parameter to
TRUE. The default
setting is
FALSE.
|
physicalMediaType
|
The type of physical disk media that you want to use for the
disk group. Valid physical disk media consists of:
-
HDD—Use this option when you have hard physical
disks in the expansion enclosure.
-
SSD—Use this option when you have solid state physical
disks in the expansion enclosure.
-
unknown—Use if you are not sure what types of physical
disk media are in the expansion enclosure.
-
allMedia—Use this option when you want to use all
types of physical disk media that are in the expansion enclosure.
Use this parameter when you use the
repositoryPhysicalDiskCount parameter.
You must use this parameter when you have more
than one type of physical disk media in your storage array.
|
physicalDiskType
|
The type of physical disk that you want to use in the virtual
disk. You cannot mix physical disk types.
You must use this parameter
when you have more than one type of physical disk in your storage
array.
The valid physical disk type is
SAS. You
must specify a physical disk type. Use this parameter when you use
the
repositoryPhysicalDiskCount parameter.
|
freeCapacityArea
|
The index number of the free space in an existing disk group
that you want to use to create the snapshot (legacy) repository virtual
disk. Free capacity is defined as the free capacity between existing
virtual disks in a disk group. For example, a disk group might have
the following areas: virtual disk 1, free capacity, virtual disk 2,
free capacity, virtual disk 3, free capacity. To use the free capacity
following virtual disk 2, you specify:
freeCapacityArea=2
Use the
show diskGroup command to determine if free
capacity area exists.
|
warningThresholdPercent
|
The percentage of repository capacity at which you receive
a warning that the snapshot (legacy) repository is nearing full. Use
integer values. For example, a value of
70 means 70
percent. The default value is
50.
|
repositoryPercentOfSource
|
The size of the snapshot (legacy) repository virtual disk as
a percentage of the source virtual disk. Use integer values. For example,
a value of
40 means 40 percent. The default value is
20.
|
repositoryUserLabel
|
The name to give to the snapshot (legacy) repository virtual
disk. Enclose the snapshot (legacy) repository virtual disk name in
double quotation marks (" ").
|
repositoryFullPolicy
|
Specifies how snapshot (legacy) processing continues if the
snapshot (legacy) repository is full. You can choose to fail writes
to the base virtual disk (
failBaseWrites) or fail the
snapshot (legacy) virtual disk (
failSnapShot). The
default value is
failSnapShot.
|
enableSchedule
|
Turns on or off the ability to schedule a snapshot (legacy)
operation. To turn on snapshot (legacy) scheduling, set this parameter
to
TRUE. To turn off snapshot (legacy) scheduling,
set the parameter to
FALSE.
|
schedule
|
Use this parameter to schedule a snapshot (legacy) operation.
You can use one of these options for setting a schedule for a snapshot
(legacy) operation:
-
immediate
-
startDate
-
scheduleDay
-
startTime
-
scheduleInterval
-
endDate
-
noEndDate
-
timesPerDay
-
timeZone
-
NOTE: For
more information, see Notes below.
|
Notes
The virtual disk that you are taking a snapshot (legacy) of must
be a standard virtual disk in the storage array. The maximum number
of snapshot (legacy) virtual disks that you can create is one-half
of the total number of virtual disks that are supported by a RAID
controller module.
You can use any combination of alphanumeric
characters, underscore (_), hyphen (-), and pound (#) for the names.
Names can have a maximum of 30 characters.
One technique for
naming the snapshot (legacy) virtual disk and the snapshot (legacy)
repository virtual disk is to add a hyphenated suffix to the original
base virtual disk name. The suffix distinguishes between the snapshot
(legacy) virtual disk and the snapshot (legacy) repository virtual
disk. For example, if you have a base virtual disk with a name of
Engineering Data, the snapshot (legacy) virtual disk
can have a name of
Engineering Data-S1, and
the snapshot (legacy) repository virtual disk can have a name of
EngineeringData- R1.
If you do not choose a name
for either the snapshot (legacy) virtual disk or the snapshot (legacy)
repository virtual disk, the MD storage management software creates
a default name by using the base virtual disk name. An example of
the snapshot (legacy) virtual disk name that the RAID controller modules
might create is, if the base virtual disk name is
aaa and does not have a snapshot (legacy) virtual disk, the default
snapshot (legacy) virtual disk name is
aaa – 1. If the base virtual disk already has
n – 1 number of snapshot
(legacy) virtual disks, the default name is
aaa –
n. An example of the snapshot (legacy) repository virtual
disk name that the RAID controller module might create is, if the
base virtual disk name is
aaa and does not
have a snapshot (legacy) repository virtual disk, the default snapshot
(legacy) repository virtual disk name is
aaa – R1. If the base virtual disk already has
n – 1 number of snapshot
(legacy) repository virtual disks, the default name is
aaa – R
n.
If you do not specify the unconfigured
space or free space, the snapshot (legacy) repository virtual disk
is placed in the same disk group as the base virtual disk. If the
disk group where the base virtual disk resides does not have enough
space, this command fails.
Enclosure Loss Protection
When you assign the physical disks, if you set the
enclosureLossProtect parameter to
TRUE and have selected more than one
physical disk from any one enclosure, the storage array returns an
error. If you set the
enclosureLossProtect parameter
to
FALSE, the storage array performs operations, but
the disk group that you create might not have enclosure loss protection.
When the RAID controller module firmware assigns the physical
disks, if you set the
enclosureLossProtect parameter
to
TRUE, the storage array returns an error if the
RAID controller module firmware cannot provide physical disks that
result in the new disk group having enclosure loss protection. If
you set the
enclosureLossProtect parameter to
FALSE, the storage array performs the operation even if it
means the disk group might not have enclosure loss protection.
Scheduling
Snapshots (Legacy)
You can use the
enableSchedule and the
schedule parameters to schedule automatic
snapshots (legacy). Automatic snapshots (legacy) can be scheduled
daily, weekly, or monthly (by day or by date). The
enableSchedule parameter turns on or off the ability to schedule snapshots (legacy).
When you enable scheduling, you use the
schedule parameter
to define when you want the snapshots (legacy) to occur.
This
list explains how to use the options for the
schedule parameter:
immediate
|
As soon as you enter the command, a snapshot (legacy) virtual
disk is created and a copyon- write operation begins.
|
startDate
|
A specific date on which you want to create a snapshot (legacy)
virtual disk and perform a copy-on-write operation. The format for
entering the date is
MM:DD:YY. If you do not provide
a start date, the current date is used. An example of this option
is
startDate=06:27:11.
|
scheduleDay
|
A day of the week on which you want to create a snapshot (legacy)
virtual disk and perform a copy-on-write operation. The values that
you can enter are:
monday,
tuesday,
wednesday,
thursday,
friday,
saturday,
sunday, and all. For example:
scheduleDay=wednesday.
|
startTime
|
The time of a day you want to create a snapshot (legacy) virtual
disk and start performing a copy-on-write operation. The format for
entering the time is
HH:MM, where
HH is the hour and
MM is the minute past the hour. Use
a 24-hour clock. For example:
startTime=14:27, which
corresponds to 2:27 PM.
|
scheduleInterval
|
Amount of time, in minutes, that defines a minimum between two
copy-on-write operations. It is possible for you to create a schedule
in which you have overlapping copy-on-write operations because of
the duration of a copy operation. You can ensure that copy-on-write
operations maintain a correct interval by using this option. The maximum
value for the
scheduleInterval option is 1440 minutes.
For example:
scheduleInterval=180.
|
endDate
|
Specific date to stop creating a snapshot (legacy) virtual disk
and end the copy-on-write operations. The format for entering the
date is
MM:DD:YY, where
MM is the month,
DD the day and
YY the year. For example:
endDate=11:26:11.
|
timesPerDay
|
The number of times you want the snapshot schedule to run in a
day. For example,
timesPerDay=4.
|
timeZone
|
Use this parameter to define the time zone in which the storage
array is operating. You can define the time zone in one of two ways:
-
GMT±HH:MM—The time zone offset from Greenwich Mean
Time (GMT), in hours and minutes. For example, GMT-06:00 is the central
time zone in the United States.
-
Text string—A standard time zone text string, in
quotation marks. For example, "USA/Chicago" or "Germany/Berlin". Time
zone text strings are case sensitive. If you enter an incorrect text
string GMT is used.
|
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="USA/Chicago"
If you also use the
scheduleInterval option, the
lowest value of the
timesPerDay option and the
scheduleInterval option is used. The firmware calculates
an integer value for the
scheduleInterval option by
dividing 1440 by 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 virtualDisk command with the schedule parameter. The
delete virtualDisk command with the schedule parameter deletes only the schedule, not
the snapshot (legacy) virtual disk.