Data ONTAP® PowerShell Toolkit

Switch to Data ONTAP 7-mode documentation.

Cmdlet: Start-NcVolCloneSplit


NAME
Start-NcVolCloneSplit

SYNOPSIS
Begin the process by which the given clone is split off from its underlying
parent volume and snapshot.

SYNTAX
Start-NcVolCloneSplit [-Name] <String> [-VserverContext <String>] [-Controll
er <NcController[]>] [<CommonParameters>]


DESCRIPTION
Begin the process by which the given clone is split off from its underlying
parent volume and snapshot. New storage is allocated for the clone that is
distinct from its parent. This process may take some time and proceeds in th
e background. Use Get-NcVolCloneSplit to view the operation's progress. Bo
th clone and parent volumes remain available during the process of splitting
them apart. Upon completion, the snapshot on which the clone was based wil
l be unlocked in the parent volume. Any snapshots in the clone are removed
at the end of processing. Use Stop-NcVolCloneSplit to stop this process.

A job is created to perform the split operation. The job id of the job is re
turned in the cmdlet response. The progress of the job can be tracked using
the job cmdlets.


PARAMETERS
-Name <String>
The name of the volume clone to split from its parent.

Required? true
Position? 1
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.PowerShell.SDK.Cmdlets.JobStartResult


NOTES


Category: volume
API: volume-clone-split-start
Family: vserver

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

C:\PS>Start-NcVolCloneSplit vol2clone


Split volume clone 'vol2clone' from its parent volume.


NcController : 10.61.172.155
Status : in_progress
JobId : 564
ErrorCode :
ErrorMessage :



RELATED LINKS
Get-NcVolCloneSplit
Stop-NcVolCloneSplit







 Data ONTAP® PowerShell Toolkit