PrtgAPI 使用教程

1. 项目介绍

PrtgAPI 是一个开源的 C#/PowerShell 库，用于管理和维护 PRTG Network Monitor。它通过一系列类型安全的方法和 cmdlet 抽象出与 PRTG 交互的复杂性，使得开发者能够为网络管理开发强大的应用程序。

2. 项目快速启动

安装

PrtgAPI 可以通过 NuGet 或 PowerShell Gallery 安装。

通过 NuGet 安装：

Install-Package PrtgAPI

通过 PowerShell Gallery 安装：

Install-Module -Name PrtgAPI

配置

创建 PrtgClient 实例以连接到 PRTG 服务器。

var client = new PrtgClient("prtg.mycoolsite.com", "username", "password");

或者，使用 PassHash 进行身份验证。

var client = new PrtgClient("prtg.mycoolsite.com", "username", "1234567890", AuthMode.PassHash);

使用

获取所有设备：

var devices = client.GetDevices();

获取特定状态的传感器：

var downSensors = client.GetSensors(Status.Down, Status.DownAcknowledged).Select(s => s.Name).ToList();

异步获取传感器：

var childSensors = await client.GetSensorsAsync(Property.ParentId, 2000);

3. 应用案例和最佳实践

生成报告

根据自定义查询生成报告：

// 示例代码：生成报告

监控监控

监控缺失的传感器或新域成员的设备：

// 示例代码：监控监控

创建和修改对象

创建和修改传感器、设备、组等：

// 示例代码：创建和修改对象

部署通知触发器

为特定客户端的传感器部署通知触发器：

// 示例代码：部署通知触发器

维护统一命名/警告/对象设置

跨环境维护标准命名、警告和对象设置：

// 示例代码：维护统一设置

外部系统暂停/恢复项目

从外部系统（如事件脚本和计划任务）暂停/恢复项目：

// 示例代码：暂停/恢复项目

批量操作

执行任何批量操作：

// 示例代码：批量操作

4. 典型生态项目

• PrtgXml：用于生成 EXE/Script Advanced 传感器所需的 XML 的工具。
• 其他相关项目和扩展，可以根据实际需要探索和使用。