Data ONTAP® PowerShell Toolkit

Switch to Data ONTAP Cluster-mode documentation.

Cmdlet: Set-NaSnapshotSchedule


NAME
Set-NaSnapshotSchedule

SYNOPSIS
Set the snapshot schedule on a specified volume.

SYNTAX
Set-NaSnapshotSchedule [-TargetName] <String> [-Weeks <Int32>] [-Days <Int32
>] [-Hours <Int32>] [-Minutes <Int32>] [-WhichHours <String>] [-WhichMinutes
<String>] [-Controller <NaController>] [-WhatIf] [-Confirm] [<CommonParamet
ers>]

Set-NaSnapshotSchedule [-TargetName] <String> [-Schedule] <SnapshotSchedule>
[-Controller <NaController>] [-WhatIf] [-Confirm] [<CommonParameters>]


DESCRIPTION
Set the snapshot schedule on a specified volume. If number of snapshots requ
ested is greater than ONTAP allows, then ESNAPTOOMANY will be returned with
the maximum allow snapshots in the reason.


PARAMETERS
-TargetName <String>
Name of the volume name where the snapshots are located.

Required? true
Position? 1
Default value
Accept pipeline input? true (ByPropertyName)
Accept wildcard characters? false

-Weeks <Int32>
Number of snapshots taken weekly to keep on line. If not provided, the
number of weekly snapshots is left at the previous value.

Required? false
Position? named
Default value
Accept pipeline input? false
Accept wildcard characters? false

-Days <Int32>
Number of snapshots taken daily to keep on line. If not provided, the n
umber of daily snapshots is left at the previous value.

Required? false
Position? named
Default value
Accept pipeline input? false
Accept wildcard characters? false

-Hours <Int32>
Number of snapshots taken hourly to keep on line. If not provided, the
number of weekly snapshots is left at the previous value.

Required? false
Position? named
Default value
Accept pipeline input? false
Accept wildcard characters? false

-Minutes <Int32>
Number of snapshots taken minutely to keep on line. If not provided, th
e number of minutely snapshots is left at the previous value.

Required? false
Position? named
Default value
Accept pipeline input? false
Accept wildcard characters? false

-WhichHours <String>
Comma-separated list of the hours at which the hourly snapshots are crea
ted. If hours is 0, WhichHours is ignored and cleared.

Required? false
Position? named
Default value
Accept pipeline input? false
Accept wildcard characters? false

-WhichMinutes <String>
Comma-separated list of the minutes at which the minutely snapshots are
created. If minutes is 0, WhichMinutes is ignored and cleared.

Required? false
Position? named
Default value
Accept pipeline input? false
Accept wildcard characters? false

-Controller <NaController>
The Data ONTAP controller object, embodied by an NaController object. T
his parameter is returned by the Connect-NaController cmdlet. If not sp
ecified, the value in the global variable CurrentNaController is used.

Required? false
Position? named
Default value
Accept pipeline input? false
Accept wildcard characters? false

-WhatIf


Required? false
Position? named
Default value
Accept pipeline input? false
Accept wildcard characters? false

-Confirm


Required? false
Position? named
Default value
Accept pipeline input? false
Accept wildcard characters? false

-Schedule <SnapshotSchedule>
Schedule object, as returned by Get-NaSnapshotSchedule.

Required? true
Position? 2
Default value
Accept pipeline input? false
Accept wildcard characters? false

<CommonParameters>
This cmdlet supports the common parameters: Verbose, Debug,
ErrorAction, ErrorVariable, WarningAction, WarningVariable,
OutBuffer and OutVariable. For more information, type,
"get-help about_commonparameters".

INPUTS



OUTPUTS
DataONTAP.Types.Volume.VolumeInfo


NOTES


Category: snapshot
API: snapshot-set-schedule

-------------- Example 1 --------------

C:\PS>Set-NaSnapshotSchedule vol10 -Weeks 4 -Hours 2 -WhichHours "0,12" | Ge
t-NaSnapshotSchedule


Set the snapshot schedule for volume 'vol10' and then retrieve/print that sc
hedule.


Volume : vol2
Weeks : 4
Days : 1
Hours : 2
Minutes : 0
WhichHours : 0,12
WhichMinutes :


-------------- Example 2 --------------

C:\PS>Get-NaVol | Set-NaSnapshotSchedule -Schedule ( Get-NaSnapshotSchedule
vol2 ) | Get-NaSnapshotSchedule


Copy the snapshot schedule from volume 'vol2' to all volumes.


Volume : testvol3
Weeks : 4
Days : 1
Hours : 2
Minutes : 0
WhichHours : 0,12
WhichMinutes :

Volume : vol0
Weeks : 4
Days : 1
Hours : 2
Minutes : 0
WhichHours : 0,12
WhichMinutes :

Volume : vol1
Weeks : 4
Days : 1
Hours : 2
Minutes : 0
WhichHours : 0,12
WhichMinutes :

Volume : vol2
Weeks : 4
Days : 1
Hours : 2
Minutes : 0
WhichHours : 0,12
WhichMinutes :



RELATED LINKS
Get-NaSnapshotSchedule







 Data ONTAP® PowerShell Toolkit