PowerCLI Reference

Set-VsanIscsiLun

Synopsis

This cmdlet modifies the specified vSAN iSCSI LUNs.

Syntax

Set-VsanIscsiLun [-Lun] <VsanIscsiLun[]> [-Name <String>] [-IsOnline <Boolean>] [-CapacityGB <Decimal>] [-LunId <Int32>] [-StoragePolicy <SpbmStoragePolicy>] [-Server <VIServer[]>] [-RunAsync] [-WhatIf] [-Confirm] [<CommonParameters>]

Related Commands

Online version
Get-VsanIscsiLun
New-VsanIscsiLun
Remove-VsanIscsiLun

Detailed Description

This cmdlet modifies the specified vSAN iSCSI LUNs.

Parameters

NameTypeDescriptionRequired?Pipeline InputDefault Value
LunVsanIscsiLun[]Specifies the vSAN iSCSI LUNs you want to modify.truetrue (ByValue)
CapacityGBDecimalSpecifies the new capacity of the vSAN iSCSI LUN in gigabytes (GB). The LUN size can only increase. This operation is possible only when the LUN is in offline state.falsefalse
ConfirmSwitchParameterIf 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.falsefalse
IsOnlineBooleanPuts the iSCSI LUN in offline or online state.falsefalse
LunIdInt32Specifies the new LUN ID of the iSCSI LUN. The value must be in the range from 0 to 255. The LUN ID can be changed only when the LUN is in offline state.falsefalse
NameStringSpecifies the new name of the vSAN iSCSI LUN.falsefalse
RunAsyncSwitchParameterIndicates that the command returns immediately without waiting for the task to complete. In this mode, the output of the cmdlet is a Task object. For more information about the RunAsync parameter run "help About_RunAsync" in the VMware PowerCLI console.falsefalse
ServerVIServer[]Specifies the vCenter Server systems on which you want to run the cmdlet. If no value is given to this parameter, the command runs on the default servers. For more information about default servers, see the description of Connect-VIServer.falsefalse
StoragePolicySpbmStoragePolicySpecifies the storage policy associated with the vSAN iSCSI LUN.falsefalse
WhatIfSwitchParameterIndicates that the cmdlet is run only to display the changes that would be made and actually no objects are modified.falsefalse

Return Type

The list of modified VsanIscsiLun objects

Notes

Examples

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

Set-VsanIscsiLun -Lun $lun -CapacityGB 3

Increases the capacity of the $lun iSCSI LUN to 3 GB.

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

Set-VsanIscsiLun -Lun $lun -IsOnline $false

Puts the $lun iSCSI LUN in offline state.


Copyright © VMware, Inc. All rights reserved.