Data ONTAP® PowerShell Toolkit

Switch to Data ONTAP 7-mode documentation.

Cmdlet: Set-NcSnapshotPolicy


NAME
Set-NcSnapshotPolicy

SYNOPSIS
Modify a snapshot scheduling policy.

SYNTAX
Set-NcSnapshotPolicy [-Name] <String> [-Enabled [<Boolean>]] [-Controller <N
cController[]>] [<CommonParameters>]


DESCRIPTION
Modify a snapshot scheduling 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

-Enabled [<Boolean>]
Status of the snapshot policy indicating whether the policy will be enab
led or disabled. If set to true, the policy will be enabled.

Required? false
Position? named
Default value true
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

<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-modify
Family: cluster,vserver

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

C:\PS>Set-NcSnapshotPolicy weeklyBackup -Enabled $false


Disable the snapshot schedule policy 'weeklyBackup'.


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



RELATED LINKS
Get-NcSnapshotPolicy
Set-NcSnapshotPolicySchedule







 Data ONTAP® PowerShell Toolkit