powershellscripts.com

Tutorials  PowerShell Cmdlet Help for New-IScsiHbaTarget



NAME
New-IScsiHbaTarget

SYNOPSIS
Creates a new iSCSI HBA target.

SYNTAX
New-IScsiHbaTarget -IScsiHba [-Address] [[-Port] ] [-Type ] [[-I
ScsiName] ] [-ChapType ] [-ChapName ] [-ChapPassword ] [-MutualChapEnabled [ ean>]] [-MutualChapName ] [-MutualChapPassword ] [-InheritChap []] [-InheritMutualChap [ oolean>]] [-Server ] [-WhatIf] [-Confirm] []


DESCRIPTION
Creates a new iSCSI HBA target. The cmdlet also enables and configures the CHAP (Challenge Handshake Authentication
Protocol) authentication settings of the new target.

The Address parameter supports both IPv4 and v6 and also supports the string representations of these types. e.g.
"
:".
The Port parameter is used only when the value of the Address parameter does not contain the port. The default port
number is 3260.


PARAMETERS
-IScsiHba
Specify the iSCSI HBA for which you want to create the new target.

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

-Address
Specify the address of the new iSCSI HBA target.

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

-Port
Specify the TCP port of the target.

Required? false
Position? 2
Default value 3260
Accept pipeline input? false
Accept wildcard characters? false

-Type
Specify the type of the target. The valid values are Static and Send.

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

-IScsiName
Specify the iSCSI name of the target. It can be specified only for Static targets.

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

-ChapType
Specify the type of the CHAP (Challenge Handshake Authentication Protocol) you want the new target to use. The
valid values are Prohibited, Discouraged, Preferred, and Required.

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

-ChapName
Specify a CHAP authentication name for the new target.

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

-ChapPassword
Specify a CHAP authentication password for the new target.

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

-MutualChapEnabled []
Indicate that Mutual CHAP is enabled.

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

-MutualChapName
Specify a Mutual CHAP authentication name for the new target.

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

-MutualChapPassword
Specify a Mutual CHAP authentication password for the new target.

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.

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.

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.
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>$hba = Get-VMHost | Get-VMHostHba -Type iScsi

New-IScsiHbaTarget -IScsiHba $hba -Address 10.23.84.73


Creates a new target with IP address 10.23.84.73 on the specified iSCSI HBA device.





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

C:\PS>Get-VMHost | Get-VMHostHba -Type iScsi | New-IScsiHbaTarget -Address "10.23.84.73" -ChapType Preferred -ChapN
ame user -ChapPassword pass


Creates a new target on the provided iSCSI HBA device and configures the CHAP settings of the target.






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