Data ONTAP® PowerShell Toolkit

Switch to Data ONTAP 7-mode documentation.

Cmdlet: Remove-NcIscsiTargetPortalGroupInterface


NAME
Remove-NcIscsiTargetPortalGroupInterface

SYNOPSIS
Remove an interface from a target portal group. Interfaces may only be remov
ed from a user defined target portal group. Removing an interface will retur
n it to the system defined default group for the interface.

SYNTAX
Remove-NcIscsiTargetPortalGroupInterface [-Tag] <Int32> [-Interface] <String
[]> [-VserverContext <String>] [-Controller <NcController[]>] [-WhatIf] [-Co
nfirm] [<CommonParameters>]


DESCRIPTION
Remove an interface from a target portal group. Interfaces may only be remov
ed from a user defined target portal group. Removing an interface will retur
n it to the system defined default group for the interface.


PARAMETERS
-Tag <Int32>
Target portal group tag.

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

-Interface <String[]>
Name of one or more network interfaces to remove. This is the name of an
iSCSI data LIF in the Vserver.

Required? true
Position? 2
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

-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.Iscsi.IscsiTpgroupListEntryInfo


NOTES


Category: iscsi
API: iscsi-tpgroup-interface-delete
Family: vserver

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

C:\PS>Remove-NcIscsiTargetPortalGroupInterface 1 costea01_lif_data3


Remove the data LIF costea01_lif_data3 from the target portal group with tag
1.


NcController : 10.60.189.172
InterfaceListEntries : {}
IsUserDefined : True
TpgroupName : tpGroup1
TpgroupTag : 1
Vserver : costea01
IsUserDefinedSpecified : True



RELATED LINKS
Add-NcTargetPortalGroupInterface







 Data ONTAP® PowerShell Toolkit