Public/Get-LMDeviceGroupAlert.ps1
|
<# .SYNOPSIS Retrieves alerts for a LogicMonitor device group. .DESCRIPTION The Get-LMDeviceGroupAlert function retrieves all alerts associated with a specific device group in LogicMonitor. The device group can be identified by either ID or name, and the results can be filtered. .PARAMETER Id The ID of the device group to retrieve alerts for. This parameter is mandatory when using the Id parameter set and can accept pipeline input. .PARAMETER Name The name of the device group to retrieve alerts for. Part of a mutually exclusive parameter set. .PARAMETER Filter A filter object to apply when retrieving alerts. This parameter is optional. .PARAMETER BatchSize The number of results to return per request. Must be between 1 and 1000. Defaults to 1000. .EXAMPLE #Retrieve alerts for a device group by ID Get-LMDeviceGroupAlert -Id 123 .EXAMPLE #Retrieve alerts for a device group by name with filter Get-LMDeviceGroupAlert -Name "Production Servers" -Filter $filterObject .NOTES You must run Connect-LMAccount before running this command. .INPUTS System.Int32. The device group ID can be piped to this function. .OUTPUTS Returns alert objects for the specified device group. #> function Get-LMDeviceGroupAlert { [CmdletBinding(DefaultParameterSetName = 'Id')] param ( [Parameter(Mandatory, ParameterSetName = 'Id', ValueFromPipelineByPropertyName)] [Int]$Id, [Parameter(ParameterSetName = 'Name')] [String]$Name, [Object]$Filter, [ValidateRange(1, 1000)] [Int]$BatchSize = 1000 ) begin {} process { #Check if we are logged in and have valid api creds if ($Script:LMAuth.Valid) { if ($Name) { $LookupResult = (Get-LMDeviceGroup -Name $Name).Id if (Test-LookupResult -Result $LookupResult -LookupString $Name) { return } $Id = $LookupResult } #Build header and uri $ResourcePath = "/device/groups/$Id/alerts" $SingleObjectWhenNotPaged = $false $CallerPSCmdlet = $PSCmdlet $Results = Invoke-LMPaginatedGet -BatchSize $BatchSize -SingleObjectWhenNotPaged:$SingleObjectWhenNotPaged -InvokeRequest { param($Offset, $PageSize) $RequestResourcePath = $ResourcePath $QueryParams = "?size=$PageSize&offset=$Offset&sort=+id" if ($Filter) { $ValidFilter = Format-LMFilter -Filter $Filter -ResourcePath $ResourcePath $QueryParams = "?filter=$ValidFilter&size=$PageSize&offset=$Offset&sort=+id" } $Headers = New-LMHeader -Auth $Script:LMAuth -Method "GET" -ResourcePath $RequestResourcePath $Uri = "https://$($Script:LMAuth.Portal).$(Get-LMPortalURI)" + $RequestResourcePath + $QueryParams Resolve-LMDebugInfo -Url $Uri -Headers $Headers[0] -Command $MyInvocation #Issue request $Response = Invoke-LMRestMethod -CallerPSCmdlet $CallerPSCmdlet -Uri $Uri -Method "GET" -Headers $Headers[0] -WebSession $Headers[1] #If the API call failed (for example, resource not found), stop processing. if ($null -eq $Response) { return } return $Response } if ($null -eq $Results) { return } return $Results } else { Write-Error "Please ensure you are logged in before running any commands, use Connect-LMAccount to login and try again." } } } |