|
|
 Data ONTAP® PowerShell Toolkit
|
Cmdlet: New-NcSnapshotPolicy
NAME
New-NcSnapshotPolicy
SYNOPSIS
Create a new snapshot scheduling policy.
SYNTAX
New-NcSnapshotPolicy [-Name] <String> [-Schedule] <String> [-Count] <Int32>
[-Prefix <String>] [-Enabled [<Boolean>]] [-Comment <String>] [-SnapmirrorLa
bel <String>] [-Controller <NcController[]>] [<CommonParameters>]
DESCRIPTION
Create a new snapshot scheduling policy.
PARAMETERS
-Name <String>
The name of the snapshot scheduling policy which has to be created. Thi
s cmdlet creates a snapshot policy and adds a schedule to it. The maxim
um length of this string is 256 characters.
Required? true
Position? 1
Default value
Accept pipeline input? true (ByPropertyName)
Accept wildcard characters? false
-Schedule <String>
First schedule to be added inside the policy. At least one schedule has
to be added to create a policy.
Required? true
Position? 2
Default value
Accept pipeline input? false
Accept wildcard characters? false
-Count <Int32>
Retention count for the snapshots created by the first schedule. The co
unt of all the snapshots to be retained for this policy cannot be more t
han 255.
Required? true
Position? 3
Default value
Accept pipeline input? false
Accept wildcard characters? false
-Prefix <String>
Snapshot name prefix for the first schedule. Prefix name should be uniq
ue within the policy.
Required? false
Position? named
Default value
Accept pipeline input? false
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
-Comment <String>
A human readable description associated with the snapshot policy. The m
aximum length of this field can be 255 characters.
Required? false
Position? named
Default value
Accept pipeline input? true (ByPropertyName)
Accept wildcard characters? false
-SnapmirrorLabel <String>
Label for SnapMirror Operations. Maximum length of this field is 31 char
acters.
Required? false
Position? named
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
<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-create
Family: cluster, vserver
-------------- Example 1 --------------
C:\PS>New-NcSnapshotPolicy weeklyBackup weekly 26 -Comment "Six months of we
ekly backups"
Create a new snapshot policy that retains 26 weeks of weekly snapshots.
Policy Enabled SnapshotPolicySchedules
------ ------- -----------------------
weeklyBackup True {weekly (26)}
RELATED LINKS
Get-NcSnapshotPolicy
Remove-NcSnapshotPolicy
| Copyright © 2013 NetApp. All rights reserved. Use is subject to license terms. |
|
Data ONTAP® PowerShell Toolkit
|