Data ONTAP® PowerShell Toolkit

Switch to Data ONTAP 7-mode documentation.

Cmdlet: Add-NcSnapshotPolicySchedule


NAME
Add-NcSnapshotPolicySchedule

SYNOPSIS
Add a new schedule to a snapshot policy.

SYNTAX
Add-NcSnapshotPolicySchedule [-Name] <String> [-Schedule] <String> [-Count]
<Int32> [-Prefix <String>] [-Controller <NcController[]>] [-WhatIf] [-Confir
m] [<CommonParameters>]


DESCRIPTION
Add a new schedule to a snapshot policy.


PARAMETERS
-Name <String>
The name of the snapshot scheduling policy to modify.

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

-Schedule <String>
The name of a new schedule to be added to the snapshot policy. Maximum
length of this field can be 255 characters. The schedule name may be an
y one of the reserved schedules like 'hourly', 'weekly' or 'daily' or it
may be a user created schedule.

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

-Count <Int32>
The maximum number of snapshots to be retained for the schedule. The co
unt of all the snapshots for to be retained for this policy cannot be mo
re than 255.

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

-Prefix <String>
The snapshot name prefix for the schedule. This field should be unique
within the policy.

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

-Controller <NcController[]>
A clustered Data ONTAP controller to receive this cmdlet, as embodied by
an NcController object. This parameter is returned by the Connect-NcCo
ntroller cmdlet. If not specified, the value in the global variable Cur
rentNcController is used. In the latter case, if CurrentNcController co
ntains a collection of NcController objects, this cmdlet is invoked on e
ach controller in succession.

Required? false
Position? named
Default value
Accept pipeline input? true (ByValue, ByPropertyName)
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

<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.C.Types.Snapshot.SnapshotPolicyInfo


NOTES


Category: snapshot
API: snapshot-policy-add-schedule
Family: cluster

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

C:\PS>Add-NcSnapshotPolicySchedule weeklyBackup daily 6


Add six daily snapshots to the weekly backup snapshot policy.


Policy Enabled SnapshotPolicySchedules
------ ------- -----------------------
weeklyBackup False {weekly (26), daily (6)}



RELATED LINKS
Get-NcSnapshotPolicy
Remove-NcSnapshotPolicySchedule
Set-NcSnapshotPolicySchedule







 Data ONTAP® PowerShell Toolkit