powershellscripts.com

Tutorials  PowerShell Cmdlet Help for Set-IScsiHbaTarget



NAME
Set-IScsiHbaTarget

SYNOPSIS
Configures an iSCSI HBA target.

SYNTAX
Set-IScsiHbaTarget -Target [-ChapType ] [-ChapName ] [-ChapPassword ]
[-MutualChapEnabled []] [-MutualChapName ] [-MutualChapPassword ] [-InheritChap [
]] [-InheritMutualChap []] [-Server ] [-WhatIf] [-Confirm] []


DESCRIPTION
Configures an iSCSI HBA target. The cmdlet modifies the CHAP and Digest properties of a iSCSI HBA target. You must
specify at least one of the CHAP-related (or Mutual CHAP) parameters. Otherwise, an error message is displayed.


PARAMETERS
-Target
Specify the iSCSI HBA target you want to configure. To identify the target, you can provide an IScsiTarget obje
ct or use an
: string.

Required? true
Position? named
Default value
Accept pipeline input? true (ByValue)
Accept wildcard characters? true

-ChapType
Specify the type of the CHAP authorization. The valid values are Prohibited, Discouraged, Preferred, and Requir
ed. If you set ChapType to Discouraged, Preferred, or Required, then you must specify the ChapPassword paramete
r as well.

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

-ChapName
Specify 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
Specify the CHAP password if CHAP is enabled.

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

-MutualChapEnabled []
Indicate that mutual CHAP is enabled. In this case, you must specify the MutualChapPassword parameter as well.

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

-MutualChapName
Specify the Mutual 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

-MutualChapPassword
Specify the Mutual CHAP password if CHAP is enabled.

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

-InheritChap []
Indicate that the CHAP setting is inherited from the iSCSI HBA device.

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

-InheritMutualChap []
Indicate that the Mutual CHAP setting is inherited from the iSCSI HBA device.

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

-Server
Specify the vSphere servers on which you want to run the cmdlet. If no value is given to this parameter, the co
mmand runs on the default servers. For more information about default servers, see the description of Connect-V
IServer.

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

-WhatIf
Indicate that the cmdlet is run only to display the changes that would be made and actually no objects are modi
fied.

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

-Confirm
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


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
IScsiHbaTarget[]


NOTES


CHAP configuration is supported only on vCenter Server/ESX 4.0 and later.

-------------- Example 1 --------------

C:\PS>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 --------------

C:\PS>$target = Get-IScsiHbaTarget -Address "10.23.84.73" -Type Send

Set-IScsiHbaTarget -Target $target -ChapType Required -ChapPassword pass1 -MutualChapEnabled -MutualChapPassword pa
ss2


Modifies the CHAP and Mutual CHAP settings of the targets of type Send on the specified address.






RELATED LINKS
Online version: http://www.vmware.com/support/developer/PowerCLI/PowerCLI501/html/Set-IScsiHbaTarget.html
Get-IScsiHbaTarget
New-IScsiHbaTarget
Remove-IScsiHbaTarget
Get-VMHostHba
Set-VMHostHba