Set-IScsiHbaTarget
This cmdlet modifies the configuration of an iSCSI HBA target. The cmdlet modifies the CHAP and Digest properties of an iSCSI HBA target. You must specify at least one of the CHAP-related (or Mutual CHAP) parameters. Otherwise, an error message is displayed.
Syntax
-Target
<IScsiHbaTarget[]>
[-ChapName <String>]
[-ChapPassword <String>]
[-ChapType <ChapType>]
[-InheritChap <Boolean>]
[-InheritMutualChap <Boolean>]
[-MutualChapEnabled <Boolean>]
[-MutualChapName <String>]
[-MutualChapPassword <String>]
[-Server <VIServer[]>]
[CommonParameters]
[-ChapName <String>]
[-ChapPassword <String>]
[-ChapType <ChapType>]
[-InheritChap <Boolean>]
[-InheritMutualChap <Boolean>]
[-MutualChapEnabled <Boolean>]
[-MutualChapName <String>]
[-MutualChapPassword <String>]
[-Server <VIServer[]>]
[CommonParameters]
Parameters
| Required | Parameter Name | Type | Position | Features | Description |
|---|---|---|---|---|---|
| required |
|
IScsiHbaTarget[] | named |
|
Specifies the iSCSI HBA target you want to configure. To identify the target, you can provide an IScsiTarget object or use an : |
optional |
|
String | named |
|
Specifies the CHAP initiator name if CHAP is enabled. | optional |
|
String | named |
|
Specifies the CHAP password if CHAP is enabled. | optional |
|
ChapType | named |
|
Specifies the type of the CHAP authorization. The valid values are Prohibited, Discouraged, Preferred, and Required. If you set ChapType to Discouraged, Preferred, or Required, then you must specify the ChapPassword parameter as well. | optional |
|
Boolean | named |
|
Indicates that the CHAP setting is inherited from the iSCSI HBA device. | optional |
|
Boolean | named |
|
Indicates that the Mutual CHAP setting is inherited from the iSCSI HBA device. | optional |
|
Boolean | named |
|
Indicates that mutual CHAP is enabled. In this case, you must specify the MutualChapPassword parameter as well. | optional |
|
String | named |
|
Specifies the Mutual CHAP initiator name if CHAP is enabled. | optional |
|
String | named |
|
Specifies the Mutual CHAP password if CHAP is enabled. | optional |
|
VIServer[] | named |
|
Specifies the vCenter Server systems on which you want to run the cmdlet. If no value is provided or $null value is passed to this parameter, the command runs on the default servers. For more information about default servers, see the description of Connect-VIServer. |
Output
VMware.VimAutomation.ViCore.Types.V1.Host.Storage.IScsiHbaTarget
Examples
Example 1
Get-IScsiHbaTarget -Address "10.23.84.73" -Type Static | Set-IScsiHbaTarget -ChapType Prohibited
Retrieves the targets of type Static on the specified address and sets their CHAP type to Prohibited.
Example 2
$target = Get-IScsiHbaTarget -Address "10.23.84.73" -Type Send
Set-IScsiHbaTarget -Target $target -ChapType Required -ChapPassword pass1 -MutualChapEnabled -MutualChapPassword pass2
Modifies the CHAP and Mutual CHAP settings of the targets of type Send on the specified address.
Related Commands
IScsiHbaTarget
This cmdlet retrieves the available iSCSI HBA targets.
This cmdlet modifies the configuration of an iSCSI HBA target.
This cmdlet removes targets from their iSCSI HBAs.
This cmdlet creates a new iSCSI HBA target.
