Data ONTAP® PowerShell Toolkit

Switch to Data ONTAP 7-mode documentation.

Cmdlet: Get-NcIscsiInterface


NAME
Get-NcIscsiInterface

SYNOPSIS
Get a list of iSCSI target interface objects.

SYNTAX
Get-NcIscsiInterface [[-Name] <String[]>] [[-IpAddress] <String[]>] [-Attrib
utes <IscsiInterfaceListEntryInfo>] [-VserverContext <String>] [-Controller
<NcController[]>] [<CommonParameters>]

Get-NcIscsiInterface -Template [-VserverContext <String>] [-Controller <NcCo
ntroller[]>] [<CommonParameters>]

Get-NcIscsiInterface -Query <IscsiInterfaceListEntryInfo> [-Attributes <Iscs
iInterfaceListEntryInfo>] [-VserverContext <String>] [-Controller <NcControl
ler[]>] [<CommonParameters>]


DESCRIPTION
Get a list of iSCSI target interface objects.


PARAMETERS
-Name <String[]>
The name of the interface. Data ONTAP wildcards are permitted.

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

-IpAddress <String[]>
The IP address of the interface. Data ONTAP wildcards are permitted.

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

-Attributes <IscsiInterfaceListEntryInfo>
For improved scalability in large clusters, provide an IscsiInterfaceLis
tEntryInfo object with various fields set to indicate which fields to re
turn on all objects. Undesired fields should remain set to null. Use "
Get-NcIscsiInterface -Template" to get the initially empty IscsiInterfac
eListEntryInfo object. If not specified, all data is returned for each
object.

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

-Template
Specify to get an empty IscsiInterfaceListEntryInfo object for use with
advanced queries involving the Query attribute.

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

-Query <IscsiInterfaceListEntryInfo>
For advanced queries, provide an IscsiInterfaceListEntryInfo object with
various fields set to indicate which records to retrieve. Other fields
should remain set to null. Use "Get-NcIscsiInterface -Template" to get
the initially empty IscsiInterfaceListEntryInfo object.

Required? true
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.IscsiInterfaceListEntryInfo


NOTES


Category: iscsi
API: iscsi-interface-get-iter
Family: cluster, vserver

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

C:\PS>Get-NcIscsiInterface


Get all the iscsi interfaces on the current cluster.


CurrentNode : VxeRubble-01
CurrentPort : e0a
InterfaceName : costea01_lif_data3
IpAddress : 10.60.189.144
IpPort : 3260
IsInterfaceEnabled : True
RelativePortId : 1
TpgroupName : costea01_lif_data3
TpgroupTag : 1031
Vserver : costea01
IsInterfaceEnabledSpecified : True

CurrentNode : VxeRubble-01
CurrentPort : e0a
InterfaceName : iscsivs1_data1
IpAddress : 10.60.189.178
IpPort : 3260
IsInterfaceEnabled : True
RelativePortId : 1
TpgroupName : iscsivs1_data1
TpgroupTag : 1043
Vserver : iscsivs1
IsInterfaceEnabledSpecified : True


-------------- Example 2 --------------

C:\PS>$q = Get-NcIscsiInterface -Template
$q.CurrentNode = "VxeRubble-01"
Get-NcIscsiInterface -Query $q


Get all the iscsi interfaces on the node "VxeRubble-01."






RELATED LINKS
Enable-NcIscsiInterface
Disable-NcIscsiInterface







 Data ONTAP® PowerShell Toolkit