Data ONTAP® PowerShell Toolkit

Switch to Data ONTAP Cluster-mode documentation.

Cmdlet: Remove-NaIgroupInitiator


NAME
Remove-NaIgroupInitiator

SYNOPSIS
Removes node(s) from an initiator group.

SYNTAX
Remove-NaIgroupInitiator [-Igroup] <String> [-Initiator] <String> [-Force] [
-Controller <NaController>] [-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. The force option set to "tru
e" can be used to forcibly remove the node regardless of mappings.


PARAMETERS
-Igroup <String>
Name of initiator group.

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

-Initiator <String>
Initiator to remove.

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

-Force
Forcibly remove the initiator even if there are existing LUNs mapped to
this initiator group. Best practice is to attempt to unmap all the luns
associated with a group before removing the initiator.

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

-Controller <NaController>
The Data ONTAP controller object, embodied by an NaController object. T
his parameter is returned by the Connect-NaController cmdlet. If not sp
ecified, the value in the global variable CurrentNaController is used.

Required? false
Position? named
Default value
Accept pipeline input? false
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.Types.Lun.InitiatorGroupInfo


NOTES


Category: igroup
API: igroup-remove

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

C:\PS>Remove-NaIgroupInitiator igroup4 iqn.1991-05.com.microsoft:xyratex02


Remove an initiator on server 'xyratex02' from igroup 'igroup4'.


InitiatorGroupName : igroup4
InitiatorGroupType : iscsi
Initiators : {}
InitiatorGroupOsType : windows
InitiatorGroupPortsetName :
InitiatorGroupThrottleBorrow : False
InitiatorGroupThrottleReserve : 0
InitiatorGroupUsePartner :
InitiatorGroupAluaEnabled : False
InitiatorGroupVsaEnabled : False
LunId :



RELATED LINKS
Add-NaIgroupInitiator
Get-NaIgroup







 Data ONTAP® PowerShell Toolkit