Data ONTAP® PowerShell Toolkit

Cmdlet: Set-NaIscsiInitiatorDefaultAuth


NAME
Set-NaIscsiInitiatorDefaultAuth

SYNOPSIS
Configure the default iSCSI authentication method.

SYNTAX
Set-NaIscsiInitiatorDefaultAuth [-None] [-Controller <NaController>] [-Warni
ngAction <ActionPreference>] [-WarningVariable <String>] [<CommonParameters>
]

Set-NaIscsiInitiatorDefaultAuth -Chap -Username <String> -Password <String>
[-OutboundUsername <String>] [-OutboundPassword <String>] [-Controller <NaCo
ntroller>] [-WarningAction <ActionPreference>] [-WarningVariable <String>] [
<CommonParameters>]

Set-NaIscsiInitiatorDefaultAuth -Deny [-Controller <NaController>] [-Warning
Action <ActionPreference>] [-WarningVariable <String>] [<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 DataONTAP controller object, embodied by an NaController object. Th
is parameter is returned by the Connect-NaController cmdlet. If not spe
cified, the value in the global variable CurrentNaController is used.

Required? false
Position? named
Default value
Accept pipeline input? false
Accept wildcard characters? false

-WarningAction <ActionPreference>


Required? false
Position? named
Default value
Accept pipeline input? false
Accept wildcard characters? false

-WarningVariable <String>


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, required for auth-type equals to CHAP.

Required? true
Position? named
Default value
Accept pipeline input? false
Accept wildcard characters? false

-Password <String>
Inbound CHAP user password, required for auth-type equals to CHAP.

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.

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

-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
NetApp.Ontapi.Filer.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







 Data ONTAP® PowerShell Toolkit