Public/Set-MerakiOrganizationInsightMonitoredMediaServer.ps1
|
function Set-MerakiOrganizationInsightMonitoredMediaServer { <# .SYNOPSIS Updates a monitored media server for a Meraki organization's insight. .DESCRIPTION The Set-MerakiOrganizationInsightMonitoredMediaServer function allows you to update a monitored media server for a specified Meraki organization's insight by providing the authentication token, organization ID, monitored media server ID, and a monitored media server configuration string. .PARAMETER AuthToken The authentication token (API key) required to access the Meraki Dashboard API. .PARAMETER OrganizationId The organization ID of the Meraki organization for which you want to update the monitored media server. .PARAMETER MonitoredMediaServerId The ID of the monitored media server that you want to update. .PARAMETER MonitoredMediaServerConfig A string containing the monitored media server configuration. The string should be in JSON format and should include the properties as defined in the schema. .EXAMPLE $MonitoredMediaServerConfig = [PSCustomObject]@{ name = "Sample VoIP Provider" address = "123.123.123.1" bestEffortMonitoringEnabled = $true } $MonitoredMediaServerConfig = $MonitoredMediaServerConfig | ConvertTo-Json -Compress Set-MerakiOrganizationInsightMonitoredMediaServer -AuthToken "your-api-token" -OrganizationId "1234" -MonitoredMediaServerId "1" -MonitoredMediaServerConfig $MonitoredMediaServerConfig This example updates a monitored media server for the Meraki organization with ID "1234". .NOTES The function requires the "Invoke-RestMethod" cmdlet to be available. The function returns the response from the API if the update 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]$MonitoredMediaServerId, [parameter(Mandatory=$true)] [string]$MonitoredMediaServerConfig ) 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" } $url = "https://api.meraki.com/api/v1/organizations/$OrganizationId/insight/monitoredMediaServers/$MonitoredMediaServerId" $response = Invoke-RestMethod -Method Put -Uri $url -headers $header -UserAgent "MerakiPowerShellModule/1.1.2 DocNougat" -Body $MonitoredMediaServerConfig return $response } catch { Write-Debug $_ Throw $_ } } } |