Public/Get-LMDeviceLogSourceList.ps1
|
<# .SYNOPSIS Retrieves a list of log sources for a LogicMonitor device. .DESCRIPTION The Get-LMDeviceLogSourceList function retrieves all log sources associated with a specific device. The device can be identified by either ID or name, and the results can be filtered. .PARAMETER Id The ID of the device. Required for Id parameter set. .PARAMETER Name The name of the device. Required for Name parameter set. .PARAMETER Filter A filter object to apply when retrieving log sources. 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 log sources by device ID Get-LMDeviceLogSourceList -Id 123 .EXAMPLE #Retrieve log sources by device name with filter Get-LMDeviceLogSourceList -Name "MyDevice" -Filter $filterObject .NOTES You must run Connect-LMAccount before running this command. .INPUTS None. You cannot pipe objects to this command. .OUTPUTS Returns log source objects. #> function Get-LMDeviceLogSourceList { [CmdletBinding(DefaultParameterSetName = 'Id')] param ( [Parameter(Mandatory, ParameterSetName = 'Id')] [Int]$Id, [Parameter(ParameterSetName = 'Name')] [String]$Name, [Object]$Filter, [ValidateRange(1, 1000)] [Int]$BatchSize = 1000 ) #Check if we are logged in and have valid api creds if ($Script:LMAuth.Valid) { if ($Name) { $LookupResult = (Get-LMDevice -Name $Name).Id if (Test-LookupResult -Result $LookupResult -LookupString $Name) { return } $Id = $LookupResult } #Build header and uri $ResourcePath = "/device/devices/$Id/devicelogsources" $CallerPSCmdlet = $PSCmdlet $Results = Invoke-LMPaginatedGet -BatchSize $BatchSize -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 $Response = Invoke-LMRestMethod -CallerPSCmdlet $CallerPSCmdlet -Uri $Uri -Method "GET" -Headers $Headers[0] -WebSession $Headers[1] if ($null -eq $Response) { return $null } 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." } } |