powershellscripts.com

Tutorials  PowerShell Cmdlet Help for Set-VMHostHba



NAME
Set-VMHostHba

SYNOPSIS
Configures the CHAP properties of the given iSCSI HBAs.

SYNTAX
Set-VMHostHba -IScsiHba [-IScsiName ] [-ChapType ] [-ChapName ] [-ChapPasswo
rd ] [-MutualChapEnabled []] [-MutualChapName ] [-MutualChapPassword ] [-Server IServer[]>] [-WhatIf] [-Confirm] []


DESCRIPTION
Configures the CHAP properties of the given iSCSI HBAs.
If (Mutual)ChapType is set to a value different from "Prohibited", (Mutual)ChapPassword must be set.
ChapType, MutualChapType, MutualChapName, MutualChapPassword - these are only available on 4.0 or later.
Note: for ESX 3.5 or older - setting ChapType to a value different from Prohibited will enable Chap authentication
and in the output object ChapType property will have a value "Required".
Run Set-VmHostHba directly against ESX. When Set-VmHostHba is run against vCenter Server, changing the iScsiName p
roperty of an iSCSI adapter modifies its AuthenticationCapabilities property.


PARAMETERS
-IScsiHba
Specify the iSCSI HBA device you want to configure.

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

-IScsiName
Specify a new name for the host HBA device.

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

-ChapType
Specify the type of the CHAP authorization. The valid values are Prohibited, Discouraged, Preferred, and Requir
ed.

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 authorization is enabled.

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

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

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
Hba


NOTES


The ChapType, MutualChapType, MutualChapName, and MutualChapPassword parameters are supported only on vCenter S
erver/ESX 4.0 or later.
For ESX 3.5 or older, if you give the ChapType parameter a value different from "Prohibited", CHAP authenticati
on is enabled and the value of the ChapType property of the output object will be "Required".

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

C:\PS>Get-VMHostHba -Type iScsi | Set-VMHostHba -ChapType Required -ChapName Admin -ChapPassword pass


Changes the CHAP type of the available iScsi to Required.





-------------- Example 2 --------------

C:\PS>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: http://www.vmware.com/support/developer/PowerCLI/PowerCLI501/html/Set-VMHostHba.html
Get-VMHostHba
New-IScsiHbaTarget
Remove-IScsiHbaTarget
Set-IScsiHbaTarget