Data ONTAP® PowerShell Toolkit

Switch to Data ONTAP 7-mode documentation.

Cmdlet: Remove-NcIgroupInitiator


NAME
Remove-NcIgroupInitiator

SYNOPSIS
Removes node(s) from an initiator group.

SYNTAX
Remove-NcIgroupInitiator [-Name] <String> [-Initiator] <String> [-Force] [-V
serverContext <String>] [-Controller <NcController[]>] [-WhatIf] [-Confirm]
[<CommonParameters>]


DESCRIPTION
Removes node(s) from an initiator group. The operation is prohibited if ther
e are existing LUN maps defined for that group. Specify -Force to forcibly r
emove the node regardless of mappings.


PARAMETERS
-Name <String>
The name of the igroup to modify.

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

-Initiator <String>
The name of the initiator to remove.

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

-Force
Specify to forcibly remove the initiator.

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
DataONTAP.C.Types.Igroup.InitiatorGroupInfo


NOTES


Category: igroup
API: igroup-remove
Family: vserver

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

C:\PS>Remove-NcIgroupInitiator x3550rre7 iqn.1991-05.com.microsoft:x3550rre8
.rtprre.testdomain -Force


Forcibly remove an initiator from igroup 'x3550rre7'.


Name : x3550rre7
Type : hyper_v
Protocol : mixed
Portset :
ALUA : True
ThrottleBorrow : False
ThrottleReserve : 0
Partner : True
VSA : False
Initiators : {iqn.1991-05.com.microsoft:x3550rre7.rtprre.testdomain}
Vserver : costea01



RELATED LINKS
Add-NcIgroupInitiator
Get-NcIgroup







 Data ONTAP® PowerShell Toolkit