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

* PrtgAPI can now generate dynamic sensor parameters for almost any sensor type, allowing almost all sensor types to be programatically created. Parameters for sensor types that require additional information before device interrogation (such as *Oracle Tablespace*) cannot be dynamically generated.
* Sensor Targets can now be retrieved for unsupported sensor types. Supports all sensor types excluding types that require additional information prior to device interrogation (such as *Oracle Tablespace*)
* Multiple object and channel properties can now be modified in a single request

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

* NewSensorParameters now include properties for common sensor parameters, including Name, Interval, Priority, etc
* Common sensor parameters that are not specified will not be included in the parameter set, allowing PRTG to instantiate these fields with their default values
* RawSensorParameters now have an indexer, allowing instances to be accessed like a Dictionary
* SensorType on RawSensorParameters can now be modified
* Implemented native support for creating new HTTP sensors via HttpSensorParameters
* Sensor history records returned by GetSensorHistory / Get-SensorHistory are now ordered from newest to oldest
* RawSensorParameeters now presents as a hybrid PSObject, allowing values to be modified and retrieved from real property names
* New-SensorParameters now have an -Empty parameter. Allows constructing a completely empty set of RawSensorParameters for allowing instantiation without constructing a hashtable
* Set-ObjectProperty / Set-ChannelProperty now support specifying object property names as parameters, allowing multiple properties to be modified in a single request
* Get-ObjectProperty now supports specifying multiple individual properties to retrieve
* Get-SensorHistory will now stream records from PRTG when an -EndDate is specified
* Implemented -Count parameter on Get-SensorHistory. Allows limiting the number of results returned within the specified timespan

New Cmdlets
---------------

* Get-SensorType: Retrieve sensor types supported by PRTG

Bugfixes
----------

* Fixed a bug wherein Get-ObjectLog would fail to retrieve records -Since AllTime against certain objects

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

* Switched meaning of start date and end date when used with GetSensorHistory / Get-SensorHistory for consistency with GetLogs / Get-ObjectLog. StartDate now refers to the point in time *closest to now*, whereas EndDate now refers to the point in time *furthest from now*

---

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.