|
|
 Data ONTAP® PowerShell Toolkit
|
Cmdlet: Set-NcIscsiInitiatorAuthChap
NAME
Set-NcIscsiInitiatorAuthChap
SYNOPSIS
Modify CHAP parameters to an existing initiator authentication info whose au
thentication type is CHAP.
SYNTAX
Set-NcIscsiInitiatorAuthChap [-Initiator] <String> [-Username <String>] [-Pa
ssword <String>] [-OutboundUsername <String>] [-OutboundPassword <String>] [
-RemoveOutbound] [-VserverContext <String>] [-Controller <NcController[]>] [
-WhatIf] [-Confirm] [<CommonParameters>]
Set-NcIscsiInitiatorAuthChap [-Initiator] <String> [-InboundCredential <PSCr
edential>] [-OutboundCredential <PSCredential>] [-RemoveOutbound] [-VserverC
ontext <String>] [-Controller <NcController[]>] [-WhatIf] [-Confirm] [<Commo
nParameters>]
DESCRIPTION
Modify CHAP parameters to an existing initiator authentication info whose au
thentication type is CHAP.
PARAMETERS
-Initiator <String>
Initiator to set CHAP parameters. Use "default" to set the CHAP paramet
ers for the default initiator.
Required? true
Position? 1
Default value
Accept pipeline input? true (ByPropertyName)
Accept wildcard characters? false
-Username <String>
Inbound CHAP username. If inbound CHAP parameters are specified they wi
ll replace the existing Inbound CHAP parameters. If they are not specif
ied, 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 password. If inbound CHAP parameters are specified they wi
ll replace the existing Inbound CHAP parameters. If they are not specif
ied, the existing Inbound 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 username. If outbound CHAP parameters are specified they
will replace the existing outbound CHAP parameters. If they are not spe
cified, the existing outbound CHAP parameters will continue to be used.
Required? false
Position? named
Default value
Accept pipeline input? false
Accept wildcard characters? false
-OutboundPassword <String>
Outbound CHAP password. If outbound CHAP parameters are specified they
will replace the existing outbound CHAP parameters. If they are not spe
cified, the existing outbound CHAP parameters will continue to be used.
Required? false
Position? named
Default value
Accept pipeline input? false
Accept wildcard characters? false
-RemoveOutbound
If specified, outbound CHAP parameters will be removed from initiator au
thentication where outbound CHAP parameters are currently defined.
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
-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
-InboundCredential <PSCredential>
Inbound CHAP username and password embodied in a PSCredential object. I
f they are specified they will replace the existing Inbound CHAP paramet
ers. If they are not specified, the existing Inbound CHAP parameters wi
ll continue to be used.
Required? false
Position? named
Default value
Accept pipeline input? false
Accept wildcard characters? false
-OutboundCredential <PSCredential>
Outbound username and password embodied in a PSCredential object. If th
ey are specified they will replace the existing Outbound CHAP parameters
. If they are not specified, the existing Outbound CHAP parameters will
continue to be used.
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
DataONTAP.C.Types.Iscsi.IscsiSecurityEntryInfo
NOTES
Category: iscsi
API: iscsi-initiator-modify-chap-params
Family: vserver
-------------- Example 1 --------------
C:\PS>Set-NcIscsiInitiatorAuthChap iqn.1991-05.com.microsoft:win2k8devrre0 -
Username user -Password password -OutboundUsername user -OutboundPassword p@
ssword
Sets the CHAP inbound username/password and outbound username/password for t
he given iscsi initiator.
Initiator AuthType User
name OutboundUserName
--------- -------- ----
---- ----------------
iqn.1991-05.com.microsoft:win2k8devrre0 chap user
user
-------------- Example 2 --------------
C:\PS>Set-NcIscsiInitiatorAuthChap iqn.1991-05.com.microsoft:win2k8devrre0 -
RemoveOutbound
Remove the outbound username and password from the CHAP parameters.
Initiator AuthType User
name OutboundUserName
--------- -------- ----
---- ----------------
iqn.1991-05.com.microsoft:win2k8devrre0 chap user
RELATED LINKS
Set-NcIscsiInitiatorAuth
Remove-NcIscsiInitiatorAuth
Get-NcIscsiInitiatorAuth
| Copyright © 2012 NetApp. All rights reserved. Use is subject to license terms. |
|
Data ONTAP® PowerShell Toolkit
|