Set-SCInternetSCSIHba
Set-SCInternetSCSIHba
Configures iSCSI initiator sessions and logs the initiator on to the iSCSI storage array.
Syntax
Parameter Set: CreateSession
Set-SCInternetSCSIHba -CreateSession -InternetSCSIHba <HostInternetSCSIHba> -TargetPortal <StorageiSCSIPortal> [-InitiatorIP <String> ] [-JobVariable <String> ] [-PROTipID <Guid]> ] [-RunAsynchronously] [-TargetName <StorageEndpoint> ] [ <CommonParameters>]
Parameter Set: CreateSessionArray
Set-SCInternetSCSIHba -CreateSession -InternetSCSIHba <HostInternetSCSIHba> -StorageArray <StorageArray> [-JobVariable <String> ] [-PROTipID <Guid]> ] [-RunAsynchronously] [ <CommonParameters>]
Detailed Description
The Set-SCInternetSCSIHba cmdlet configures the iSCSI initiator on a virtual machine host. Set-SCInternetSCSIHba also creates persistent connections to the iSCSI storage array by either explicitly specifying the initiator IP, target name, and target portal or by allowing Virtual Machine Manager (VMM) to automatically create multiple connections to the iSCSI storage array based on subnet matching.
Parameters
-CreateSession
Indicates that an iSCSI session is created.
Aliases |
none |
Required? |
true |
Position? |
named |
Default Value |
none |
Accept Pipeline Input? |
false |
Accept Wildcard Characters? |
false |
-InitiatorIP<String>
Specifies an IP address for the iSCSI initiator.
Aliases |
none |
Required? |
false |
Position? |
named |
Default Value |
none |
Accept Pipeline Input? |
false |
Accept Wildcard Characters? |
false |
-InternetSCSIHba<HostInternetSCSIHba>
Specifies an instance of an iSCSI initiator on a host.
Aliases |
none |
Required? |
true |
Position? |
named |
Default Value |
none |
Accept Pipeline Input? |
false |
Accept Wildcard Characters? |
false |
-JobVariable<String>
Specifies that job progress is tracked and stored in the variable named by this parameter.
Aliases |
none |
Required? |
false |
Position? |
named |
Default Value |
none |
Accept Pipeline Input? |
false |
Accept Wildcard Characters? |
false |
-PROTipID<Guid]>
Specifies the ID of the PRO tip that triggered this action. This allows for auditing of PRO tips.
Aliases |
none |
Required? |
false |
Position? |
named |
Default Value |
none |
Accept Pipeline Input? |
false |
Accept Wildcard Characters? |
false |
-RunAsynchronously
Indicates that the job runs asynchronously so that control returns to the command shell immediately.
Aliases |
none |
Required? |
false |
Position? |
named |
Default Value |
none |
Accept Pipeline Input? |
false |
Accept Wildcard Characters? |
false |
-StorageArray<StorageArray>
Specifies a storage array object. This can be a Fibre Channel or iSCSI storage sub-system that is used to store virtual machine configuration and virtual disks.
Aliases |
none |
Required? |
true |
Position? |
named |
Default Value |
none |
Accept Pipeline Input? |
false |
Accept Wildcard Characters? |
false |
-TargetName<StorageEndpoint>
Specifies the name for an iSCSI storage array target.
Aliases |
none |
Required? |
false |
Position? |
named |
Default Value |
none |
Accept Pipeline Input? |
false |
Accept Wildcard Characters? |
false |
-TargetPortal<StorageiSCSIPortal>
Specifies an iSCSI storage array target portal object.
Aliases |
none |
Required? |
true |
Position? |
named |
Default Value |
none |
Accept Pipeline Input? |
false |
Accept Wildcard Characters? |
false |
<CommonParameters>
This cmdlet supports the common parameters: -Verbose, -Debug, -ErrorAction, -ErrorVariable, -OutBuffer, and -OutVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/p/?LinkID=113216).
Inputs
The input type is the type of the objects that you can pipe to the cmdlet.
Outputs
The output type is the type of the objects that the cmdlet emits.
- HostInternetSCSIHBA