Public/Get-LMUnmonitoredDevice.ps1
|
<# .SYNOPSIS Retrieves unmonitored devices from LogicMonitor. .DESCRIPTION The Get-LMUnmonitoredDevice function retrieves information about devices that are discovered but not currently being monitored in LogicMonitor. .PARAMETER Filter A filter object to apply when retrieving unmonitored devices. .PARAMETER BatchSize The number of results to return per request. Must be between 1 and 1000. Defaults to 1000. .EXAMPLE #Retrieve all unmonitored devices Get-LMUnmonitoredDevice .EXAMPLE #Retrieve unmonitored devices using a filter Get-LMUnmonitoredDevice -Filter $filterObject .NOTES You must run Connect-LMAccount before running this command. .INPUTS None. You cannot pipe objects to this command. .OUTPUTS Returns LogicMonitor.UnmonitoredDevice objects. #> function Get-LMUnmonitoredDevice { [CmdletBinding()] param ( [Object]$Filter, [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 = "/device/unmonitoreddevices" $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 (Add-ObjectTypeInfo -InputObject $Results -TypeName "LogicMonitor.UnmonitoredDevice" ) } else { Write-Error "Please ensure you are logged in before running any commands, use Connect-LMAccount to login and try again." } } |