|
|
 Data ONTAP® PowerShell Toolkit
|
Cmdlet: Get-NcIscsiTargetPortalGroup
NAME
Get-NcIscsiTargetPortalGroup
SYNOPSIS
Get iSCSI Target Portal Groups.
SYNTAX
Get-NcIscsiTargetPortalGroup [[-Name] <String[]>] [[-Tag] <String[]>] [-Attr
ibutes <IscsiTpgroupListEntryInfo>] [-VserverContext <String>] [-Controller
<NcController[]>] [<CommonParameters>]
Get-NcIscsiTargetPortalGroup -Template [-VserverContext <String>] [-Controll
er <NcController[]>] [<CommonParameters>]
Get-NcIscsiTargetPortalGroup -Query <IscsiTpgroupListEntryInfo> [-Attributes
<IscsiTpgroupListEntryInfo>] [-VserverContext <String>] [-Controller <NcCon
troller[]>] [<CommonParameters>]
DESCRIPTION
Get iSCSI Target Portal Groups.
PARAMETERS
-Name <String[]>
The portal group name. Data ONTAP wildcards are permitted.
Required? false
Position? 1
Default value
Accept pipeline input? true (ByPropertyName)
Accept wildcard characters? false
-Tag <String[]>
The portal group tag. Data ONTAP wildcards are permitted.
Required? false
Position? 1
Default value
Accept pipeline input? true (ByPropertyName)
Accept wildcard characters? false
-Attributes <IscsiTpgroupListEntryInfo>
For improved scalability in large clusters, provide an IscsiTpgroupListE
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-NcIscsiTargetPortalGroup -Template" to get the initially empty IscsiTp
groupListEntryInfo object. If not specified, all data is returned for e
ach 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 IscsiTpgroupListEntryInfo 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 <IscsiTpgroupListEntryInfo>
For advanced queries, provide an IscsiTpgroupListEntryInfo object with v
arious fields set to indicate which records to retrieve. Other fields s
hould remain set to null. Use "Get-NcIscsiTargetPortalGroup -Template"
to get the initially empty IscsiTpgroupListEntryInfo 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.IscsiTpgroupListEntryInfo
NOTES
Category: iscsi
API: iscsi-tpgroup-get-iter
Family: cluster, vserver
-------------- Example 1 --------------
C:\PS>Get-NcIscsiTargetPortalGroup
Get all the iSCSI target portal groups on the current cluster.
Vserver : costea01
InterfaceListEntries : {costea01_lif_data3}
IsUserDefined : False
TpgroupName : costea01_lif_data3
TpgroupTag : 1031
Vserver : iscsivs1
InterfaceListEntries : {iscsivs1_data1}
IsUserDefined : False
TpgroupName : iscsivs1_data1
TpgroupTag : 1043
-------------- Example 2 --------------
C:\PS>$q = Get-NcIscsiTargetPortalGroup -Template
$q.IsUserDefined = $true
Get-NcIscsiTargetPortalGroup -Query $q
Get all of the user-defined target portal groups from the current cluster.
Vserver : iscsivs1
InterfaceListEntries : {iscsivs1_data1}
IsUserDefined : True
TpgroupName : iscsivs1_tpgroup1
TpgroupTag : 1045
RELATED LINKS
Remove-NcIscsiTargetPortalGroup
New-NcIscsiTargetPortalGroup
| Copyright © 2013 NetApp. All rights reserved. Use is subject to license terms. |
|
Data ONTAP® PowerShell Toolkit
|