< Back

Set-VDTrafficShapingPolicy

Sun Jan 19, 2020 7:25 pm

NAME Set-VDTrafficShapingPolicy



SYNOPSIS

This cmdlet modifies the traffic shaping policy for distributed ports.





SYNTAX

Set-VDTrafficShapingPolicy [-Policy] <TrafficShapingPolicy[]> [-AverageBandwidth <Int64>]

[-AverageBandwidthInherited <Boolean>] [-BurstSize <Int64>] [-BurstSizeInherited <Boolean>] [-Enabled <Boolean>]

[-EnabledInherited <Boolean>] [-PeakBandwidth <Int64>] [-PeakBandwidthInherited <Boolean>] [-Confirm] [-WhatIf]

[<CommonParameters>]





DESCRIPTION

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).





PARAMETERS

-AverageBandwidth <Int64>

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.



Required? false

Position? named

Default value None

Accept pipeline input? False

Accept wildcard characters? false



-AverageBandwidthInherited <Boolean>

Specifies whether the AverageBandwidth setting is inherited from a parent object, such as a distributed port

group or switch.



Required? false

Position? named

Default value None

Accept pipeline input? False

Accept wildcard characters? false



-BurstSize <Int64>

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.



Required? false

Position? named

Default value None

Accept pipeline input? False

Accept wildcard characters? false



-BurstSizeInherited <Boolean>

Specifies whether the BurstSize setting is inherited from a parent object, such as a distributed port group or

switch.



Required? false

Position? named

Default value None

Accept pipeline input? False

Accept wildcard characters? false



-Enabled <Boolean>

Specifies whether traffic shaping is enabled for the corresponding distributed port, port group, or switch.



Required? false

Position? named

Default value None

Accept pipeline input? False

Accept wildcard characters? false



-EnabledInherited <Boolean>

Specifies whether the Enabled setting is inherited from a parent object, such as a distributed port group or

switch.



Required? false

Position? named

Default value None

Accept pipeline input? False

Accept wildcard characters? false



-PeakBandwidth <Int64>

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.



Required? false

Position? named

Default value None

Accept pipeline input? False

Accept wildcard characters? false



-PeakBandwidthInherited <Boolean>

Specifies whether the PeakBandwidth setting is inherited from a parent object, such as a distributed port

group or switch.



Required? false

Position? named

Default value None

Accept pipeline input? False

Accept wildcard characters? false



-Policy <TrafficShapingPolicy[]>

Specifies the traffic shaping policy that you want to configure.



Required? true

Position? 1

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 False

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

The modified TrafficShapingPolicy objects







NOTES









-------------------------- 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 LINKS

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

Get-VDTrafficShapingPolicy