|
|
 Data ONTAP® PowerShell Toolkit
|
Cmdlet: Set-NaIscsiInitiatorDefaultAuth
NAME
Set-NaIscsiInitiatorDefaultAuth
SYNOPSIS
Configure the default iSCSI authentication method.
SYNTAX
Set-NaIscsiInitiatorDefaultAuth [-None] [-Controller <NaController>] [-WhatI
f] [-Confirm] [<CommonParameters>]
Set-NaIscsiInitiatorDefaultAuth -Chap [-Username <String>] [-Password <Strin
g>] [-InboundCredential <PSCredential>] [-OutboundUsername <String>] [-Outbo
undPassword <String>] [-OutboundCredential <PSCredential>] [-Controller <NaC
ontroller>] [-WhatIf] [-Confirm] [<CommonParameters>]
Set-NaIscsiInitiatorDefaultAuth -Deny [-Controller <NaController>] [-WhatIf]
[-Confirm] [<CommonParameters>]
DESCRIPTION
Configure the default iSCSI authentication method. If an initiator is not c
onfigured with a specific authentication method using Add-NaIscsiInitiatorAu
th the default authentication method will be applied to it.
PARAMETERS
-None
Specify this switch parameter for authentication type 'none'.
Required? false
Position? named
Default value
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
-Chap
Specify this switch parameter for authentication type 'CHAP'.
Required? true
Position? named
Default value
Accept pipeline input? false
Accept wildcard characters? false
-Username <String>
Inbound CHAP user name. For the CHAP authentication type, the -Username
and -Password or -InboundCredential parameters must be specified.
Required? false
Position? named
Default value
Accept pipeline input? false
Accept wildcard characters? false
-Password <String>
Inbound CHAP user password. For the CHAP authentication type, the -User
name and -Password or -InboundCredential parameters must be specified.
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.
Required? false
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.
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.
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. Outbound authentication is optional. If Outbound auth
entication is not specified, then the initiator can only do inbound traf
fic.
Required? false
Position? named
Default value
Accept pipeline input? false
Accept wildcard characters? false
-Deny
Specify this switch parameter for authentication type 'deny'.
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.Types.Iscsi.IscsiSecurityEntryInfo
NOTES
Category: iscsi
API: iscsi-initiator-set-default-auth
-------------- Example 1 --------------
C:\PS>Set-NaIscsiInitiatorDefaultAuth -Chap -Username admin -Password data4u
Configure the default iSCSI authentication method to CHAP requiring the user
name 'admin'.
Name Value
---- -----
OutboundUserName
AuthType CHAP
UserName admin
RELATED LINKS
Get-NaIscsiInitiatorDefaultAuth
Add-NaIscsiInitiatorAuth
| Copyright © 2012 NetApp. All rights reserved. Use is subject to license terms. |
|
Data ONTAP® PowerShell Toolkit
|