Public/Set-MerakiNetworkApplianceTrafficShapingCPC.ps1
|
function Set-MerakiNetworkApplianceTrafficShapingCPC { <# .SYNOPSIS Updates an existing custom performance class for traffic shaping in a Meraki network using the Meraki Dashboard API. .DESCRIPTION The Set-MerakiNetworkApplianceTrafficShapingCPC function allows you to update an existing custom performance class for traffic shaping in a specified Meraki network by providing the authentication token, network ID, custom performance class ID, and a custom performance class configuration string. .PARAMETER AuthToken The authentication token (API key) required to access the Meraki Dashboard API. .PARAMETER NetworkId The ID of the Meraki network for which you want to update an existing custom performance class. .PARAMETER CustomPerformanceClassId The ID of the custom performance class you want to update. .PARAMETER PerformanceClassConfig A string containing the custom performance class configuration. The string should be in JSON format and should include the "name", "maxLatency", "maxJitter", and "maxLossPercentage" properties. .EXAMPLE $config = [PSCustomObject]@{ name = "myCustomPerformanceClass" maxLatency = 100 maxJitter = 100 maxLossPercentage = 5 } $config = $config | ConvertTo-Json -Compress Set-MerakiNetworkApplianceTrafficShapingCPC -AuthToken "your-api-token" -NetworkId "your-network-id" -CustomPerformanceClassId "your-custom-performance-class-id" -PerformanceClassConfig $config This example updates the custom performance class with ID "your-custom-performance-class-id" for traffic shaping in the Meraki network with ID "your-network-id" using the specified custom performance class configuration. .NOTES The function requires the "Invoke-RestMethod" cmdlet to be available. The function returns the response from the API if the custom performance class update is successful, otherwise, it displays an error message. #> [CmdletBinding()] param ( [parameter(Mandatory=$true)] [string]$AuthToken, [parameter(Mandatory=$true)] [string]$NetworkId, [parameter(Mandatory=$true)] [string]$CustomPerformanceClassId, [parameter(Mandatory=$true)] [string]$PerformanceClassConfig ) try { $header = @{ "X-Cisco-Meraki-API-Key" = $AuthToken "content-type" = "application/json; charset=utf-8" } $body = $PerformanceClassConfig $uri = "https://api.meraki.com/api/v1/networks/$NetworkId/appliance/trafficShaping/customPerformanceClasses/$CustomPerformanceClassId" $response = Invoke-RestMethod -Method Put -Uri $uri -Header $header -UserAgent "MerakiPowerShellModule/1.0.2 DocNougat" -Body $body return $response } catch { Write-Debug $_ Throw $_ } } |