|
|
 Data ONTAP® PowerShell Toolkit
|
Cmdlet: Remove-NcIgroup
NAME
Remove-NcIgroup
SYNOPSIS
Destroys an existing initiator group.
SYNTAX
Remove-NcIgroup [-Name] <String> [-Force] [-VserverContext <String>] [-Contr
oller <NcController[]>] [-WhatIf] [-Confirm] [<CommonParameters>]
DESCRIPTION
Destroys an existing initiator group. By default a group cannot be destroye
d if there are existing LUN maps defined for that group. This behavior can
be overridden with the use of -Force which will destroy the initiator group
and any associated LUN maps.
PARAMETERS
-Name <String>
The name of the igroup to destroy.
Required? true
Position? 1
Default value
Accept pipeline input? true (ByPropertyName)
Accept wildcard characters? false
-Force
Specify to forcibly destroy the initiator group, even if there are exist
ing LUN maps. Best practice is to attempt to unmap all the LUNs associ
ated with a group before destroying it.
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 Data ONTAP cluster-mode controller to receive this cmdlet, as embodied
by an NcController object. This parameter is returned by the Connect-N
cController cmdlet. If not specified, the value in the global variable
CurrentNcController is used. In the latter case, if CurrentNcController
contains a collection of NcController objects, this cmdlet is invoked o
n each 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: igroup
API: igroup-destroy
Family: vserver
-------------- Example 1 --------------
C:\PS>Remove-NcIgroup exchangeCluster -Confirm:$false
Destroy igroup 'exchangeCluster' without prompting.
RELATED LINKS
New-NcIgroup
Get-NcIgroup
| Copyright © 2012 NetApp. All rights reserved. Use is subject to license terms. |
|
Data ONTAP® PowerShell Toolkit
|