< Back
Set-VMHostHba
Post
NAME Set-VMHostHba
SYNOPSIS
This cmdlet configures the CHAP properties of the specified iSCSI HBAs.
SYNTAX
Set-VMHostHba [-ChapName <String>] [-ChapPassword <String>] [-ChapType <ChapType>] -IScsiHba <IScsiHba[]>
[-IScsiName <String>] [-MutualChapEnabled <Boolean>] [-MutualChapName <String>] [-MutualChapPassword <String>]
[-Server <VIServer[]>] [-Confirm] [-WhatIf] [<CommonParameters>]
DESCRIPTION
This cmdlet configures the CHAP properties of the specified iSCSI HBAs. If (Mutual)ChapType is set to a value
different than "Prohibited", (Mutual)ChapPassword must be set. ChapType, MutualChapType, MutualChapName,
MutualChapPassword - these are only available on 4.1 or later. Note: Run Set-VmHostHba directly against ESX. When
Set-VmHostHba is run against vCenter Server, changing the iScsiName property of an iSCSI adapter modifies its
AuthenticationCapabilities property.
PARAMETERS
-ChapName <String>
Specifies the CHAP initiator name if CHAP is enabled.
Required? false
Position? named
Default value Use the old name if any. Otherwise, use the initiator name.
Accept pipeline input? False
Accept wildcard characters? false
-ChapPassword <String>
Specifies the CHAP password if CHAP is enabled.
Required? false
Position? named
Default value None
Accept pipeline input? False
Accept wildcard characters? false
-ChapType <ChapType>
Specifies the type of the CHAP authorization. The valid values are Prohibited, Discouraged, Preferred, and
Required.
Required? false
Position? named
Default value None
Accept pipeline input? False
Accept wildcard characters? false
-IScsiHba <IScsiHba[]>
Specifies the iSCSI HBA device you want to configure.
Required? true
Position? named
Default value None
Accept pipeline input? True (ByValue)
Accept wildcard characters? true
-IScsiName <String>
Specifies a new name for the host HBA device.
Required? false
Position? named
Default value None
Accept pipeline input? False
Accept wildcard characters? false
-MutualChapEnabled <Boolean>
Indicates that Mutual CHAP authorization is enabled.
Required? false
Position? named
Default value None
Accept pipeline input? False
Accept wildcard characters? false
-MutualChapName <String>
Specifies the Mutual CHAP initiator name if Mutual CHAP is enabled.
Required? false
Position? named
Default value Use the old name if any. Otherwise, use the initiator name.
Accept pipeline input? False
Accept wildcard characters? false
-MutualChapPassword <String>
Specifies the Mutual CHAP password if Mutual CHAP is enabled.
Required? false
Position? named
Default value None
Accept pipeline input? False
Accept wildcard characters? false
-Server <VIServer[]>
Specifies the vCenter Server systems on which you want to run the cmdlet. If no value is given to this
parameter, the command runs on the default servers. For more information about default servers, see the
description of Connect-VIServer.
Required? false
Position? named
Default value None
Accept pipeline input? False
Accept wildcard characters? true
-Confirm [<SwitchParameter>]
If the value is $true, indicates that the cmdlet asks for confirmation before running. If the value is $false,
the cmdlet runs without asking for user confirmation.
Required? false
Position? named
Default value $true
Accept pipeline input? False
Accept wildcard characters? false
-WhatIf [<SwitchParameter>]
Indicates that the cmdlet is run only to display the changes that would be made and actually no objects are
modified.
Required? false
Position? named
Default value False
Accept pipeline input? False
Accept wildcard characters? false
<CommonParameters>
This cmdlet supports the common parameters: Verbose, Debug,
ErrorAction, ErrorVariable, WarningAction, WarningVariable,
OutBuffer, PipelineVariable, and OutVariable. For more information, see
about_CommonParameters (https:/go.microsoft.com/fwlink/?LinkID=113216).
INPUTS
OUTPUTS
Zero or more modified IScsiHba objects
NOTES
The ChapType, MutualChapType, MutualChapName, and MutualChapPassword parameters are supported only on vCenter
Server/ESX 4.1 or later.
-------------------------- Example 1 --------------------------
Get-VMHostHba -Type iScsi | Set-VMHostHba -ChapType Required -ChapName Admin -ChapPassword pass
Changes the CHAP type of the available iScsi to Required.
-------------------------- Example 2 --------------------------
Set-VMHostHba -IScsiHba $iscsi -MutualChapEnabled $true -ChapType Required -ChapName Admin -ChapPassword pass
-MutualChapName Administrator -MutualChapPassword Pass
Enables Mutual CHAP for the iScsi devices stored in the $iscsi variable and changes the CHAP type to Required.
RELATED LINKS
Online Version: https://code.vmware.com/doc/preview?id= ... stHba.html
Get-VMHostHba
New-IScsiHbaTarget
Remove-IScsiHbaTarget
Set-IScsiHbaTarget
SYNOPSIS
This cmdlet configures the CHAP properties of the specified iSCSI HBAs.
SYNTAX
Set-VMHostHba [-ChapName <String>] [-ChapPassword <String>] [-ChapType <ChapType>] -IScsiHba <IScsiHba[]>
[-IScsiName <String>] [-MutualChapEnabled <Boolean>] [-MutualChapName <String>] [-MutualChapPassword <String>]
[-Server <VIServer[]>] [-Confirm] [-WhatIf] [<CommonParameters>]
DESCRIPTION
This cmdlet configures the CHAP properties of the specified iSCSI HBAs. If (Mutual)ChapType is set to a value
different than "Prohibited", (Mutual)ChapPassword must be set. ChapType, MutualChapType, MutualChapName,
MutualChapPassword - these are only available on 4.1 or later. Note: Run Set-VmHostHba directly against ESX. When
Set-VmHostHba is run against vCenter Server, changing the iScsiName property of an iSCSI adapter modifies its
AuthenticationCapabilities property.
PARAMETERS
-ChapName <String>
Specifies the CHAP initiator name if CHAP is enabled.
Required? false
Position? named
Default value Use the old name if any. Otherwise, use the initiator name.
Accept pipeline input? False
Accept wildcard characters? false
-ChapPassword <String>
Specifies the CHAP password if CHAP is enabled.
Required? false
Position? named
Default value None
Accept pipeline input? False
Accept wildcard characters? false
-ChapType <ChapType>
Specifies the type of the CHAP authorization. The valid values are Prohibited, Discouraged, Preferred, and
Required.
Required? false
Position? named
Default value None
Accept pipeline input? False
Accept wildcard characters? false
-IScsiHba <IScsiHba[]>
Specifies the iSCSI HBA device you want to configure.
Required? true
Position? named
Default value None
Accept pipeline input? True (ByValue)
Accept wildcard characters? true
-IScsiName <String>
Specifies a new name for the host HBA device.
Required? false
Position? named
Default value None
Accept pipeline input? False
Accept wildcard characters? false
-MutualChapEnabled <Boolean>
Indicates that Mutual CHAP authorization is enabled.
Required? false
Position? named
Default value None
Accept pipeline input? False
Accept wildcard characters? false
-MutualChapName <String>
Specifies the Mutual CHAP initiator name if Mutual CHAP is enabled.
Required? false
Position? named
Default value Use the old name if any. Otherwise, use the initiator name.
Accept pipeline input? False
Accept wildcard characters? false
-MutualChapPassword <String>
Specifies the Mutual CHAP password if Mutual CHAP is enabled.
Required? false
Position? named
Default value None
Accept pipeline input? False
Accept wildcard characters? false
-Server <VIServer[]>
Specifies the vCenter Server systems on which you want to run the cmdlet. If no value is given to this
parameter, the command runs on the default servers. For more information about default servers, see the
description of Connect-VIServer.
Required? false
Position? named
Default value None
Accept pipeline input? False
Accept wildcard characters? true
-Confirm [<SwitchParameter>]
If the value is $true, indicates that the cmdlet asks for confirmation before running. If the value is $false,
the cmdlet runs without asking for user confirmation.
Required? false
Position? named
Default value $true
Accept pipeline input? False
Accept wildcard characters? false
-WhatIf [<SwitchParameter>]
Indicates that the cmdlet is run only to display the changes that would be made and actually no objects are
modified.
Required? false
Position? named
Default value False
Accept pipeline input? False
Accept wildcard characters? false
<CommonParameters>
This cmdlet supports the common parameters: Verbose, Debug,
ErrorAction, ErrorVariable, WarningAction, WarningVariable,
OutBuffer, PipelineVariable, and OutVariable. For more information, see
about_CommonParameters (https:/go.microsoft.com/fwlink/?LinkID=113216).
INPUTS
OUTPUTS
Zero or more modified IScsiHba objects
NOTES
The ChapType, MutualChapType, MutualChapName, and MutualChapPassword parameters are supported only on vCenter
Server/ESX 4.1 or later.
-------------------------- Example 1 --------------------------
Get-VMHostHba -Type iScsi | Set-VMHostHba -ChapType Required -ChapName Admin -ChapPassword pass
Changes the CHAP type of the available iScsi to Required.
-------------------------- Example 2 --------------------------
Set-VMHostHba -IScsiHba $iscsi -MutualChapEnabled $true -ChapType Required -ChapName Admin -ChapPassword pass
-MutualChapName Administrator -MutualChapPassword Pass
Enables Mutual CHAP for the iScsi devices stored in the $iscsi variable and changes the CHAP type to Required.
RELATED LINKS
Online Version: https://code.vmware.com/doc/preview?id= ... stHba.html
Get-VMHostHba
New-IScsiHbaTarget
Remove-IScsiHbaTarget
Set-IScsiHbaTarget