PrtgAPI

Author(s)

• lordmilko

Tags

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

Cmdlets

Disable-PrtgProgress Enable-PrtgProgress Get-SensorTarget Add-Device Add-Group New-DeviceParameters New-GroupParameters Backup-PrtgConfig Clear-PrtgCache Sync-PrtgConfigFile Restart-PrtgCore Restart-Probe Get-ObjectLog Add-Sensor Get-SensorFactorySource New-SensorParameters Get-SensorHistory Move-Object Set-ObjectPosition Test-ErrorStatus Start-SortPrtgObject Open-PrtgObject Start-AutoDiscovery Copy-Object New-SensorFactoryDefinition Add-NotificationTrigger Set-NotificationTrigger Edit-NotificationTriggerProperty Get-NotificationAction Get-PrtgStatus Get-NotificationTrigger Get-ModificationHistory New-NotificationTriggerParameters 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

Functions

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

Dependencies

This module has no dependencies.

Release Notes

Improvements
----------------

* Get-Sensor, Get-Device, Get-Group and Get-Probe can now filter for objects that contain *all* specified tags via -Tags parameter. Filtering for objects that contain *any* specified tag (previous -Tags behavior) can now be performed with new -Tag parameter
* NotificationAction objects now include enhanced properties detailing the specifics of each notification type they perform and the users these alerts are sent to

Bugfixes
----------

* Fixed a bug wherein progress did not complete when an exception is thrown by a multi operation cmdlet
* Resolved an issue wherein ErrorLimitMessage and WarningLimitMessage cannot be modified and LimitsEnabled cannot be set to true via SetObjectProperty / Set-ChannelProperty on PRTG 18.1.38+. Attempting to modify these properties when a limit value has not been set on the UpperErrorLimit, LowerErrorLimit, UpperWarningLimit or LowerWarningLimit of a channel will now generate an InvalidOperationException specifying the IDs of the sensors that require a limit
* Fixed a bug wherein PrtgUrl construction would crash when the search filters of a request have been explicitly set to null

Breaking Changes
--------------------

* -Tags parameter of Get-Sensor, Get-Device, Get-Group and Get-Probe now performs logical AND instead of logical OR. Previous -Tags behavior can be attained via new -Tag parameter

---

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.