PowerCLI Reference

Set-VsanIscsiInitiatorGroup

Synopsis

This cmdlet modifies the specified vSAN iSCSI initiator groups.

Syntax

Set-VsanIscsiInitiatorGroup [-InitiatorGroup] <VsanIscsiInitiatorGroup[]> [-AddInitiator <String[]>] [-RemoveInitiator <String[]>] [-Server <VIServer[]>] [-Confirm] [-WhatIf] [<CommonParameters>]

Related Commands

Online Version
Get-VsanIscsiInitiatorGroup
New-VsanIscsiInitiatorGroup
Remove-VsanIscsiInitiatorGroup

Detailed Description

This cmdlet modifies the specified vSAN iSCSI initiator groups.

Parameters

NameTypeDescriptionRequired?Pipeline InputDefault Value
InitiatorGroupVsanIscsiInitiatorGroup[]Specifies the vSAN iSCSI initiator group to which you want to add or remove initiators.trueTrue (ByValue)
AddInitiatorString[]Specifies the names of the vSAN iSCSI initiators which you want to add to the initiator group.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
RemoveInitiatorString[]Specifies the names of the vSAN iSCSI initiators which you want to remove from the initiator group.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
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 VsanIscsiInitiatorGroup objects

Notes

Examples

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

Set-VsanIscsiInitiatorGroup -InitiatorGroup $initiatorGroup -AddInitiator "initiator1-iqn", "initiator2-iqn" -RemoveInitiator "initiator3-iqn"

Adds iSCSI initiators with IQN "initiator1-iqn" and "initiator2-iqn" to the $initiatorGroup initiator group and removes iSCSI initiator with IQN "initiator3-iqn" from the initiator group.


Copyright © VMware, Inc. All rights reserved.