Syntax
Set-VMHostHba [-ChapName <String>] [-ChapPassword <String>] [-ChapType <ChapType>] -IScsiHba <IScsiHba[]> [-IScsiName <String>] [-MutualChapEnabled <Boolean>] [-MutualChapName <String>] [-MutualChapPassword <String>] [-Server <VIServer[]>] [-Confirm] [-WhatIf] [<CommonParameters>]Related Commands
Online VersionDetailed 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
| Name | Type | Description | Required? | Pipeline Input | Default Value |
|---|---|---|---|---|---|
| ChapName | String | Specifies the CHAP initiator name if CHAP is enabled. | false | False | |
| ChapPassword | String | Specifies the CHAP password if CHAP is enabled. | false | False | |
| ChapType | ChapType | Specifies the type of the CHAP authorization. The valid values are Prohibited, Discouraged, Preferred, and Required. | false | False | |
| 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. | false | False | |
| IScsiHba | IScsiHba[] | Specifies the iSCSI HBA device you want to configure. | true | True (ByValue) | |
| IScsiName | String | Specifies a new name for the host HBA device. | false | False | |
| MutualChapEnabled | Boolean | Indicates that Mutual CHAP authorization is enabled. | false | False | |
| MutualChapName | String | Specifies the Mutual CHAP initiator name if Mutual CHAP is enabled. | false | False | |
| MutualChapPassword | String | Specifies the Mutual CHAP password if Mutual CHAP is enabled. | false | 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. | false | False | |
| WhatIf | SwitchParameter | Indicates that the cmdlet is run only to display the changes that would be made and actually no objects are modified. | false | False |
Return Type
Zero or more modified IScsiHba objectsNotes
The ChapType, MutualChapType, MutualChapName, and MutualChapPassword parameters are supported only on vCenter Server/ESX 4.1 or later.Examples
-------------------------- 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.