Data ONTAP® PowerShell Toolkit

Switch to clustered Data ONTAP documentation.

Cmdlet: New-NaConsistencyGroup


NAME
New-NaConsistencyGroup

SYNOPSIS
Starts the checkpoint cycle for externally synchronized checkpoints in the c
ontroller.

SYNTAX
New-NaConsistencyGroup [-Snapshot] <String> [-Volumes] <String[]> [[-Timeout
] <String>] [-Immediate] [-Controller <NaController>] [<CommonParameters>]


DESCRIPTION
Starts the checkpoint cycle for externally synchronized checkpoints in the c
ontroller. This operation fences the specified volumes and returns a consist
ency group ID if successful. If the command succeeds, the call starts a snap
create operation in these volumes. In that case, this operation SHOULD be
followed by a call to Save-NaConsistencyGroup.


PARAMETERS
-Snapshot <String>
The provided name of the snapshot that is created in each volume. This
name is the unique identifier by which the calling agent identifies the
snapshots that constitute a checkpoint. The maximum length is 255 chara
cters.

Required? true
Position? 1
Default value
Accept pipeline input? true (ByValue, ByPropertyName)
Accept wildcard characters? false

-Volumes <String[]>
A list of volumes in this controller that is part of this consistency gr
oup operation.

Required? true
Position? 2
Default value
Accept pipeline input? true (ByPropertyName)
Accept wildcard characters? false

-Timeout <String>
Timeout selector. Possible vaules are "urgent", "medium" or "relaxed".
If no value is specified, the default value is "medium".

Required? false
Position? 3
Default value medium
Accept pipeline input? true (ByPropertyName)
Accept wildcard characters? false

-Immediate
Specify to commit the snapshots immediately, rather than via the separat
e Save-NaConsistencyGroup cmdlet.

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

<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
System.Int64


NOTES


Category: consistency group
API: cg-start

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

C:\PS>New-NaConsistencyGroup cg_snapshot vol1,vol2 -Timeout relaxed


Begin a consistent snapshot operation across volumes 'vol1' and 'vol2'.


15


-------------- Example 2 --------------

C:\PS>New-NaConsistencyGroup cg_snapshot vol1,vol2 -Immediate


Begin a consistent snapshot operation across volumes 'vol1' and 'vol2', comm
itting the snapshots immediately.






RELATED LINKS
Save-NaConsistencyGroup
Remove-NaConsistencyGroup







 Data ONTAP® PowerShell Toolkit