Data ONTAP® PowerShell Toolkit

Switch to Data ONTAP 7-mode documentation.

Cmdlet: Get-NcIscsiSession


NAME
Get-NcIscsiSession

SYNOPSIS
Get a list of iSCSI session objects.

SYNTAX
Get-NcIscsiSession [[-SessionId] <String[]>] [[-TpGroupName] <String[]>] [[-
TpGroupTag] <String[]>] [[-Initiator] <String[]>] [-Attributes <IscsiSession
ListEntryInfo>] [-VserverContext <String>] [-Controller <NcController[]>] [<
CommonParameters>]

Get-NcIscsiSession -Template [-VserverContext <String>] [-Controller <NcCont
roller[]>] [<CommonParameters>]

Get-NcIscsiSession -Query <IscsiSessionListEntryInfo> [-Attributes <IscsiSes
sionListEntryInfo>] [-VserverContext <String>] [-Controller <NcController[]>
] [<CommonParameters>]


DESCRIPTION
Get a list of iSCSI session objects.


PARAMETERS
-SessionId <String[]>
The iSCSI session identifier. Data ONTAP wildcards are permitted.

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

-TpGroupName <String[]>
The name of the target portal group associated with this session. Data
ONTAP wildcards are permitted.

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

-TpGroupTag <String[]>
The tag of the target portal group associated with this session. Data O
NTAP wildcards are permitted.

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

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

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

-Attributes <IscsiSessionListEntryInfo>
For improved scalability in large clusters, provide an IscsiSessionListE
ntryInfo object with various fields set to indicate which fields to retu
rn on all objects. Undesired fields should remain set to null. Use "Ge
t-NcIscsiSession -Template" to get the initially empty IscsiSessionListE
ntryInfo 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 IscsiSessionListEntryInfo object for use with ad
vanced queries involving the Query attribute.

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

-Query <IscsiSessionListEntryInfo>
For advanced queries, provide an IscsiSessionListEntryInfo object with v
arious fields set to indicate which records to retrieve. Other fields s
hould remain set to null. Use "Get-NcIscsiSession -Template" to get the
initially empty IscsiSessionListEntryInfo 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.IscsiSessionListEntryInfo


NOTES


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

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

C:\PS>Get-NcIscsiSession -TpGroupName Kumar_iscsi_lif


Get the iSCSI sessions on the target portal group Kumar_iscsi_lif.


CmdWindowSize : 128
DataPduInOrder : True
DataSequenceInOrder : True
DefaultTimeToRetain : 20
DefaultTimeToRetainTS : 00:00:20
DefaultTimeToWait : 0
DefaultTimeToWaitTS : 00:00:00
ErrorRecoveryLevel : 0
FirstBurstLength : 65536
ImmediateDataEnabled : True
InitialR2tEnabled : False
InitiatorAliasname :
InitiatorNodename : iqn.1991-05.com.microsoft:exch2010-02.ex
ch2010.local
IscsiSessionConnectionListEntries : {Kumar_iscsi_lif}
IscsiSesssionCmdListEntries :
Isid : 40:00:01:37:00:01
MaxBurstLength : 65536
MaxConnections : 4
MaxOutstandingR2t : 1
SessionType : normal
TargetSessionId : 18
TpgroupName : Kumar_iscsi_lif
TpgroupTag : 1101
Vserver : Kumar01
DataPduInOrderSpecified : True
DataSequenceInOrderSpecified : True
ImmediateDataEnabledSpecified : True
InitialR2tEnabledSpecified : True


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

C:\PS>$q = Get-NcIscsiSession -Template
$q.SessionType = "normal"
Get-NcIscsiSession -Query $q


Get all of the normal session types on the current cluster.


InitiatorNodeName TargetSessionId Tp
GroupName SessionType Vserver
----------------- --------------- --
--------- ----------- -------
iqn.1991-05.com.microsoft:sharepoint.sea-tm.netapp.com 10 Ce
rebus-03_iscsi_if1 normal Barker01
iqn.1991-05.com.microsoft:fred.sea-tm.netapp.com 19 Ce
rebus-03_iscsi_if1 normal Barker01
iqn.1991-05.com.microsoft:barney.sea-tm.netapp.com 20 Ce
rebus-03_iscsi_if1 normal Barker01
iqn.1991-05.com.microsoft:exch2010-02.exch2010.local 18 Ku
mar_iscsi_lif normal Kumar01
iqn.1991-05.com.microsoft:exch2010-01.exch2010.local 19 Ku
mar_iscsi_lif normal Kumar01
iqn.1991-05.com.microsoft:exch2010-01.exch2010.local 20 Ku
mar_iscsi_lif normal Kumar01
iqn.1991-05.com.microsoft:exch2010-01.exch2010.local 21 Ku
mar_iscsi_lif normal Kumar01



RELATED LINKS







 Data ONTAP® PowerShell Toolkit