Public/Get-LMDeviceInstanceList.ps1
|
<# .SYNOPSIS Retrieves a list of instances for a LogicMonitor device. .DESCRIPTION The Get-LMDeviceInstanceList function retrieves all instances associated with a specific device in LogicMonitor. The device can be identified by either ID or name, and the results can be filtered. .PARAMETER Id The ID of the device to retrieve instances from. Required for Id parameter set. .PARAMETER Name The name of the device to retrieve instances from. Required for Name parameter set. .PARAMETER Filter A filter object to apply when retrieving instances. This parameter is optional. .PARAMETER BatchSize The number of results to return per request. Must be between 1 and 1000. Defaults to 1000. .PARAMETER CountOnly When set to true, returns only the total count of instances instead of the instance details. .EXAMPLE #Retrieve instances by device ID Get-LMDeviceInstanceList -Id 123 .EXAMPLE #Get instance count for a device Get-LMDeviceInstanceList -Name "Production-Server" -CountOnly $true .NOTES You must run Connect-LMAccount before running this command. .INPUTS None. You cannot pipe objects to this command. .OUTPUTS Returns device instance objects or a count if CountOnly is specified. #> Function Get-LMDeviceInstanceList { [CmdletBinding(DefaultParameterSetName = 'Id')] Param ( [Parameter(Mandatory, ParameterSetName = 'Id')] [Int]$Id, [Parameter(ParameterSetName = 'Name')] [String]$Name, [Object]$Filter, [ValidateRange(1, 1000)] [Int]$BatchSize = 1000, [Boolean]$CountOnly ) #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/instances" #Initalize vars $QueryParams = "" $Count = 0 $Done = $false $Results = @() #Loop through requests While (!$Done) { #Build query params $QueryParams = "?size=$BatchSize&offset=$Count&sort=-endDateTime" If ($Filter) { #List of allowed filter props $PropList = @() $ValidFilter = Format-LMFilter -Filter $Filter -PropList $PropList $QueryParams = "?filter=$ValidFilter&size=$BatchSize&offset=$Count&sort=-endDateTime" } 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] #If looking for count only just return total If ($CountOnly) { return $Response.Total } #Stop looping if single device, no need to continue If (![bool]$Response.psobject.Properties["total"]) { $Done = $true Return $Response } #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 } } } Catch [Exception] { $Proceed = Resolve-LMException -LMException $PSItem If (!$Proceed) { Return } } } Return $Results } Else { Write-Error "Please ensure you are logged in before running any commands, use Connect-LMAccount to login and try again." } } |