Nagios API 使用与技术文档

一、安装指南

在开始使用 Nagios API 前，您需要确保已安装以下依赖项：

• diesel
• greenlet
• python-openssl

您可以使用 pip 或 easy_install 命令安装这些依赖项。

pip install diesel greenlet pyOpenSSL

二、项目使用说明

Nagios API 提供了一个简单的 REST-like 接口，让您能够更加轻松、直观地与 Nagios 进行交互。您可以在 Nagios 主机上运行此程序，并通过提供的命令行界面或自定义脚本使用这个 API。

通过命令行使用

运行以下命令启动 API 服务：

nagios-api -p 8080 -c /var/lib/nagios3/rw/nagios.cmd -s /var/cache/nagios3/status.dat -l /var/log/nagios3/nagios.log

您至少需要提供状态文件参数。如果未提供其他参数，则禁用相应功能，并对请求此功能的客户端返回错误。

使用 API

该服务器使用 JSON 格式进行通信。您可以通过 GET 或 POST 方法请求数据。以下是通过命令行进行操作的一些示例：

• 获取状态信息：

curl http://localhost:8080/status

• 发送 POST 请求安排维护时段：

curl -d '{"host": "web01", "duration": 600}' -H 'Content-Type: application/json' http://localhost:8080/schedule_downtime

返回的 JSON 对象遵循以下格式：

{"content": <object>, "result": <bool>}

其中 result 字段始终为 true 或 false，以便您快速判断命令是否成功执行。content 字段可以是任何有效的 JavaScript 对象。

三、项目API使用文档

以下是目前支持的一些 API 方法，按字母顺序排列：

acknowledge_problem

允许您对主机或服务上的给定问题进行确认。

请求参数：

• host：要操作的主机。
• service：可选，如果指定，则对此服务进行操作。
• comment：必需，解释为何确认此警告的消息。
• sticky：可选，默认为 TRUE。当为 TRUE 时，确认会保持到主机进入正常状态。如果为 FALSE，则任何状态变化都会清除确认。
• notify：可选，默认为 TRUE。是否发送通知，表示此问题已被确认。
• persistent：可选，默认为 FALSE。如果启用，注释将保留在主机或服务上，直到手动删除。
• expire：可选，如果设置，将在给定的时间戳（自 UNIX 纪元以来的秒数）使确认过期。
• author：可选，作者名称。

add_comment

为指定的主机和/或服务添加注释。

请求参数：

• host：要操作的主机。
• service：可选，如果指定，则对此服务进行操作。
• comment：必需，要添加到主机或服务的注释文本。
• persistent：可选，默认为 FALSE。如果启用，注释将保留在主机或服务上，直到手动删除。
• author：可选，作者名称。

其他方法

Nagios API 还提供了其他多种方法，如 cancel_downtime、disable_notifications、delete_comment、enable_notifications、log、status、restart_nagios、update_host、objects、remove_acknowledgement 和 schedule_check 等。每个方法都有相应的请求参数，可根据实际需求使用。

四、项目安装方式

如前所述，您可以通过命令行启动 Nagios API 服务。以下是基本的安装步骤：

1. 确保已安装所需的依赖项。
2. 下载或克隆 Nagios API 源代码。
3. 设置所需的配置参数。
4. 运行 nagios-api 命令启动服务。

确保正确设置状态文件、命令文件和其他必要参数，以便 API 能够正常运行。