|
|
 Data ONTAP® PowerShell Toolkit
|
Cmdlet: Get-NcIscsiInitiatorAuth
NAME
Get-NcIscsiInitiatorAuth
SYNOPSIS
Get a list of iSCSI initiator authentication configuration objects.
SYNTAX
Get-NcIscsiInitiatorAuth [[-Initiator] <String[]>] [[-AuthType] <String[]>]
[-Attributes <IscsiSecurityEntryInfo>] [-VserverContext <String>] [-Controll
er <NcController[]>] [<CommonParameters>]
Get-NcIscsiInitiatorAuth -Template [-VserverContext <String>] [-Controller <
NcController[]>] [<CommonParameters>]
Get-NcIscsiInitiatorAuth -Query <IscsiSecurityEntryInfo> [-Attributes <Iscsi
SecurityEntryInfo>] [-VserverContext <String>] [-Controller <NcController[]>
] [<CommonParameters>]
DESCRIPTION
Get a list of iSCSI initiator authentication configuration objects.
PARAMETERS
-Initiator <String[]>
The name of the initiator. Data ONTAP wildcards are permitted.
Required? false
Position? 1
Default value
Accept pipeline input? true (ByPropertyName)
Accept wildcard characters? false
-AuthType <String[]>
The authentication type. Possible values: CHAP, none, deny.
Required? false
Position? 2
Default value
Accept pipeline input? true (ByPropertyName)
Accept wildcard characters? false
-Attributes <IscsiSecurityEntryInfo>
For improved scalability in large clusters, provide an IscsiSecurityEntr
yInfo object with various fields set to indicate which fields to return
on all objects. Undesired fields should remain set to null. Use "Get-N
cIscsiInitiatorAuth -Template" to get the initially empty IscsiSecurityE
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 IscsiSecurityEntryInfo object for use with advan
ced queries involving the Query attribute.
Required? true
Position? named
Default value
Accept pipeline input? false
Accept wildcard characters? false
-Query <IscsiSecurityEntryInfo>
For advanced queries, provide an IscsiSecurityEntryInfo object with vari
ous fields set to indicate which records to retrieve. Other fields shou
ld remain set to null. Use "Get-NcIscsiInitiatorAuth -Template" to get
the initially empty IscsiSecurityEntryInfo 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.IscsiSecurityEntryInfo
NOTES
Category: iscsi
API: iscsi-initiator-auth-get-iter
Family: cluster, vserver
-------------- Example 1 --------------
C:\PS>Get-NcIscsiInitiatorAuth default
Get all of the default initiator authentication objects on the current clust
er.
Initiator AuthType User
name OutboundUserName
--------- -------- ----
---- ----------------
default none
default none
default none
default none
default deny
default none
-------------- Example 2 --------------
C:\PS>$q = Get-NcIscsiInitiatorAuth -Template
$q.OutboundUserName = "user"
Get-NcIscsiInitiatorAuth -Query $q
Get all iscsi initiator authentication objects with an outbound username def
ined as "user".
Initiator AuthType User
name OutboundUserName
--------- -------- ----
---- ----------------
iqn.1991-05.com.microsoft:win2k8devrre0.rtprre.testdomain chap user
user
RELATED LINKS
Set-NcIscsiInitiatorAuth
Set-NcIscsiInitiatorAuthChap
Remove-NcIscsiInitiatorAuth
| Copyright © 2013 NetApp. All rights reserved. Use is subject to license terms. |
|
Data ONTAP® PowerShell Toolkit
|