PowerCLI Reference

Set-VDUplinkLacpPolicy

Synopsis

This cmdlet modifies the Link Aggregation Control Protocol policy for uplink ports.

Syntax

Set-VDUplinkLacpPolicy [-Policy] <UplinkLacpPolicy[]> [-Enabled <Boolean>] [-EnabledInherited <Boolean>] [-Mode <UplinkLacpMode>] [-ModeInherited <Boolean>] [-WhatIf] [-Confirm] [<CommonParameters>]

Related Commands

Online version
Get-VDUplinkLacpPolicy

Detailed Description

This cmdlet modifies the Link Aggregation Control Protocol policy for uplink ports at switch or uplink port group level.

Parameters

NameTypeDescriptionRequired?Pipeline InputDefault Value
PolicyUplinkLacpPolicy[]Specifies the Link Aggregation Control Protocol policy that you want to configure.truetrue (ByValue)
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
EnabledBooleanSpecifies whether the Link Aggregation Control Protocol is enabled for the corresponding uplink port group or vSphere distributed switch.falsefalse
EnabledInheritedBooleanSpecifies whether the Enabled setting is inherited from a parent object, such as a vSphere distributed switch.falsefalse
ModeUplinkLacpModeSpecifies the mode of the Link Aggregation Control Protocol policy for the corresponding uplink port group or vSphere distributed switch. The value can be Active or Passive.falsefalse
ModeInheritedBooleanSpecifies whether the Mode setting is inherited from a parent object, such as a vSphere distributed switch.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 modified VDUplinkLacpPolicy objects

Notes

Examples

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

Get-VDSwitch "MyVDSwitch" | Get-VDUplinkLacpPolicy | Set-VDUplinkLacpPolicy -Enabled $true -Mode Active

Retrieves a vSphere distributed switch named "MyVDSwitch" and updates its policy to enable the Link Aggregation Control Protocol, and sets the corresponding policy mode to active.

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

Get-VDPortgroup "MyVDPortgroup" | Get-VDUplinkLacpPolicy | Set-VDUplinkLacpPolicy -ModeInherited $true

Retrieves a distributed port group named "MyVDPortgroup" and updates its Link Aggregation Control Protocol mode based on its parent object's setting values.


Copyright © VMware, Inc. All rights reserved.