MBCDN

Für Powershell und C# Siehe WIKI

Install-Package PrtgAPI -Source PSGallery
Import-Module PrtgAPI

# Verbindung mit Anmeldeinformationen
$username = "username"
$password = "password" | ConvertTo-SecureString -AsPlainText -Force
$credential = New-Object System.Management.Automation.PSCredential($username, $password)
Connect-PrtgServer -Server $server -Credential $credential -IgnoreSSL

# Verbindung mit PassHash herstellen
# Statt Passwort den Passhash als Passwort angeben und Parameter -PassHash anhängen
$username = "username"
$password = "passhash" | ConvertTo-SecureString -AsPlainText -Force
$credential = New-Object System.Management.Automation.PSCredential($username, $password)
Connect-PrtgServer -Server $server -Credential $credential -PassHash -IgnoreSSL

# Verbindung trennen
Disconnect-PrtgServer

# Sensoren suchen
Get-Sensor "Commvault Backup Status *" | select-object * 

# Devices suchen
Get-Device | select-object * | where-object { $_.Name -like "*sql04*" }

# Sensor erstellen
$raw = @{
    name_ = "my test sensor"
    tags_ = "xmlexesensor"
    priority_ = 4
    exefile_ = "MyCustomSensorScript.ps1"
    exeparams_ = "-ClientName `"vie-t-srv-audit`" -DBName `"testdb`" -DeltaTime 86400"
    environment_ = 1
    usewindowsauthentication_ = 1
    mutexname_ = "testMutex"
    timeout_ = 70
    writeresult_ = 1
    intervalgroup = 0
    interval_ = "21600"
    errorintervalsdown_ = 2
    sensortype = "exexml"
}
 
$params = New-SensorParameters $raw
 
Get-Device "devicename" | Add-Sensor $params

Ein Custom Script Sensor kann XML oder JSON ausgeben. Die äußersten Tags (prtg) markieren das Gesamtergebnis. Die einzelnen „result“ Einträge sind „Channels“ in PRTG. Jede5rf Channel hat seine eigenen Einstellungen. Im PRTG Bereich kann man noch allgemeine Informationen in Tags angeben. Mehr zu Tags weiter unten.

XML und JSON Beispiel mit Powershell

$ProcessCount = (Get-Process).Count
$UserCount = (query user | Measure-Object).Count - 1
$tasks = (tasklist | Measure-object).Count
 
$XMLResult = @"
<prtg>
   <result>
       <channel>Task Count</channel>
       <value>$($tasks)</value>
       <unit>Custom</unit>
       <customUnit>Tasks</customUnit>
   </result>
   <result>
       <channel>Process Count</channel>
       <unit>Custom</unit>
       <customunit>Processes</customunit>
       <mode>Absolute</mode>
       <showChart>1</showChart>
       <showTable>1</showTable>
       <warning>0</warning>
       <float>1</float>
       <value>$($ProcessCount)</value>
       <LimitMaxError>120</LimitMaxError>
       <LimitMaxWarning>80</LimitMaxWarning>
       <LimitWarningMsg>My custom note for warnings</LimitWarningMsg>
       <LimitErrorMsg>My custom note for errors</LimitErrorMsg>
       <LimitMode>1</LimitMode>
   </result>
   <result>
       <channel>User Sessions</channel>
       <unit>Custom</unit>
       <CustomUnit>User</CustomUnit>
       <mode>Absolute</mode>
       <showChart>1</showChart>
       <showTable>1</showTable>
       <warning>0</warning>
       <float>0</float>
       <value>$($UserCount)</value>
   </result>
   <text>Demo values. OS: $($env:OS)</text>
</prtg>
"@
 
$JsonResult = @"
{
    "prtg": {
 
        "result": [
            {
                "channel": "Task Count",
                "value": "$($tasks)",
				"unit": "custom",
				"customunit": "Tasks"
            },
            {
                "channel": "Process Count",
                "unit": "cusom",
				"customunit": "Processes",
                "mode": "Absolute",
                "showChart": "1",
                "showTable": "1",
                "warning": "0",
                "float": "1",
                "value": "$($ProcessCount)",
                "LimitMaxError": "120",
                "LimitMaxWarning": "80",
                "LimitWarningMsg": "My custom note for warnings",
                "LimitErrorMsg": "My custom note for errors",
                "LimitMode": "1"
            },
            {
                "channel": "User Sessions",
                "unit": "Custom",
                "customunit": "User",
                "mode": "Absolute",
                "showChart": "1",
                "showTable": "1",
                "warning": "0",
                "float": "0",
                "value": "$($UserCount)"
            }
        ],
 
    "text": "Demo values. OS: $($env:OS)"
 
    }
}
"@
 
$JsonResult

Tags im Result Bereich

• Custom Sensors