PrtgAPI

Author(s)

• lordmilko

Tags

Prtg Sensor Device Group Probe Channel Notification Action Trigger Remove Pause Resume Check Acknowledge PowerShell Setting Property

Cmdlets

Copy-Device Copy-Sensor Copy-Group Add-NotificationTrigger Set-NotificationTrigger Edit-NotificationTriggerProperty Get-NotificationAction Get-NotificationTriggerTypes Get-NotificationTrigger New-NotificationTriggerParameter Remove-NotificationTrigger Set-ObjectProperty Confirm-Sensor Get-Channel Get-Group Get-Probe Get-ObjectProperty Get-PrtgClient Get-SensorTotals Update-Object Suspend-Object Rename-Object Resume-Object Set-ChannelProperty Remove-Object Get-Device Connect-PrtgServer Disconnect-PrtgServer Get-Sensor New-SearchFilter Move-Object Set-ObjectPosition Start-SortPrtgObject Start-AutoDiscovery

Functions

New-Credential Get-GoPrtgServer Connect-GoPrtgServer Set-GoPrtgAlias Install-GoPrtgServer Uninstall-GoPrtgServer

Dependencies

This module has no dependencies.

Release Notes

-Implemented Clone-Device, Clone-Sensor, Clone-Group cmdlets
-Implemented Move-Object, Set-ObjectPosition, Sort-PrtgObject, Start-AutoDiscovery cmdlets
-Implemented parameter sets for Get-Channel cmdlet, added Id filter parameter
-Implemented PrtgAPI conceptual help. Get-Help about_PrtgAPI
-Fixed a bug in Acknowledge-Sensor and Pause-Object wherein acknowledging or pausing for less than 1 minute would acknowledge/pause indefinitely
-Replaced GoPrtg alias system with GoPrtg server system
-Replaced Install-GoPrtgAlias/Uninstall-GoPrtgAlias with Install-GoPrtgServer, Uninstall-GoPrtgServer
-Implemented Get-GoPrtgServer, Set-GoPrtgAlias, Connect-GoPrtgServer
-Refactored internal request engine into separate class
-Renamed PrtgClient.CheckNow to PrtgClient.RefreshObject
-Implemented AcknowledgeSensorAsync, SimulateErrorAsync, RefreshObjectAsync, AutoDiscoverAsync, SetObjectPropertyAsync, SortAlphabetically PrtgClient methods
-Implemented PrtgClient.SetPosition overload; accepts an absolute position instead of a move direction
-Refactored several request parameters into separate classes

---

PrtgAPI is a C#/PowerShell library that abstracts away the complexity of interfacing with the PRTG HTTP API.

PrtgAPI implements a collection of methods and enumerations that help create and execute the varying HTTP GET requests required to interface with PRTG. All responses from PRTG are automatically deserialized by PrtgAPI and formatted appropriately when output to the pipeline (when using PowerShell)

All cmdlets in PrtgAPI support some level of piping, allowing you to directly chain multiple cmdlets together, further filtering search results as you go.

PrtgAPI supports a number of undocumented features, including manipulating notification triggers, and viewing and editing channel properties (error limits, etc).

PrtgAPI includes full Cmdlet Comment/XmlDoc documentation. Detailed information on any cmdlet can be found within PowerShell by running Get-Help <cmdlet> or Get-Help <cmdlet> -Full

For examples and usage scenarios, please see the Project Site.