|
|
 Data ONTAP® PowerShell Toolkit
|
Cmdlet: New-NaSnapshotMulti
NAME
New-NaSnapshotMulti
SYNOPSIS
Create a snapshot with a specific name on each of the specified volumes.
SYNTAX
New-NaSnapshotMulti [-Volumes] <String[]> [-SnapName] <String> [-NoCleanup]
[-GetSnapshots] [-Controller <NaController>] [-WhatIf] [-Confirm] [<CommonPa
rameters>]
DESCRIPTION
Create a snapshot with the specific name, on each of the specified volumes.
It is the caller's responsibility to ensure that the data in the snapshots
across all volumes is consistent by quiescing I/O to these volumes (or the L
UNs of interest in these volumes) across the call to this API. The API succ
eeds when a snapshot is successfully created on each of the specified volume
s. This API fails when an error is encountered upon creating a snapshot on
a volume. It does not continue on to create snapshots on the remaining volu
mes. When an error occurs, it is possible that some snapshots may have been
created. If NoCleanup is not specified, the API will delete these snapshot
s (but snapshot deletion may fail). If NoCleanup is specified, it is the us
er's responsibility to delete them. There are at least two expected use cas
es for this API. The first one is to call this API without NoCleanup specif
ied. If the call fails, any successfully created snapshots will be deleted b
efore the function returns. This is a simple use case, but has the downside
that in case of a failure, the call may take a long time to return due to s
napshot cleanup. Another use case would be to call this API in a time criti
cal environment. In such a scenario, it would be good to reduce the impact
due to a failure. Hence, it would be better to first call the Test-NaSnapsh
otMulti cmdlet, which would reduce the likelihood of failure of this cmdlet.
In case a failure does occur, the caller could avoid the cleanup delay by
specifying NoCleanup and performing snapshot cleanup later, outside the time
-critical window.
PARAMETERS
-Volumes <String[]>
Names of the volumes across which the snapshot is to be created. The ma
ximum number of volumes on a cluster system is 1200 (100 for traditional
volumes and 500 for flexible volumes. The number is then doubled for a
cluster system).
Required? true
Position? 1
Default value
Accept pipeline input? true (ByValue, ByPropertyName)
Accept wildcard characters? false
-SnapName <String>
Name of the snapshot to be created. The maximum string length is 256 ch
aracters.
Required? true
Position? 2
Default value
Accept pipeline input? true (ByPropertyName)
Accept wildcard characters? false
-NoCleanup
When the API fails, some snapshots may have been created for some volume
s and the API will normally delete these snapshots. Note that newly cre
ated snapshots cannot be deleted right away until the snapshots are on-d
isk, which may take up to 10 seconds. When NoCleanup is specified, newl
y created snapshots are not deleted. Users can delete them later as nee
ded.
Required? false
Position? named
Default value
Accept pipeline input? false
Accept wildcard characters? false
-GetSnapshots
Specify to output the resulting snapshot objects instead of the multicre
ate result object.
Required? false
Position? named
Default value
Accept pipeline input? false
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
DataONTAP.Types.Snapshot.SnapshotMultiResult
NOTES
Category: snapshot
API: snapshot-multicreate
-------------- Example 1 --------------
C:\PS>New-NaSnapshotMulti vol0,vol1 multisnap.1
Create a snapshot named 'multisnap.1' on volumes 'vol0' and 'vol1'.
RELATED LINKS
Test-NaSnapshotMulti
| Copyright © 2012 NetApp. All rights reserved. Use is subject to license terms. |
|
Data ONTAP® PowerShell Toolkit
|