|
|
 Data ONTAP® PowerShell Toolkit
|
Cmdlet: Set-NaIscsiInitiatorAuthChap
NAME
Set-NaIscsiInitiatorAuthChap
SYNOPSIS
Modify CHAP parameters of an existing per-initiator authentication record wh
ose authentication type equals CHAP.
SYNTAX
Set-NaIscsiInitiatorAuthChap [-Initiator] <String> [-Username <String>] [-Pa
ssword <String>] [-InboundCredential <PSCredential>] [-OutboundUsername <Str
ing>] [-OutboundPassword <String>] [-OutboundCredential <PSCredential>] [-Re
moveOutbound] [-Controller <NaController>] [-WhatIf] [-Confirm] [<CommonPara
meters>]
DESCRIPTION
Modify CHAP parameters of an existing per-initiator authentication record wh
ose authentication type equals CHAP.
PARAMETERS
-Initiator <String>
Name of initiator (i.e. iqn.1987-06.com.initvendor1:appsrv.sn.2346). The
per-initiator authentication record must have an authentication type eq
ual to CHAP.
Required? true
Position? 1
Default value
Accept pipeline input? true (ByValue, ByPropertyName)
Accept wildcard characters? false
-Username <String>
Inbound CHAP user name. If Inbound CHAP parameters are specified they w
ill replace the existing Inbound CHAP parameters. If they are not speci
fied, the existing Inbound CHAP parameters will continue to be used.
Required? false
Position? named
Default value
Accept pipeline input? false
Accept wildcard characters? false
-Password <String>
Inbound CHAP user password. If Inbound CHAP parameters are specified th
ey will replace the existing Inbound CHAP parameters. If they are not s
pecified, the existing Inbound CHAP parameters will continue to be used.
Required? false
Position? named
Default value
Accept pipeline input? false
Accept wildcard characters? false
-InboundCredential <PSCredential>
PSCredential object containing inbound CHAP credentials. The username a
nd password supplied in the credential object take precedence over the u
sername and password supplied by the -Username and -Password parameters.
If Inbound CHAP parameters are specified they will replace the existin
g Inbound CHAP parameters. If they are not specified, the existing Inbo
und CHAP parameters will continue to be used.
Required? false
Position? named
Default value
Accept pipeline input? false
Accept wildcard characters? false
-OutboundUsername <String>
Outbound CHAP user name. If Outbound CHAP parameters are specified they
will replace existing Outbound CHAP parameters. If no Outbound CHAP pa
rameters were previously specified, then the specified Outbound CHAP par
ameters will enable mutual CHAP authentication. If no Outbound CHAP par
ameters are specified and no Outbound CHAP parameters exist, then one-wa
y Inbound CHAP authentication will be continue to be used.
Required? false
Position? named
Default value
Accept pipeline input? false
Accept wildcard characters? false
-OutboundPassword <String>
Outbound CHAP user password. If Outbound CHAP parameters are specified
they will replace existing Outbound CHAP parameters. If no Outbound CHA
P parameters were previously specified, then the specified Outbound CHAP
parameters will enable mutual CHAP authentication. If no Outbound CHAP
parameters are specified and no Outbound CHAP parameters exist, then on
e-way Inbound CHAP authentication will be continue to be used.
Required? false
Position? named
Default value
Accept pipeline input? false
Accept wildcard characters? false
-OutboundCredential <PSCredential>
PSCredential object containing outbound CHAP credentials. The username
and password supplied in the credential object take precedence over the
username and password supplied by the -OutboundUsername and -OutboundPas
sword parameters. If Outbound CHAP parameters are specified they will r
eplace existing Outbound CHAP parameters. If no Outbound CHAP parameter
s were previously specified, then the specified Outbound CHAP parameters
will enable mutual CHAP authentication. If no Outbound CHAP parameters
are specified and no Outbound CHAP parameters exist, then one-way Inbou
nd CHAP authentication will be continue to be used.
Required? false
Position? named
Default value
Accept pipeline input? false
Accept wildcard characters? false
-RemoveOutbound
Switch parameter which indicates that mutual CHAP authentication is to b
e converted to one-way CHAP authentication. Outbound CHAP parameters mu
st not be specified when RemoveOutbound is TRUE.
Required? false
Position? named
Default value false
Accept pipeline input? false
Accept wildcard characters? false
-Controller <NaController>
The Data ONTAP controller object, embodied by an NaController object. T
his parameter is returned by the Connect-NaController cmdlet. If not sp
ecified, the value in the global variable CurrentNaController is used.
Required? false
Position? named
Default value
Accept pipeline input? false
Accept wildcard characters? false
-WhatIf
Required? false
Position? named
Default value
Accept pipeline input? false
Accept wildcard characters? false
-Confirm
Required? false
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.Iscsi.IscsiSecurityEntryInfo
NOTES
Category: iscsi
API: iscsi-initiator-modify-chap-params
-------------- Example 1 --------------
C:\PS>Set-NaIscsiInitiatorAuthChap iqn.1991-05.com.microsoft:x3550rre7.rtprr
e.testdomain -Username backupUser1 -Password safe4ever
Set the CHAP authentication for the specified iSCSI initiator.
AuthType Initiator OutboundUserName UserName
-------- --------- ---------------- --------
CHAP iqn.1991-05.com.... backupUser1
RELATED LINKS
Add-NaIscsiInitiatorAuth
Get-NaIscsiInitiatorAuth
Remove-NaIscsiInitiatorAuth
| Copyright © 2012 NetApp. All rights reserved. Use is subject to license terms. |
|
Data ONTAP® PowerShell Toolkit
|