|
|
 Data ONTAP® PowerShell Toolkit
|
Cmdlet: Start-NaSnapvaultSecSnapshot
NAME
Start-NaSnapvaultSecSnapshot
SYNOPSIS
Request the secondary to force a snapshot creation for a specified snapshot
schedule.
SYNTAX
Start-NaSnapvaultSecSnapshot [-VolumeName] <String> [-ScheduleName] <String>
[-LockBackingSnapshot] [-MaxTries <Int32>] [-Controller <NaController>] [-W
hatIf] [-Confirm] [<CommonParameters>]
DESCRIPTION
Request the secondary to force a snapshot creation for a specified snapshot
schedule. The snapshot schedule must be identified by the volume name and t
he schedule name. All the properties of the specified schedule will be appl
ied to the snapshot creation. This API should be used when it is desirable
to create snapshots right away, without having to wait for the pre-configure
d scheduled time. This API returns after only initiating the snapshot creat
ion, and there is no guarantee that the snapshot creation will succeed. The
Get-NaSnapvaultSecSnapshotScheduleStatus cmdlet should be used to track pro
gress of the snapshot creation.
PARAMETERS
-VolumeName <String>
The secondary volume in which the snapshot is to be created.
Required? true
Position? 1
Default value
Accept pipeline input? true (ByValue, ByPropertyName)
Accept wildcard characters? false
-ScheduleName <String>
The name of the schedule to be used for creating the snapshot. The sche
dule name will be used as a prefix in the name of each snapshot created
by this schedule. If an empty string is provided, the snapshot creation
process will be started, but a snapshot will not be created. This is u
seful to bring all the relationships of a secondary volume to a consiste
nt state.
Required? true
Position? 2
Default value
Accept pipeline input? true (ByValue, ByPropertyName)
Accept wildcard characters? false
-LockBackingSnapshot
When specified, any snapshots backing the LUN clones present in the snap
shot being created will be locked down. As a result, the locked backing
snapshots can't be deleted as long as the snapshot that is locking them
exists. The default value for this option is 'false', which doesn't lo
ck any backing snapshots.
Required? false
Position? named
Default value
Accept pipeline input? false
Accept wildcard characters? false
-MaxTries <Int32>
Number of times SnapVault should try creating the snapshot before giving
up. If the snapshot creation fails due to transient errors such as the
volume being out of space, SnapVault will keep trying to create the sna
pshot every minute untill the request is fulfilled. The allowed range i
s from 0 to 120. The default value is unlimited. If tries-count is not
use, then the value will remain unchanged and the already configured va
lue will be used. The default value for this option is -1. Range:[-1..
120]
Required? false
Position? named
Default value -1
Accept pipeline input? true (ByPropertyName)
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
<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
NOTES
Category: snapvault
API: snapvault-secondary-initiate-snapshot-create
-------------- Example 1 --------------
C:\PS>Start-NaSnapvaultSecSnapshot vol0 vol0_sv_sched
Force a snapshot creation for volume 'vol0' using SnapVault snapshot schedul
e 'vol0_sv_sched'.
RELATED LINKS
Get-NaSnapvaultSecSnapshotSchedule
Stop-NaSnapvaultSecSnapshot
| Copyright © 2012 NetApp. All rights reserved. Use is subject to license terms. |
|
Data ONTAP® PowerShell Toolkit
|