|
|
 Data ONTAP® PowerShell Toolkit
|
Cmdlet: Get-NcIscsiConnection
NAME
Get-NcIscsiConnection
SYNOPSIS
Get a list of iSCSI Connection objects.
SYNTAX
Get-NcIscsiConnection [[-ConnectionId] <String[]>] [[-SessionId] <String[]>]
[[-TpGroupName] <String[]>] [[-TpGroupTag] <String[]>] [-Attributes <IscsiC
onnectionListEntryInfo>] [-VserverContext <String>] [-Controller <NcControll
er[]>] [<CommonParameters>]
Get-NcIscsiConnection -Template [-VserverContext <String>] [-Controller <NcC
ontroller[]>] [<CommonParameters>]
Get-NcIscsiConnection -Query <IscsiConnectionListEntryInfo> [-Attributes <Is
csiConnectionListEntryInfo>] [-VserverContext <String>] [-Controller <NcCont
roller[]>] [<CommonParameters>]
DESCRIPTION
Get a list of iSCSI Connection objects.
PARAMETERS
-ConnectionId <String[]>
The iSCSI connection identifier. Data ONTAP wildcards are permitted.
Required? false
Position? 1
Default value
Accept pipeline input? true (ByPropertyName)
Accept wildcard characters? false
-SessionId <String[]>
The iSCSI session identifier. Data ONTAP wildcards are permitted.
Required? false
Position? 2
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? 3
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? 4
Default value
Accept pipeline input? true (ByPropertyName)
Accept wildcard characters? false
-Attributes <IscsiConnectionListEntryInfo>
For improved scalability in large clusters, provide an IscsiConnectionLi
stEntryInfo object with various fields set to indicate which fields to r
eturn on all objects. Undesired fields should remain set to null. Use
"Get-NcIscsiConnection -Template" to get the initially empty IscsiConnec
tionListEntryInfo object. If not specified, all data is returned for ea
ch 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 IscsiConnectionListEntryInfo 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 <IscsiConnectionListEntryInfo>
For advanced queries, provide an IscsiConnectionListEntryInfo object wit
h various fields set to indicate which records to retrieve. Other field
s should remain set to null. Use "Get-NcIscsiConnection -Template" to g
et the initially empty IscsiConnectionListEntryInfo 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.IscsiConnectionListEntryInfo
NOTES
Category: iscsi
API: iscsi-connection-get-iter
Family: cluster, vserver
-------------- Example 1 --------------
C:\PS>Get-NcIscsiConnection
Get all of the iSCSI connections on the current cluster.
ConnectionId : 1
ConnectionState : full_feature_phase
HasSession : True
InterfaceName : Cerebus-03_iscsi_if1
LocalIpAddress : 10.58.92.202
LocalIpPort : 3260
RemoteIpAddress : 10.58.94.21
RemoteIpPort : 49152
SessionId : 20
TpgroupName : Cerebus-03_iscsi_if1
TpgroupTag : 1067
Vserver : Barker01
-------------- Example 2 --------------
C:\PS>$q = Get-NcIscsiConnection -Template
$q.ConnectionState = "full_feature_phase"
Get-NcIscsiConnection -Query $q
Get all of the iSCSI connections in the "full_feature_phase" connection stat
e.
ConnectionId InterfaceName RemoteIpAddress ConnectionState
Vserver
------------ ------------- --------------- ---------------
-------
1 Cerebus-03_iscsi_if1 10.58.94.21 full_feature_pha
se Barker01
1 Cerebus-03_iscsi_if1 10.58.94.183 full_feature_pha
se Barker01
1 Cerebus-03_iscsi_if1 10.58.94.103 full_feature_pha
se Barker01
1 Kumar_iscsi_lif 10.58.93.185 full_feature_pha
se Kumar01
1 Kumar_iscsi_lif 10.58.93.185 full_feature_pha
se Kumar01
1 Kumar_iscsi_lif 10.58.93.186 full_feature_pha
se Kumar01
1 Kumar_iscsi_lif 10.58.93.185 full_feature_pha
se Kumar01
RELATED LINKS
| Copyright © 2013 NetApp. All rights reserved. Use is subject to license terms. |
|
Data ONTAP® PowerShell Toolkit
|