Public/Set-MerakiOrganizationAdaptivePolicy.ps1
|
function Set-MerakiOrganizationAdaptivePolicy { <# .SYNOPSIS Updates an existing adaptive policy for a Meraki organization using the Meraki Dashboard API. .DESCRIPTION The Set-MerakiOrganizationAdaptivePolicy function allows you to update an existing adaptive policy for a specified Meraki organization by providing the authentication token, organization ID, policy ID, and policy configuration. .PARAMETER AuthToken The authentication token (API key) required to access the Meraki Dashboard API. .PARAMETER OrganizationId The ID of the Meraki organization for which you want to update an adaptive policy. .PARAMETER PolicyId The ID of the adaptive policy you want to update. .PARAMETER PolicyConfig The JSON configuration for the adaptive policy. Refer to the JSON schema for required parameters and their format. .EXAMPLE $config = [PSCustomObject]@{ "name" = "Test Policy" "description" = "Test Policy description" "lastEntryRule" = "default" "destinationGroup" = @{ "id" = "1234567890" "name" = "Test Destination Group" "sgt" = 123 } "sourceGroup" = @{ "id" = "0987654321" "name" = "Test Source Group" "sgt" = 456 } "acls" = @( @{ "id" = "1111111111" "name" = "Test ACL 1" }, @{ "id" = "2222222222" "name" = "Test ACL 2" } ) } $configJson = $config | ConvertTo-Json -Compress Set-MerakiOrganizationAdaptivePolicy -AuthToken "your-api-token" -OrganizationId "1234567890" -PolicyId "1234567890" -PolicyConfig $configJson This example updates the adaptive policy with ID "1234567890" for the Meraki organization with ID "1234567890" using the provided policy configuration. .NOTES The function requires the "Invoke-RestMethod" cmdlet to be available. The function returns the response from the API if the configuration is successful, otherwise, it displays an error message. #> [CmdletBinding()] param ( [parameter(Mandatory=$true)] [string]$AuthToken, [parameter(Mandatory=$false)] [string]$OrganizationID = (Get-OrgID -AuthToken $AuthToken), [parameter(Mandatory=$true)] [string]$PolicyId, [parameter(Mandatory=$true)] [string]$PolicyConfig ) If($OrganizationID -eq "Multiple organizations found. Please specify an organization ID.") { Return "Multiple organizations found. Please specify an organization ID." } else { try { $header = @{ "X-Cisco-Meraki-API-Key" = $AuthToken "content-type" = "application/json; charset=utf-8" } $body = $PolicyConfig $url = "https://api.meraki.com/api/v1/organizations/$OrganizationId/adaptivePolicy/policies/$PolicyId" $response = Invoke-RestMethod -Method Put -Uri $url -headers $header -UserAgent "MerakiPowerShellModule/1.1.2 DocNougat" -Body $body return $response } catch { Write-Debug $_ Throw $_ } } } |