New-SnapshotRule
SYNOPSIS
Creates a snapshot rule on the PowerStore cluster.
SYNTAX
ByInterval (Default)
New-SnapshotRule [-Cluster] <Cluster> [-Name] <String> -Interval {FiveMinutes | FifteenMinutes | ThirtyMinutes | OneHour | TwoHours | ThreeHours | FourHours | SixHours | EightHours | TwelveHours | OneDay} -DesiredRetention <Int32> [-NasAccessType {Snapshot | Protocol}] [-IsReadOnly] [<CommonParameters>]
ByTimeOfDay
New-SnapshotRule [-Cluster] <Cluster> [-Name] <String> -TimeOfDay <String> -DaysOfWeek {Monday | Tuesday | Wednesday | Thursday | Friday | Saturday | Sunday} -DesiredRetention <Int32> [-NasAccessType {Snapshot | Protocol}] [-IsReadOnly] [<CommonParameters>]
DESCRIPTION
Creates a snapshot by either specifying a time of day or interval, days, and desired retention period.
EXAMPLES
Example 1
PS C:\> New-SnapshotRule -Cluster $cluster -Name snapRule1 -Interval OneDay -DesiredRetention 72
Where $cluster is a PowerStore cluster instance. Creates a snapshot rule, snapRule1 which creates daily snapshots with a desired retention of 72 hours.
Example 2
PS C:\> New-SnapshotRule -Cluster $cluster -Name snapRule2 -TimeOfDay 12:01 -DaysOfWeek Monday,Wednesday,Friday -DesiredRetention 168
Where $cluster is a PowerStore cluster instance. Creates a snapshot rule, snapRule2 which creates a snapshot at 12:01pm every Monday, Wednesday, and Friday with a desired retention of 168 hours (1 week).
PARAMETERS
-Cluster
The PowerStore cluster.
Type: Cluster
Parameter Sets: (All)
Aliases:
Required: True
Position: 0
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
-Name
The snapshot rule name.
Type: String
Parameter Sets: (All)
Aliases:
Required: True
Position: 1
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
-Interval
Snapshot internal using predefined intervals.
Type: String
Parameter Sets: ByInterval
Aliases:
Accepted values: FiveMinutes, FifteenMinutes, ThirtyMinutes, OneHour, TwoHours, ThreeHours, FourHours, SixHours, EightHours, TwelveHours, OneDay
Required: True
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
-TimeOfDay
The time of the day to take a daily snapshot in 24 hour time format (hh:mm). Either the Interval parameter or the TimeOfDay parameter may be set, but not both.
Type: String
Parameter Sets: ByTimeOfDay
Aliases:
Required: True
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
-DaysOfWeek
Days of the week when the rule should be applied. Applies only for rules where the TimeOfDay parameter is set. Acceptable values from the set {Sunday, Monday, Tuesday, Wednesday, Thursday, Friday, Saturday}.
Type: String[]
Parameter Sets: ByTimeOfDay
Aliases:
Accepted values: Monday, Tuesday, Wednesday, Thursday, Friday, Saturday, Sunday
Required: True
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
-DesiredRetention
The desired snapshot retention period in hours. The system will retain snapshots for this time period, if space is available.
Type: Int32
Parameter Sets: (All)
Aliases:
Required: True
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
-NasAccessType
NAS filesystem snapshot access method.
Type: String
Parameter Sets: (All)
Aliases:
Accepted values: Snapshot, Protocol
Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
-IsReadOnly
Indicates whether this snapshot rule can be modified.
Type: SwitchParameter
Parameter Sets: (All)
Aliases:
Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
CommonParameters
This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters.