PrtgAPI 0.7.2

C#/PowerShell interface for PRTG Network Monitor

There is a newer version of this package available.
See the version list below for details.
Install-Package PrtgAPI -Version 0.7.2
dotnet add package PrtgAPI --version 0.7.2
<PackageReference Include="PrtgAPI" Version="0.7.2" />
For projects that support PackageReference, copy this XML node into the project file to reference the package.
paket add PrtgAPI --version 0.7.2
The NuGet Team does not provide support for this client. Please contact its maintainers for support.

Release Notes

New Features
-Sensors can now be created from scratch. For sensor types supported by PrtgAPI, a sensor parameters type can be used to specify all the settings that will be used for the sensor, with PrtgAPI validating that all required fields have values. For sensor types currently unsupported by PrtgAPI, facilities are provided for constructing a set of custom parameters, optionally including full levels of type safety
-PRTG event logs can now be retrieved from any object. If no object is specified, PrtgAPI automatically retrieves logs for today from the root node. Logs can be retrieved from a specific time frame, with a specific status, and can also be limited so that only a certain number of logs are retrieved

New Methods
-C#: AddSensors: Create a new sensor from a set of sensor parameters
-C#: GetLogs: Retrieve event logs for a PRTG object
-C#: GetStatus: retrieve the status, configuration and version info of a PRTG Server

New Cmdlets
-Add-Sensor: create a new sensor from a set of sensor parameters
-New-SensorParameters: create a new set of sensor parameters of a specified type
-Get-SensorFactorySource: retrieve the source sensors or channels of a Sensor Factory sensor
-Get-ObjectLog: retrieve event logs for a PRTG object (or if no object is specified, for the whole server)
-Get-PrtgStatus: retrieve the status, configuration and version info of a PRTG Server

Improvements
-PS: Move-Object, Set-ObjectPosition, Simulate-ErrorStatus, Sort-PrtgObject and Start-AutoDiscovery now support -WhatIf
-PS: Clone-Sensor, Clone-Group and Clone-Device now only make 4 retries when the new object can't be resolved instead of 5
-PS: Implemented Get-ObjectSetting alias for Get-ObjectProperty
-PS: Cmdlets that perform streaming now only calculate the total number of objects needed to retrieve once instead of twice
-ExeName of EXE/XML sensors can now be retrieved and modified
-InheritTriggers property of objects can now be modified
-If PrtgAPI detects more than 20,000 objects will need to be streamed, PrtgAPI will instead stream objects "serially" (500 items at a time)
-If PrtgAPI fails to deserialize an enum value due to it posessessing a value unknown to PrtgAPI, an exception will now be thrown describing the value that was missing

Bugfixes
-C#: Fixed a bug in GetObjectTotals wherein totals for probe objects would not be properly calculated
-C#: Fixed a bug wherein AddNotificationTriggersAsync and SetNotificationTriggersAsync were validating arguments with a synchronous method instead of an async one
-PS: Edit-NotificationTriggerProperty now throws an an exception when the specified property does not exist on the target trigger parameter type
-PS: Fixed an issue wherein New-SearchFilter would not work when specifying enum properties whose values require serialization
-SetObjectProperty now properly validates values for numeric types
-Fixed a bug wherein PrtgUrl construction would crash when an array of zero SearchFilter objects is specified
-Fixed a bug wherein NotificationTypes property of sensors, devices, groups and probes did not properly report when sensors aren't inherited
-Fixed a bug wherein PrtgAPI would crash attempting to parse a webpage containing an empty dropdown list
-Fixed an issue wherein progress would fail when performing variable progress on a chain containing Action -> Action or Action -> Object -> Action
-Fixed incorrect XmlEnum values for Access.None and Access.Inherited types

Breaking Changes
-C#: Renamed SensorParameters.StatusFilter to SensorParameters.Status
-PS: Renamed New-NotificationTriggerParameter to New-NotificationTriggerParameters
-Renamed NotificationTypes.TriggerInheritance to NotificationTypes.InheritTriggers
-SearchFilter objects now prevent specifying null as a value. If you wish to specify no value, specify an empty string
-Moved Comments property from base type ObjectTable to more derived type SensorOrDeviceOrGroupOrProbe
-Moved property Status from SensorOrDeviceOrGroupOrProbeOrMessageOrTicket to more derived type SensorOrDeviceOrGroupOrProbe

---

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.

Operations supported by PrtgAPI include enumerating channels, sensors, devices, groups and probes, modifying channel and sensor properties, creating and editing notification triggers, pausing, unpausing and acknowledging objects, renaming and removing items, and more.

PrtgAPI includes full XML Documentation and supports synchronous, asynchronous and "streaming" request modes.

This module can be installed in both Visual Studio and PowerShell via the Install-Package cmdlet. For PowerShell users without the nuget.org package source, this module is also available on the PowerShell Gallery.

For more information and usage examples, please see the Project Site.

Dependencies

This package has no dependencies.

NuGet packages

This package is not used by any NuGet packages.

GitHub repositories

This package is not used by any popular GitHub repositories.

Version History

Version Downloads Last updated
0.9.13 155 5/7/2020
0.9.12 441 2/13/2020
0.9.11 319 12/9/2019
0.9.10 116 12/5/2019
0.9.9 245 9/26/2019
0.9.8 290 8/19/2019
0.9.7 655 5/8/2019
0.9.6 229 4/3/2019
0.9.5 405 1/13/2019
0.9.4 368 1/3/2019
0.9.3 233 11/20/2018
0.9.2 224 11/1/2018
0.9.1 273 10/3/2018
0.9.0 266 8/27/2018
0.8.6 433 5/4/2018
0.8.5 432 4/23/2018
0.8.4 294 4/23/2018
0.8.3 394 4/2/2018
0.8.2 357 3/30/2018
0.8.1 399 3/11/2018
0.8.0 505 2/23/2018
0.7.3 585 11/20/2017
0.7.2 843 11/13/2017
0.7.1 732 10/15/2017
0.7.0 662 10/6/2017
0.6.10 413 8/2/2017
0.6.9 366 4/24/2017
0.6.8 356 4/19/2017
0.6.7 395 4/11/2017
0.6.6 352 4/10/2017
0.6.5 349 4/10/2017
0.6.4 345 3/25/2017
0.6.3 398 3/22/2017
0.6.2 357 3/19/2017
0.6.1 712 3/8/2017
Show less