functions/object/Receive-PRTGObjectStatus.ps1
|
Function Receive-PRTGObjectStatus { <# .Synopsis Receive-PRTGObjectStatus .DESCRIPTION Query the status of an object directly from PRTGserver and returns. Difference to Get-PRTGObject is, that "Get-PRTGObject" is working on a modfified sensortree variable in the memory and not on livedata from PRTGServer .NOTES Author: Andreas Bellstedt adopted from PSGallery Module "PSPRTG" Author: Sam-Martin Github: https://github.com/Sam-Martin/prtg-powershell .LINK https://github.com/AndiBellstedt/PoShPRTG .EXAMPLE PS C:\>Receive-PRTGObjectStatus -ObjectId 1 PS C:\>Receive-PRTGObjectStatus -ID 1 Query current status of object 1 live from PRTG server. (not using the value in the sensor tree) .EXAMPLE PS C:\>Receive-PRTGObjectStatus -ObjectId 1 -Server "https://prtg.corp.customer.com" -User "admin" -Pass "1111111" Query current status of object 1 live from PRTG server. (not using the value in the sensor tree) #> [CmdletBinding( DefaultParameterSetName = 'Default', SupportsShouldProcess = $false, ConfirmImpact = 'low' )] [OutputType([PSCustomObject])] Param( # ID of the object to pause/resume [Parameter(Mandatory = $true, ValueFromPipeline = $true, ValueFromPipelineByPropertyName = $true)] [Alias('ID')] [ValidateScript( { $_ -gt 0 })] [int[]] $ObjectID, # Url for PRTG Server [ValidateNotNullOrEmpty()] [ValidateScript( { if ($_.StartsWith("http")) { $true } else { $false } } )] [String] $Server = $script:PRTGServer, # User for PRTG Authentication [ValidateNotNullOrEmpty()] [String] $User = $script:PRTGUser, # Password or PassHash for PRTG Authentication [ValidateNotNullOrEmpty()] [String] $Pass = $script:PRTGPass ) Begin { $StatusMapping = @{ 1 = "Unknown" 2 = "Scanning" 3 = "Up" 4 = "Warning" 5 = "Down" 6 = "No Probe" 7 = "Paused by User" 8 = "Paused by Dependency" 9 = "Paused by Schedule" 10 = "Unusual" 11 = "Not Licensed" 12 = "Paused Until" } } Process { foreach ($ID in $ObjectId) { try { $statusID = (Receive-PRTGObjectProperty -ObjectId $ID -PropertyName 'status' -Server $Server -User $User -Pass $Pass -ErrorAction Stop -Verbose:$false) } catch { Write-Log -LogText "Unable to get object status from prtg. ($Server) Message:$($_.exception.message)" -LogType Error -LogScope $MyInvocation.MyCommand.Name -NoFileStatus -Error return } $hash = @{ 'objid' = $ID "status" = $StatusMapping[[int]$statusID] "status_raw" = $statusID } $result = New-Object -TypeName PSCustomObject -Property $hash $result } } end {} } |