|
|
 Data ONTAP® PowerShell Toolkit
|
Cmdlet: Set-NcIscsiInitiatorAuth
NAME
Set-NcIscsiInitiatorAuth
SYNOPSIS
Set initiator authentication method.
SYNTAX
Set-NcIscsiInitiatorAuth [-Initiator] <String> -Chap -InboundCredential <PSC
redential> [-OutboundCredential <PSCredential>] [-VserverContext <String>] [
-Controller <NcController[]>] [<CommonParameters>]
Set-NcIscsiInitiatorAuth [-Initiator] <String> -Deny [-VserverContext <Strin
g>] [-Controller <NcController[]>] [<CommonParameters>]
Set-NcIscsiInitiatorAuth [-Initiator] <String> -Chap -Username <String> -Pas
sword <String> [-OutboundUsername <String>] [-OutboundPassword <String>] [-V
serverContext <String>] [-Controller <NcController[]>] [<CommonParameters>]
Set-NcIscsiInitiatorAuth [-Initiator] <String> [-VserverContext <String>] [-
Controller <NcController[]>] [<CommonParameters>]
Set-NcIscsiInitiatorAuth [-Initiator] <String> -None [-VserverContext <Strin
g>] [-Controller <NcController[]>] [<CommonParameters>]
DESCRIPTION
Set initiator authentication method.
PARAMETERS
-Initiator <String>
Initiator to set authentication method. Use "default" to set the authen
tication method for the default initiator.
Required? true
Position? 1
Default value
Accept pipeline input? true (ByPropertyName)
Accept wildcard characters? false
-Chap
If specified, the authentication method will be set to chap.
Required? true
Position? named
Default value
Accept pipeline input? false
Accept wildcard characters? false
-InboundCredential <PSCredential>
Inbound CHAP username and password embodied in a PSCredential object.
Required? true
Position? named
Default value
Accept pipeline input? false
Accept wildcard characters? false
-OutboundCredential <PSCredential>
Outbound username and password embodied in a PSCredential 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
-Deny
If specified, the authentication method will be set to deny.
Required? true
Position? named
Default value
Accept pipeline input? false
Accept wildcard characters? false
-Username <String>
Inbound CHAP user name, required when the Chap switch is present. Alter
nately, the CHAP username and password can be passed in a PSCredential o
bject using the InboundCredential parameter.
Required? true
Position? named
Default value
Accept pipeline input? false
Accept wildcard characters? false
-Password <String>
Inbound CHAP user password, required when the Chap switch is present. A
lternately, the CHAP username and password can be passed in a PSCredenti
al object using the InboundCredential parameter.
Required? true
Position? named
Default value
Accept pipeline input? false
Accept wildcard characters? false
-OutboundUsername <String>
Outbound CHAP user name. Outbound authentication is optional. If Outbou
nd authentication is not specified, then the initiator can only do inbou
nd traffic. Alternately, the outbound CHAP username and password can be
passed in a PSCredential object using the OutboundCredential parameter.
Required? false
Position? named
Default value
Accept pipeline input? false
Accept wildcard characters? false
-OutboundPassword <String>
Outbound CHAP user password. Outbound authentication is optional. If Ou
tbound authentication is not specified, then the initiator can only do i
nbound traffic. Alternately, the outbound CHAP username and password ca
n be passed in a PSCredential object using the OutboundCredential parame
ter.
Required? false
Position? named
Default value
Accept pipeline input? false
Accept wildcard characters? false
-None
If specified, the authentication method will be set to none.
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-add-auth
Family: vserver
-------------- Example 1 --------------
C:\PS>Set-NcIscsiInitiatorAuth -Initiator iqn.1991-05.com.microsoft:win2k8de
vrre0 -Chap -InboundCredential user
Set the initiator authentication method for the given initiator to CHAP with
inbound credentials.
Initiator AuthType User
name OutboundUserName
--------- -------- ----
---- ----------------
iqn.1991-05.com.microsoft:win2k8devrre0 chap user
-------------- Example 2 --------------
C:\PS>Set-NcIscsiInitiatorAuth default -Deny
Set the default iscsi initiator authentication method to deny.
Initiator AuthType User
name OutboundUserName
--------- -------- ----
---- ----------------
default deny
RELATED LINKS
Set-NcIscsiInitiatorAuthChap
Remove-NcIscsiInitiatorAuth
Get-NcIscsiInitiatorAuth
| Copyright © 2013 NetApp. All rights reserved. Use is subject to license terms. |
|
Data ONTAP® PowerShell Toolkit
|