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

-Fixed a bug wherein Edit-NotificationTriggerProperty could not set values to $null
-Fixed a bug wherein New-NotificationTriggerParameter did not process NotificationTrigger objects properly in the EditFrom parameter set
-Removed mandatory import of PrtgAPI in PowerShell Profile when GoPrtg is installed
-Removed Get-GoPrtg alias for Get-GoPrtgServer due to conflict with "GoPrtg" alias cmdlet resolution

---

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.