Set-VDTrafficShapingPolicy Command | Vmware PowerCLI Reference

Set-VDTrafficShapingPolicy

This cmdlet modifies the traffic shaping policy for distributed ports or the default port policy at port group or switch level (depending on the input policy).

Syntax

Set-VDTrafficShapingPolicy
[-AverageBandwidth < Int64 > ]
[-AverageBandwidthInherited < Boolean > ]
[-BurstSize < Int64 > ]
[-BurstSizeInherited < Boolean > ]
[-Enabled < Boolean > ]
[-EnabledInherited < Boolean > ]
[-PeakBandwidth < Int64 > ]
[-PeakBandwidthInherited < Boolean > ]
[-ProgressAction < ActionPreference > ]
[CommonParameters]

Parameters

Required Parameter Name Type Position Features Description
required
Policy TrafficShapingPolicy[] named
  • pipeline
Specifies the traffic shaping policy that you want to configure.
optional AverageBandwidth Int64 named
Specifies the average bandwidth of the traffic shaping policy for the corresponding distributed port, port group, or switch. The value is in bits per second.
optional AverageBandwidthInherited Boolean named
Specifies whether the AverageBandwidth setting is inherited from a parent object, such as a distributed port group or switch.
optional BurstSize Int64 named
Specifies the burst size of the traffic shaping policy for the corresponding distributed port, port group, or switch. The value is in bits per second.
optional BurstSizeInherited Boolean named
Specifies whether the BurstSize setting is inherited from a parent object, such as a distributed port group or switch.
optional Enabled Boolean named
Specifies whether traffic shaping is enabled for the corresponding distributed port, port group, or switch.
optional EnabledInherited Boolean named
Specifies whether the Enabled setting is inherited from a parent object, such as a distributed port group or switch.
optional PeakBandwidth Int64 named
Specifies the peak bandwidth of the traffic shaping policy for the corresponding distributed port, port group, or switch. The value is in bits per second.
optional PeakBandwidthInherited Boolean named
Specifies whether the PeakBandwidth setting is inherited from a parent object, such as a distributed port group or switch.
optional ProgressAction ActionPreference named

Output

VMware.VimAutomation.Vds.Types.V1.Policy.TrafficShapingPolicy

Examples

Example 1

Get-VDSwitch "MyVDSwitch" | Get-VDPortgroup "MyVDPortgroup" | Get-VDPort -Key 4| Get-VDTrafficShapingPolicy -Direction In | Set-VDTrafficShapingPolicy -Enabled $true -AverageBandwidth 100000

Enables traffic shaping for a specific port in a distributed port group named "MyVDPortgroup" and updates the average bandwidth settings in their traffic shaping policies.

Example 2

Get-VDPortgroup "MyVDPortgroup" | Get-VDTrafficShapingPolicy | Set-VDTrafficShapingPolicy -BurstSizeInherited

Retrieves a distributed port group named "MyVDPortgroup" and updates its traffic shaping policy by inheriting the burst size from its corresponding parent.

Related Commands

VDTrafficShapingPolicy

This cmdlet retrieves the traffic shaping policy for distributed ports.

This cmdlet modifies the traffic shaping policy for distributed ports.