|
|
 Data ONTAP® PowerShell Toolkit
|
Cmdlet: Remove-NcVol
NAME
Remove-NcVol
SYNOPSIS
Destroy the specified volume.
SYNTAX
Remove-NcVol [-Name] <String> [-VserverContext <String>] [-Controller <NcCon
troller[]>] [<CommonParameters>]
Remove-NcVol [-Name] <String> -InfiniteVolume [-VserverContext <String>] [-C
ontroller <NcController[]>] [<CommonParameters>]
DESCRIPTION
Destroy the specified volume. All of its blocks are freed and returned to i
ts containing aggregate; no other flexible volumes in the same containing ag
gregate (if any) are affected. Only offline volumes may be destroyed.
When run with the InfiniteVolume switch, the cmdlet runs asynchronously. A
job is returned. The status of the job can be tracked using the Job cmdlets
.
PARAMETERS
-Name <String>
Name of an existing volume to be destroyed.
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
-InfiniteVolume
Specify the InfiniteVolume parameter to indicate the volume is an Infini
te Volume. If a VolumeAttributes object is piped to this cmdlet, the In
finiteVolume switch will be automatically set.
Required? true
Position? named
Default value
Accept pipeline input? true (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
NOTES
Category: volume
API: volume-destroy, volume-destroy-async
Family: vserver
-------------- Example 1 --------------
C:\PS>Remove-NcVol vol2clone
Remove volume 'vol2clone'.
Destroy volume
Are you sure you want to destroy volume vol2clone?
[Y] Yes [A] Yes to All [N] No [L] No to All [S] Suspend [?] Help (defau
lt is "Y"): Y
RELATED LINKS
New-NcVol
| Copyright © 2013 NetApp. All rights reserved. Use is subject to license terms. |
|
Data ONTAP® PowerShell Toolkit
|