Data ONTAP® PowerShell Toolkit

Switch to Data ONTAP 7-mode documentation.

Cmdlet: Get-NcIscsiService


NAME
Get-NcIscsiService

SYNOPSIS
Get the list of iSCSI Services.

SYNTAX
Get-NcIscsiService [[-NodeName] <String[]>] [[-AliasName] <String[]>] [-Attr
ibutes <IscsiServiceInfo>] [-VserverContext <String>] [-Controller <NcContro
ller[]>] [<CommonParameters>]

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

Get-NcIscsiService -Query <IscsiServiceInfo> [-Attributes <IscsiServiceInfo>
] [-VserverContext <String>] [-Controller <NcController[]>] [<CommonParamete
rs>]


DESCRIPTION
Get the list of iSCSI Services.


PARAMETERS
-NodeName <String[]>
The iSCSI target name of the Vserver.

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

-AliasName <String[]>
The iSCSI target alias of the Vserver.

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

-Attributes <IscsiServiceInfo>
For improved scalability in large clusters, provide an IscsiServiceInfo
object with various fields set to indicate which fields to return on all
objects. Undesired fields should remain set to null. Use "Get-NcIscsi
Service -Template" to get the initially empty IscsiServiceInfo 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 IscsiServiceInfo object for use with advanced qu
eries involving the Query attribute.

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

-Query <IscsiServiceInfo>
For advanced queries, provide an IscsiServiceInfo object with various fi
elds set to indicate which records to retrieve. Other fields should rem
ain set to null. Use "Get-NcIscsiService -Template" to get the initiall
y empty IscsiServiceInfo 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.IscsiServiceInfo


NOTES


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

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

C:\PS>Get-NcIscsiService


Get all the iSCSI services present on the current cluster.


AliasName IsAvailable NodeName
Vserver
--------- ----------- --------
-------
costea01 True iqn.1992-08.com.netapp:sn.8e332132edd111e0
a7a0123478563412:vs.3 costea01
iscsivs1 True iqn.1992-08.com.netapp:sn.15a9b8bf225611e1
a794123478563412:vs.9 iscsivs1
iscsivs2 True iqn.1992-08.com.netapp:sn.412f1b52225611e1
a794123478563412:vs.10 iscsivs2
rashidvs True iqn.1992-08.com.netapp:sn.4def775f09f611e1
a2de123478563412:vs.7 rashidvs
rashidvs2 True iqn.1992-08.com.netapp:sn.b060374509f611e1
a2de123478563412:vs.8 rashidvs2


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

C:\PS>$q = Get-NcIscsiService -Template
$q.IsAvailable = $true
$t = Get-NcIscsiService -Template
$t.NodeName = ""
Get-NcIscsiService -Query $q -Attributes $t


Get the node names of all the currently available iscsi services on the curr
ent cluster.


NodeName Vserv
er
-------- -----
--
iqn.1992-08.com.netapp:sn.8e332132edd111e0a7a0123478563412:vs.3 coste
a01
iqn.1992-08.com.netapp:sn.15a9b8bf225611e1a794123478563412:vs.9 iscsi
vs1
iqn.1992-08.com.netapp:sn.412f1b52225611e1a794123478563412:vs.10 iscsi
vs2
iqn.1992-08.com.netapp:sn.4def775f09f611e1a2de123478563412:vs.7 rashi
dvs
iqn.1992-08.com.netapp:sn.b060374509f611e1a2de123478563412:vs.8 rashi
dvs2



RELATED LINKS
Add-NcIscsiService
Remove-NcIscsiService







 Data ONTAP® PowerShell Toolkit