Data ONTAP® PowerShell Toolkit

Switch to Data ONTAP 7-mode documentation.

Cmdlet: Start-NcVolMove


NAME
Start-NcVolMove

SYNOPSIS
Moves a flexvol to any eligible aggregate in the cluster.

SYNTAX
Start-NcVolMove [-Name] <String> [-DestinationAggregate] <String> [-Vserver
<String>] [-CutoverWindow <Int32>] [-CutoverAttempts <Int32>] [-CutoverActio
n <String>] [-ValidateOnly] [-Controller <NcController[]>] [-WhatIf] [-Confi
rm] [<CommonParameters>]


DESCRIPTION
Moves a flexvol to any eligible aggregate in the cluster. The list of eligi
ble aggregates can be obtained using Get-NcVolMoveTargetAggr. This API will
start the move. It will run a series of checks to determine if the volume
can be moved. If any of the checks results in an error or warning, the API
will return with an error. The user has to take the necessary corrective act
ion before restarting the move. If all the checks pass, the API will return
a success. If ValidateOnly is not specified, the destination volume will b
e created and the move will start. By default, the move will cutover automa
tically. A background job will be created and the API returns immediately w
ith the job ID information. The status of the move job can be obtained by us
ing Get-NcJob.


PARAMETERS
-Name <String>
Name of the volume that must be moved.

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

-DestinationAggregate <String>
Name of the destination aggregate.

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

-Vserver <String>
The name of the vserver that contains the volume to be moved.

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

-CutoverWindow <Int32>
Time interval to complete cutover in seconds. Default value is 45 secon
ds.

Required? false
Position? named
Default value 45
Accept pipeline input? false
Accept wildcard characters? false

-CutoverAttempts <Int32>
Number of cutover attempts. Default value is 3.

Required? false
Position? named
Default value 3
Accept pipeline input? false
Accept wildcard characters? false

-CutoverAction <String>
Specifies the action to be taken for cutover. Possible values are "abort
_on_failure", "defer_on_failure", "force" and "wait". Default is "defer_
on_failure". If "abort_on_failure" action is specified, the job will try
cutover till the cutover attempts are exhausted, and cleanup if it fail
s to cutover. If "defer_on_failure" action is specified, the job will t
ry cutover till the cutover attempts are exhausted and move into "cutove
r deferred" state if it fails to cutover. This is the default option.
The volume move job waits for intervention to restart the cutover proces
s again. If "force" action is specified, the job will try cutover till
the cutover attempts are exhausted and force the cutover at the expense
of disrupting the clients. If "wait" action is specified, when the job
hits the decision point, it will not go into cutover automatically, inst
ead it will wait for the user to issue Invoke-NcVolMoveCutover as the si
gnal to try the cutover.

Required? false
Position? named
Default value defer_on_failure
Accept pipeline input? false
Accept wildcard characters? false

-ValidateOnly
Run pre-checks for the move, return all the errors and warning messages
encountered during the checks. The move will not be triggered.

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

-WhatIf


Required? false
Position? named
Default value
Accept pipeline input? false
Accept wildcard characters? false

-Confirm


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
DataONTAP.C.PowerShell.SDK.Cmdlets.JobStartResult


NOTES


Category: volume
API: volume-move-start
Family: cluster

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

C:\PS>Start-NcVolMove bigvol aggr1 -Vserver vserver1


Move volume 'bigvol' to aggregate 'aggr1'.


NcController : 10.61.172.155
ErrorCode :
ErrorMessage :
JobId : 1369
JobVserver : vserver1
Status : in_progress



RELATED LINKS
Invoke-NcVolMoveCutover
Get-NcVolMoveTargetAggr







 Data ONTAP® PowerShell Toolkit