Data ONTAP® PowerShell Toolkit

Switch to Data ONTAP 7-mode documentation.

Cmdlet: Remove-NcSnapshotPolicySchedule


NAME
Remove-NcSnapshotPolicySchedule

SYNOPSIS
Remove a schedule from a snapshot policy.

SYNTAX
Remove-NcSnapshotPolicySchedule [-Name] <String> [-Schedule] <String> [-Cont
roller <NcController[]>] [-WhatIf] [-Confirm] [<CommonParameters>]


DESCRIPTION
Remove a schedule from 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 schedule which will be removed from the snapshot policy.
Maximum length of this field can be 255 characters. The schedule name m
ay be any one of the reserved schedules like 'hourly', 'weekly' or 'dail
y' or it may be a user created schedule.

Required? true
Position? 2
Default value
Accept pipeline input? true (ByPropertyName)
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-remove-schedule
Family: cluster

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

C:\PS>Remove-NcSnapshotPolicySchedule weeklyBackup daily


Remove the daily snapshots from the snapshot schedule policy 'weeklyBackup'.


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



RELATED LINKS
Get-NcSnapshotPolicy
Add-NcSnapshotPolicySchedule
Set-NcSnapshotPolicySchedule







 Data ONTAP® PowerShell Toolkit