Data ONTAP® PowerShell Toolkit

Switch to Data ONTAP Cluster-mode documentation.

Cmdlet: Test-NaSnapshotMulti


NAME
Test-NaSnapshotMulti

SYNOPSIS
Validates the multi-snapshot creation operation on the specified volumes.

SYNTAX
Test-NaSnapshotMulti [-Volumes] <String[]> [-SnapName] <String> [-Controller
<NaController>] [<CommonParameters>]


DESCRIPTION
This is a companion cmdlet of New-NaSnapshotMulti. It validates the snapsho
t creation operation on the specified volumes. But it does not actually cre
ate any snapshot. This API only does validations on all volumes and reports
all errors in the output array. This API is intended to be issued before t
he New-NaSnapshotMulti cmdlet to find out all the errors that may be found d
uring the snapshot create. Its main purpose is to enable the caller of New-
NaSnapshotMulti to reduce the likelihood of failure, thereby attempting to a
void the cleanup overhead of deleting any newly created snapshots during fai
lure processing. However, this validation API does not guarantee that New-N
aSnapshotMulti cmdlet will actually work. Something could change between th
e two calls to cause the actual snapshot creations to fail.


PARAMETERS
-Volumes <String[]>
Names of the volumes across which the snapshot creation is to be validat
ed. The maximum number of volumes on a cluster system is 1200 (100 for
traditional volumes and 500 for flexible volumes. The number is then do
ubled 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

-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

<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
NetApp.Ontapi.Filer.Snapshot73.VolumeError


NOTES


Category: snapshot
API: snapshot-multicreate-validate

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

C:\PS>Test-NaSnapshotMulti vol0,vol1 multisnap2


Check whether a snapshot named 'multisnap2' may be created on volumes 'vol0'
and 'vol1'. In this example, the answer is false because snapshots by that
name already exist on both volumes.


Errno Name Reason ErrnoSpecified
----- ---- ------ --------------
17 vol0 Snapshot already... True
17 vol1 Snapshot already... True



RELATED LINKS
New-NaSnapshotMulti







 Data ONTAP® PowerShell Toolkit