Data ONTAP® PowerShell Toolkit

Switch to Data ONTAP 7-mode documentation.

Cmdlet: Remove-NcLun


NAME
Remove-NcLun

SYNOPSIS
Destroy the specified LUN.

SYNTAX
Remove-NcLun [-Path] <String> [-Force] [-VserverContext <String>] [-Controll
er <NcController[]>] [-WhatIf] [-Confirm] [<CommonParameters>]


DESCRIPTION
Destroy the specified LUN. This operation will fail if the LUN is currently
mapped and is online. The force option can be used to destroy it regardles
s of being online or mapped.


PARAMETERS
-Path <String>
The path of the LUN to destroy.

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

-Force
If specified, override checks that prevent a LUN from being destroyed if
it is online and mapped. Otherwise, destroying an online and mapped LU
N will fail.

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

-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



NOTES


Category: lun
API: lun-destroy
Family: vserver

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

C:\PS>Remove-NcLun /vol/bigvol/ExchangeTest


Remove the specified LUN.






RELATED LINKS
Get-NcLun
New-NcLun







 Data ONTAP® PowerShell Toolkit