Data ONTAP® PowerShell Toolkit

Switch to Data ONTAP 7-mode documentation.

Cmdlet: Test-NcSnapshotMulti


NAME
Test-NcSnapshotMulti

SYNOPSIS


SYNTAX
Test-NcSnapshotMulti [-Volumes] <String[]> [-SnapName] <String> [-VserverCon
text <String>] [-Controller <NcController[]>] [<CommonParameters>]


DESCRIPTION
This is a companion cmdlet of New-NcSnapshotMulti which validates the snapsh
ot creation operation on the specified volumes without actually creating any
snapshot. This API is intended to be issued before New-NcSnapshotMulti to
find out all the errors that may be found during the snapshot create. Its ma
in purpose is to enable the New-NcSnapshotMulti caller to reduce the likelih
ood of failure, thereby attempting to avoid the cleanup overhead (of deletin
g any newly created snapshots) during failure processing. However, this val
idation API does not guarantee that New-NcSnapshotMulti will actually work.
Something could change between the two calls to cause the actual snapshot c
reations to fail.


PARAMETERS
-Volumes <String[]>
Names of the volumes across which the snapshot creation is to be validat
ed.

Required? true
Position? 1
Default value
Accept pipeline input? true (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

-VserverContext <String>
Vserver to which to direct this command. If the currently connected con
troller (as embodied by an NcController object) represents a cluster, th
ere are multiple means to address commands to one of its vservers. Eith
er set the Vserver field on the NcController object to direct all subseq
uent commands to that vserver, or supply the VserverContext parameter to
an individual cmdlet. Only cmdlets which may be invoked on vservers of
fer the VserverContext parameter.

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


NOTES


Category: snapshot
API: snapshot-multicreate-validate
Family: vserver

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

C:\PS>Test-NcSnapshotMulti vol1,vol2 snap1


Check to see if "New-NcSnapshotMulti vol1,vol2 snap1" could be expected to w
ork.


NcController : 10.61.172.155
Errno : 13020
Name : vol1
Reason : Snapshot already exists.
ErrnoSpecified : True

NcController : 10.61.172.155
Errno : 13020
Name : vol2
Reason : Snapshot already exists.
ErrnoSpecified : True



RELATED LINKS
New-NcSnapshotMulti







 Data ONTAP® PowerShell Toolkit