< Back

Set-ScsiLun

Sun Jan 19, 2020 7:09 pm

NAME Set-ScsiLun



SYNOPSIS

This cmdlet modifies the configuration of a SCSI device.





SYNTAX

Set-ScsiLun [[-MultipathPolicy] <ScsiLunMultipathPolicy>] [[-PreferredPath] <ScsiLunPath>] [-ScsiLun] <ScsiLun[]>

[-BlocksToSwitchPath <Int32>] [-CommandsToSwitchPath <Int32>] [-DeletePartitions] [-Force] [-IsLocal <Boolean>]

[-IsLocatorLedOn <Boolean>] [-IsSsd <Boolean>] [-NoBlocksSwitch] [-NoCommandsSwitch] [-Confirm] [-WhatIf]

[<CommonParameters>]





DESCRIPTION

This cmdlet modifies the configuration of a SCSI device.





PARAMETERS

-BlocksToSwitchPath <Int32>

Specifies the maximum number of I/O blocks to be issued on a given path before the system tries to select a

different path. Modifying this setting affects all ScsiLun devices that are connected to the same ESX/ESXi

host. The default value is 2048. Setting this parameter to zero (0) disables switching based on blocks.



Required? false

Position? named

Default value 2048

Accept pipeline input? False

Accept wildcard characters? false



-CommandsToSwitchPath <Int32>

Specifies the maximum number of I/O requests to be issued on a given path before the system tries to select a

different path. Modifying this setting affects all ScsiLun devices that are connected to the same ESX host.

The default value is 50. Setting this parameter to zero (0) disables switching based on commands. This

parameter is not supported on vCenter Server 4.x.



Required? false

Position? named

Default value 50

Accept pipeline input? False

Accept wildcard characters? false



-DeletePartitions [<SwitchParameter>]

Removes all partitions from the SCSI disk. A confirmation prompt appears. If Force is specified, the

confirmation prompt does not appear and partitions are removed.



Required? false

Position? named

Default value False

Accept pipeline input? False

Accept wildcard characters? false



-Force [<SwitchParameter>]

Indicates that you want to suppress the prompt that appears when DeletePartitions is specified. If Force is

specified, you are not asked for confirmation when deleting disk partitions.



Required? false

Position? named

Default value False

Accept pipeline input? False

Accept wildcard characters? false



-IsLocal <Boolean>

Marks the SCSI disk as local or remote. If the value is $true, the SCSI disk is local. If the value is $false,

the SCSI disk is remote.



Required? false

Position? named

Default value None

Accept pipeline input? False

Accept wildcard characters? false



-IsLocatorLedOn <Boolean>

Turns the LED locator of a SCSI disk on or off.



Required? false

Position? named

Default value None

Accept pipeline input? False

Accept wildcard characters? false



-IsSsd <Boolean>

Marks the SCSI disk as an SSD or HDD. If the value is $true, the SCSI disk is SSD type. If the value is

$false, the SCSI disk is HDD type.



Required? false

Position? named

Default value None

Accept pipeline input? False

Accept wildcard characters? false



-MultipathPolicy <ScsiLunMultipathPolicy>

Specifies the policy that the logical unit must use when choosing a path. The following values are valid:



Fixed - uses the preferred path whenever possible. RoundRobin - load balance. MostRecentlyUsed - uses the most

recently used path. Unknown - supported only when connected to vCenter Server 4.1/ESX 4.1.



Passing values to this parameter through a pipeline is deprecated and will be disabled in a future release.



Required? false

Position? 1

Default value None

Accept pipeline input? True (ByValue)

Accept wildcard characters? false



-NoBlocksSwitch [<SwitchParameter>]

Indicates that switching based on blocks is disabled. Not supported on vCenter Server 4.x.



Required? false

Position? named

Default value False

Accept pipeline input? False

Accept wildcard characters? false



-NoCommandsSwitch [<SwitchParameter>]

Indicates that switching based on commands is disabled. Not supported on vCenter Server 4.x.



Required? false

Position? named

Default value False

Accept pipeline input? False

Accept wildcard characters? false



-PreferredPath <ScsiLunPath>

Specifies the preferred path to access the SCSI logical unit. Passing values to this parameter through a

pipeline is deprecated and will be disabled in a future release.



Required? false

Position? 2

Default value None

Accept pipeline input? True (ByValue)

Accept wildcard characters? false



-ScsiLun <ScsiLun[]>

Specifies the SCSI device you want to configure.



Required? true

Position? 3

Default value None

Accept pipeline input? True (ByValue)

Accept wildcard characters? false



-Confirm [<SwitchParameter>]

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



-WhatIf [<SwitchParameter>]

Indicates that the cmdlet is run only to display the changes that would be made and actually no objects are

modified.



Required? false

Position? named

Default value False

Accept pipeline input? False

Accept wildcard characters? false



<CommonParameters>

This cmdlet supports the common parameters: Verbose, Debug,

ErrorAction, ErrorVariable, WarningAction, WarningVariable,

OutBuffer, PipelineVariable, and OutVariable. For more information, see

about_CommonParameters (https:/go.microsoft.com/fwlink/?LinkID=113216).



INPUTS



OUTPUTS

Zero or more modified ScsiLun objects







NOTES









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



$scsilun = Get-ScsiLun -VMHost 10.23.123.100 -LunType disk



Set-ScsiLun -ScsiLun $scsilun -CommandsToSwitchPath 100



Configures the SCSI Lun device of the virtual machine host, so that the maximum number of I/O requests to be

issued before the system tries to select a different path is 100.



RELATED LINKS

Online Version: https://code.vmware.com/doc/preview?id= ... siLun.html

Get-ScsiLun

Get-ScsiLunPath

Set-ScsiLunPath