Data ONTAP® PowerShell Toolkit

Switch to Data ONTAP 7-mode documentation.

Cmdlet: New-NcSnapshotMulti


NAME
New-NcSnapshotMulti

SYNOPSIS
Create a snapshot with the specific name on each of the specified volumes.

SYNTAX
New-NcSnapshotMulti [-Volumes] <String[]> [-SnapName] <String> [-NoCleanup]
[-GetSnapshots] [-VserverContext <String>] [-Controller <NcController[]>] [<
CommonParameters>]


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
LUNs of interest in these volumes), across the call to this API. If an erro
r occurs, it is possible that some snapshots may have been created. Unless
NoCleanup is specified, the API will attempt to delete these snapshots (but
snapshot deletion may fail). Otherwise, it is the user's responsibility to
delete them.


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

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

-NoCleanup
When the API fails, some snapshots may have been created for some volume
s. By default, the API will attempt to delete these snapshots. Note th
at newly created snapshots cannot be deleted right away until the snapsh
ots are on-disk, which may take up to 10 secs. When NoCleanup is specif
ied, newly created snapshots are not deleted and users may delete them l
ater as needed.

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

-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.SnapshotMultiResult


NOTES


Category: snapshot
API: snapshot-multicreate
Family: vserver

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

C:\PS>New-NaSnapshotMulti vol1,vol2 snap1


Create a snapshot 'snap1' on volumes 'vol1' and 'vol2'.






RELATED LINKS
Test-NcSnapshotMulti
Get-NcSnapshot







 Data ONTAP® PowerShell Toolkit