Public/Get-LMReport.ps1
|
<# .SYNOPSIS Retrieves reports from LogicMonitor. .DESCRIPTION The Get-LMReport function retrieves report configurations from LogicMonitor. It can retrieve all reports, a specific report by ID or name, or filter the results using either a filter object or the filter wizard. .PARAMETER Id The ID of the specific report to retrieve. .PARAMETER Name The name of the specific report to retrieve. .PARAMETER Filter A filter object to apply when retrieving reports. .PARAMETER FilterWizard Switch to enable the filter wizard for building a custom filter interactively. .PARAMETER BatchSize The number of results to return per request. Must be between 1 and 1000. Defaults to 1000. .EXAMPLE #Retrieve all reports Get-LMReport .EXAMPLE #Retrieve a specific report by name Get-LMReport -Name "Monthly Usage Report" .NOTES You must run Connect-LMAccount before running this command. .INPUTS None. You cannot pipe objects to this command. .OUTPUTS Returns LogicMonitor.Report objects. #> function Get-LMReport { [CmdletBinding(DefaultParameterSetName = 'All')] [Diagnostics.CodeAnalysis.SuppressMessageAttribute('PSReviewUnusedParameter', '', Justification = 'Required for the FilterWizard to work')] param ( [Parameter(ParameterSetName = 'Id')] [Int]$Id, [Parameter(ParameterSetName = 'Name')] [String]$Name, [Parameter(ParameterSetName = 'Filter')] [Object]$Filter, [Parameter(ParameterSetName = 'FilterWizard')] [Switch]$FilterWizard, [ValidateRange(1, 1000)] [Int]$BatchSize = 1000 ) #Check if we are logged in and have valid api creds if ($Script:LMAuth.Valid) { #Build header and uri $ResourcePath = "/report/reports" #Initalize vars $QueryParams = "" $Count = 0 $Done = $false $Results = @() #Loop through requests while (!$Done) { #Build query params switch ($PSCmdlet.ParameterSetName) { "All" { $QueryParams = "?size=$BatchSize&offset=$Count&sort=+id" } "Id" { $resourcePath += "/$Id" } "Name" { $QueryParams = "?filter=name:`"$Name`"&size=$BatchSize&offset=$Count&sort=+id" } "Filter" { #List of allowed filter props $PropList = @() $ValidFilter = Format-LMFilter -Filter $Filter -PropList $PropList $QueryParams = "?filter=$ValidFilter&size=$BatchSize&offset=$Count&sort=+id" } "FilterWizard" { $PropList = @() $Filter = Build-LMFilter -PassThru $ValidFilter = Format-LMFilter -Filter $Filter -PropList $PropList $QueryParams = "?filter=$ValidFilter&size=$BatchSize&offset=$Count&sort=+id" } } $Headers = New-LMHeader -Auth $Script:LMAuth -Method "GET" -ResourcePath $ResourcePath $Uri = "https://$($Script:LMAuth.Portal).$(Get-LMPortalURI)" + $ResourcePath + $QueryParams Resolve-LMDebugInfo -Url $Uri -Headers $Headers[0] -Command $MyInvocation #Issue request $Response = Invoke-LMRestMethod -CallerPSCmdlet $PSCmdlet -Uri $Uri -Method "GET" -Headers $Headers[0] -WebSession $Headers[1] #Stop looping if single device, no need to continue if ($PSCmdlet.ParameterSetName -eq "Id") { $Done = $true return (Add-ObjectTypeInfo -InputObject $Response -TypeName "LogicMonitor.Report" ) } #Check result size and if needed loop again else { [Int]$Total = $Response.Total [Int]$Count += ($Response.Items | Measure-Object).Count $Results += $Response.Items if ($Count -ge $Total) { $Done = $true } } } return (Add-ObjectTypeInfo -InputObject $Results -TypeName "LogicMonitor.Report" ) } else { Write-Error "Please ensure you are logged in before running any commands, use Connect-LMAccount to login and try again." } } |