Data ONTAP® PowerShell Toolkit

Switch to Data ONTAP 7-mode documentation.

Cmdlet: Get-NcIgroup


NAME
Get-NcIgroup

SYNOPSIS
List igroups.

SYNTAX
Get-NcIgroup [[-Name] <String[]>] [-Vserver <String[]>] [-Initiator <String[
]>] [-Attributes <InitiatorGroupInfo>] [-VserverContext <String>] [-Controll
er <NcController[]>] [<CommonParameters>]

Get-NcIgroup -Template [-VserverContext <String>] [-Controller <NcController
[]>] [<CommonParameters>]

Get-NcIgroup -Query <InitiatorGroupInfo> [-Attributes <InitiatorGroupInfo>]
[-VserverContext <String>] [-Controller <NcController[]>] [<CommonParameters
>]


DESCRIPTION
List igroups.


PARAMETERS
-Name <String[]>
The name of one or more igroups to get. Data ONTAP wildcards are permit
ted.

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

-Vserver <String[]>
Restrict results to the specified vserver(s). Data ONTAP wildcards are
permitted.

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

-Initiator <String[]>
Restrict results to the specified initiator(s). Data ONTAP wildcards ar
e permitted.

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

-Attributes <InitiatorGroupInfo>
For improved scalability in large clusters, provide an InitiatorGroupInf
o object with various fields set to indicate which fields to return on a
ll objects. Undesired fields should remain set to null. Use "Get-NcIgr
oup -Template" to get the initially empty InitiatorGroupInfo 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 Data ONTAP cluster-mode controller to receive this cmdlet, as embodied
by an NcController object. This parameter is returned by the Connect-N
cController cmdlet. If not specified, the value in the global variable
CurrentNcController is used. In the latter case, if CurrentNcController
contains a collection of NcController objects, this cmdlet is invoked o
n each 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 InitiatorGroupInfo 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 <InitiatorGroupInfo>
For advanced queries, provide an InitiatorGroupInfo object with various
fields set to indicate which records to retrieve. Other fields should r
emain set to null. Use "Get-NcIgroup -Template" to get the initially em
pty InitiatorGroupInfo 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
NetApp.Ontapi.Filer.C.Igroup810.InitiatorGroupInfo


NOTES


Category: igroup
API: igroup-get-iter
Family: cluster, vserver

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

C:\PS>Get-NcIgroup -Vserver Lionetti01


List igroups owned by vserver 'Lionetti01'.


Name : HyperV121
Type : windows
Protocol : fcp
Portset :
ALUA : True
ThrottleBorrow : False
ThrottleReserve : 0
Partner : True
VSA : False
Initiators : {10:00:00:05:33:26:88:2e, 10:00:00:05:33:26:88:2f}
Vserver : Lionetti01

Name : HyperV122
Type : windows
Protocol : fcp
Portset :
ALUA : True
ThrottleBorrow : False
ThrottleReserve : 0
Partner : True
VSA : False
Initiators : {10:00:00:05:33:26:60:70, 10:00:00:05:33:26:60:71}
Vserver : Lionetti01

Name : viaRPC.iqn.1991-05.com.microsoft:sql-cmode.sea-tm.netapp.c
om
Type : windows
Protocol : iscsi
Portset :
ALUA : True
ThrottleBorrow : False
ThrottleReserve : 0
Partner : True
VSA : False
Initiators : {iqn.1991-05.com.microsoft:sql-cmode.sea-tm.netapp.com}
Vserver : Lionetti01


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

C:\PS>$q = Get-NcIgroup -Template
$q.Protocol = "fcp"
$a = Get-NcIgroup -Template
$a.Name = ""
Get-NcIgroup -Query $q -Attributes $a | select Name


Using an advanced query, list only the names of the FCP igroups across the c
luster.


Name
----
HyperV121
HyperV122
fuji05_FC
viaRPC.10:00:00:05:33:26:75:cc.SEASQLCMODE
viaRPC.10:00:00:05:33:26:75:cd.SEASQLCMODE
fuji6_Data



RELATED LINKS
New-NcIgroup
Remove-NcIgroup







 Data ONTAP® PowerShell Toolkit