Share via

Set-SCInternetSCSIHba

Module:
VirtualMachineManager Module

Configures iSCSI initiator sessions and logs the initiator on to the iSCSI storage array.

Syntax

CreateSessionArray 

Set-SCInternetSCSIHba
    -InternetSCSIHba <HostInternetSCSIHba>
    -StorageArray <StorageArray>
    [-CreateSession]
    [-RunAsynchronously]
    [-PROTipID <Guid>]
    [-JobVariable <String>]
    [<CommonParameters>]

CreateSession 

Set-SCInternetSCSIHba
    -InternetSCSIHba <HostInternetSCSIHba>
    -TargetPortal <StorageiSCSIPortal>
    [-CreateSession]
    [-InitiatorIP <String>]
    [-TargetName <StorageEndpoint>]
    [-RunAsynchronously]
    [-PROTipID <Guid>]
    [-JobVariable <String>]
    [<CommonParameters>]

Description

The Set-SCInternetSCSIHba cmdlet configures the iSCSI initiator on a virtual machine host. Set-InternetSCSIHba also creates persistent connections to the iSCSI storage array either by 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.

Parameter properties

Type:SwitchParameter
Default value:None
Supports wildcards:False
DontShow:False

Parameter sets

(All)
Position:Named
Mandatory:True
Value from pipeline:False
Value from pipeline by property name:False
Value from remaining arguments:False

-InitiatorIP

Specifies an IP address for the iSCSI initiator.

Parameter properties

Type:String
Default value:None
Supports wildcards:False
DontShow:False

Parameter sets

CreateSession
Position:Named
Mandatory:False
Value from pipeline:False
Value from pipeline by property name:False
Value from remaining arguments:False

-InternetSCSIHba

Specifies an instance of an iSCSI initiator on a host.

Parameter properties

Type:HostInternetSCSIHba
Default value:None
Supports wildcards:False
DontShow:False

Parameter sets

(All)
Position:Named
Mandatory:True
Value from pipeline:False
Value from pipeline by property name:False
Value from remaining arguments:False

-JobVariable

Specifies that job progress is tracked and stored in the variable named by this parameter.

Parameter properties

Type:String
Default value:None
Supports wildcards:False
DontShow:False

Parameter sets

(All)
Position:Named
Mandatory:False
Value from pipeline:False
Value from pipeline by property name:False
Value from remaining arguments:False

-PROTipID

Specifies the ID of the Performance and Resource Optimization tip (PRO tip) that triggered this action. This parameter lets you audit PRO tips.

Parameter properties

Type:Guid
Default value:None
Supports wildcards:False
DontShow:False

Parameter sets

(All)
Position:Named
Mandatory:False
Value from pipeline:False
Value from pipeline by property name:False
Value from remaining arguments:False

-RunAsynchronously

Indicates that the job runs asynchronously so that control returns to the command shell immediately.

Parameter properties

Type:SwitchParameter
Default value:None
Supports wildcards:False
DontShow:False

Parameter sets

(All)
Position:Named
Mandatory:False
Value from pipeline:False
Value from pipeline by property name:False
Value from remaining arguments:False

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

Parameter properties

Type:StorageArray
Default value:None
Supports wildcards:False
DontShow:False

Parameter sets

CreateSessionArray
Position:Named
Mandatory:True
Value from pipeline:False
Value from pipeline by property name:False
Value from remaining arguments:False

-TargetName

Specifies the name for an iSCSI storage array target.

Parameter properties

Type:StorageEndpoint
Default value:None
Supports wildcards:False
DontShow:False

Parameter sets

CreateSession
Position:Named
Mandatory:False
Value from pipeline:False
Value from pipeline by property name:False
Value from remaining arguments:False

-TargetPortal

Specifies an iSCSI storage array target portal object.

Parameter properties

Type:StorageiSCSIPortal
Default value:None
Supports wildcards:False
DontShow:False

Parameter sets

CreateSession
Position:Named
Mandatory:True
Value from pipeline:False
Value from pipeline by property name:False
Value from remaining arguments:False

CommonParameters

This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutBuffer, -OutVariable, -PipelineVariable, -ProgressAction, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters.

Outputs

HostInternetSCSIHBA

This cmdlet returns a HostInternetSCSIHBA object.