functions/object/Receive-PRTGObjectStatus.ps1

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
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 {}
}