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 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 Cmdlets
---------------

* Get-DeviceTemplate: Retrieves all device templates supported for use in an auto-discovery

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

* Device templates can now be specified to NewDeviceParameters. Specifying one or more templates will automatically set the AutoDiscoveryMode to AutomaticTemplate
* Manual auto-discoveries performed by Start-AutoDiscovery can now specify one or more device templates to limit the scope to the discovery
* Implemented new property Is64Bit on ServerStatus returned by Get-PrtgStatus
* CustomParameter objects can now specify a ParameterType to indicate whether their values should be treated a single values (name=val), multi values (name=val1,val2) or multi parameters (name=val1&name=val2)
* Custom parameters used by RawSensorParameters / DynamicSensorParameters now use ParameterType.MultiParameter by default
* Added new parameter -Template to Add-Device. When used in conjunction with -AutoDiscover, retrieves all device templates that match one or more specified wildcards
* Implemented new parameter -Downtime on Get-SensorHistory. When -Average is not specified, sets the average based on the scanning interval of the sensor, allowing the Downtime column to be included in response. For more information see the wiki
* Implemented new parameter -ProbeStatus on Get-Probe. Allows filtering for probes with a specified ProbeStatus
* Set-ObjectProperty now allows specifying multiple raw values at once for use with a single raw property

Bugfixes
---------

* Results returned by Get-SensorType no longer include duplicate types returned by PRTG
* Raw settings that allow for multiple selections (such as *Traffic Mode* of *SNMP Traffic* sensors) returned by Get-ObjectProperty -Raw now display correctly
* Fixed a bug wherein Get-SensorHistory would not stream properly when an -EndDate is specified
* Fixed an issue wherein several cmdlets would perform their actions before displaying initial progress
* Fixed an issue wherein sensor target resolution would crash when PRTG did not include an error message in its error response (such as when its Host value has changed)

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

* Renamed Probe property Condition to ProbeStatus

---

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.