Data ONTAP® PowerShell Toolkit

Switch to Data ONTAP 7-mode documentation.

Cmdlet: Get-NcIscsiInitiator


NAME
Get-NcIscsiInitiator

SYNOPSIS
Get a list of remote iSCSI initiator objects.

SYNTAX
Get-NcIscsiInitiator [[-Initiator] <String[]>] [[-InitiatorAlias] <String[]>
] [-Attributes <IscsiInitiatorListEntryInfo>] [-VserverContext <String>] [-C
ontroller <NcController[]>] [<CommonParameters>]

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

Get-NcIscsiInitiator -Query <IscsiInitiatorListEntryInfo> [-Attributes <Iscs
iInitiatorListEntryInfo>] [-VserverContext <String>] [-Controller <NcControl
ler[]>] [<CommonParameters>]


DESCRIPTION
Get a list of remote iSCSI initiator objects.


PARAMETERS
-Initiator <String[]>
Name of the initiator. Data ONTAP wildcards are permitted.

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

-InitiatorAlias <String[]>
Alias of the initiator. Data ONTAP wildcards are permitted.

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

-Attributes <IscsiInitiatorListEntryInfo>
For improved scalability in large clusters, provide an IscsiInitiatorLis
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-NcIscsiInitiator -Template" to get the initially empty IscsiInitiato
rListEntryInfo 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 IscsiInitiatorListEntryInfo 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 <IscsiInitiatorListEntryInfo>
For advanced queries, provide an IscsiInitiatorListEntryInfo object with
various fields set to indicate which records to retrieve. Other fields
should remain set to null. Use "Get-NcIscsiInitiator -Template" to get
the initially empty IscsiInitiatorListEntryInfo 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.IscsiInitiatorListEntryInfo


NOTES


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

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

C:\PS>Get-NcIscsiInitiator


Get all the remote initiators connected to the current cluster.


InitiatorAliasname :
InitiatorGroupList : {viaRPC.iqn.1991-05.com.microsoft:exch2010-01.exch2010.
local}
InitiatorNodename : iqn.1991-05.com.microsoft:exch2010-01.exch2010.local
Isid : 40:00:01:37:00:01
TargetSessionId : 19
TpgroupName : Kumar_iscsi_lif
TpgroupTag : 1101
Vserver : Kumar01


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

C:\PS>$q = Get-NcIscsiInitiator -Template
$q.TargetSessionId = 20
Get-NcIscsiInitiator -Query $q


Get all the remote iSCSI initiators connected with a session ID of 20 in the
current cluster.


InitiatorNodeName TpGroupName
TargetSessionId Vserver
----------------- -----------
--------------- -------
iqn.1991-05.com.microsoft:barney.sea-tm.netapp.com Cerebus-03_iscsi_if1
20 Barker01
iqn.1991-05.com.microsoft:exch2010-01.exch2010.local Kumar_iscsi_lif
20 Kumar01



RELATED LINKS







 Data ONTAP® PowerShell Toolkit