PrtgAPI

Author(s)

• lordmilko

Tags

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

Cmdlets

Get-DeviceTemplate Disable-PrtgProgress Enable-PrtgProgress Get-SensorType 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 Get-PrtgSchedule 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

New Features
---------------
* Implemented support for specifying a hashtable of -RawParameters to Set-ObjectProperty

New Cmdlets
---------------
* Get-PrtgSchedule: Retrieve all monitoring schedules supported by PRTG

Improvements
----------------
* Implemented support for retrieving Proxy Settings for HTTP Sensors, *Scanning Intervals and Schedules, Dependencies and Maintenance Window settings from devices, groups and probes
* New-SearchFilter now accepts a -Value of type object rather than string
* Implemented support for opening notification actions and schedules via Open-PrtgObject
* Removed unnecessary call to PrtgClient.GetGroups in Get-Sensor when specifying -Resolve:$false

Bugfixes
----------

* Fixed an issue wherein NotificationAction objects returned as part of a NotificationTrigger did not lazily deserialize all of their properties
* Probe parameters now prevent filtering by a ParentId other than 0
* PrtgAPI now correctly serializes DateTime and TimeSpan objects specified in search filters
* A more descriptive error message is now thrown when attempting to filter by a Status of 0
* Fixed several instances of cmdlets not properly unwrapping PSObject values
* Fixed a bug wherein Channel parameter of Set-ChannelProperty was not mandatory on Default and Dynamic parameter sets
* PrtgAPI now consistently displays all results when performing queries like Get-Sensor ping -Count 1. For more information, see the release notes for this version on GitHub

---

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.