Public/Get-LMCollectorDebugResult.ps1
|
<# .SYNOPSIS Retrieves the debug result for a LogicMonitor collector. .DESCRIPTION The Get-LMCollectorDebugResult function retrieves the debug result for a LogicMonitor collector based on the specified session ID, collector ID, or collector name. .PARAMETER SessionId The session ID of the debug session. .PARAMETER Id The ID of the collector. This parameter is mandatory when using the 'Id' parameter set. .PARAMETER Name The name of the collector. This parameter is mandatory when using the 'Name' parameter set. .EXAMPLE Get-LMCollectorDebugResult -SessionId 12345 -Id 67890 Retrieves the debug result for the collector with ID 67890 in the debug session with ID 12345. .EXAMPLE Get-LMCollectorDebugResult -SessionId 12345 -Name "Collector1" Retrieves the debug result for the collector with name "Collector1" in the debug session with ID 12345. .NOTES This function requires a valid LogicMonitor API authentication. Use Connect-LMAccount to authenticate before running this command. #> Function Get-LMCollectorDebugResult { [CmdletBinding()] Param ( [Parameter(Mandatory)] [Int]$SessionId, [Parameter(Mandatory, ParameterSetName = 'Id')] [Int]$Id, [Parameter(Mandatory, ParameterSetName = 'Name')] [String]$Name ) #Check if we are logged in and have valid api creds Begin {} Process { If ($Script:LMAuth.Valid) { #Lookup device name If ($Name) { If ($Name -Match "\*") { Write-Error "Wildcard values not supported for collector names." return } $Id = (Get-LMCollector -Name $Name | Select-Object -First 1 ).Id If (!$Id) { Write-Error "Unable to find collector: $Name, please check spelling and try again." return } } #Build header and uri $ResourcePath = "/debug/$SessionId" #Build query params $QueryParams = "?collectorId=$Id" Try { $Headers = New-LMHeader -Auth $Script:LMAuth -Method "GET" -ResourcePath $ResourcePath $Uri = "https://$($Script:LMAuth.Portal).logicmonitor.com/santaba/rest" + $ResourcePath + $QueryParams Resolve-LMDebugInfo -Url $Uri -Headers $Headers[0] -Command $MyInvocation #Issue request $Response = Invoke-RestMethod -Uri $Uri -Method "GET" -Headers $Headers[0] -WebSession $Headers[1] } Catch [Exception] { $Proceed = Resolve-LMException -LMException $PSItem If (!$Proceed) { Return } } Return $Response.output } Else { Write-Error "Please ensure you are logged in before running any commands, use Connect-LMAccount to login and try again." } } End {} } |