NagiosHarder 技术文档

1. 安装指南

要使用 NagiosHarder，首先需要通过 Ruby 的 gem 命令进行安装：

gem install nagiosharder

确保您的系统已经安装了 Ruby，并且可以正常使用 gem 包管理器。

2. 项目使用说明

NagiosHarder 提供了一个 Ruby 接口和一个命令行界面，允许你查询和命令一个 Nagios 安装。以下是一些基本的使用示例：

require 'nagiosharder'

cgi         = 'https://path/to/nagios/cgi/directory'
user        = '用户名'
pass        = '密码'
version     = 3
time_format = 'iso8601'
verify_ssl  = true

site = NagiosHarder::Site.new(cgi, user, pass, version, time_format, verify_ssl)

配置好站点信息后，你可以获取主机和服务的状态信息，安排检查和停机时间，以及管理通知和故障确认等。

3. 项目API使用文档

以下是 NagiosHarder 部分 API 的使用方法：

• 获取主机状态信息：

puts site.host_status('主机名')

• 获取所有服务状态：

site.service_status

• 获取有问题的服务：

site.service_status(
  :service_status_types => [
    :critical,
    :warning,
    :unknown
  ]
)

• 获取已静音的服务，按持续时间降序排序：

site.service_status(
  :service_props => [
    :notifications_disabled,
  ],
  :sort_type    => :descending,
  :sort_option  => :state_duration,
)

• 获取特定服务组的状态信息：

site.service_status(:group => "服务组名称")

• 获取主机或服务的检查排程：

site.schedule_host_check('主机名')
site.schedule_service_check('主机名', '服务名')

• 安排主机或服务的停机时间：

site.schedule_host_downtime('主机名', :开始时间 => Time.now, :结束时间 => Time.now + 20.minutes)
site.schedule_service_downtime('主机名', '服务名', :开始时间 => Time.now, :结束时间 => Time.now + 20.minutes)

• 取消预定的停机时间：

site.cancel_downtime('停机时间ID')

• 对服务或主机的故障进行确认或取消确认：

site.acknowledge_service('主机名', '服务名', '故障描述')
site.unacknowledge_service('主机名', '服务名')
site.acknowledge_host('主机名', '故障描述')
site.unacknowledge_host('主机名')

• 禁用或启用服务的通知：

site.disable_service_notifications('主机名', '服务名')
site.enable_service_notifications('主机名', '服务名')

• 获取主机或服务组的摘要信息：

site.hostgroups_summary
site.servicegroups_summary

• 获取主机或服务组的详细信息：

site.hostgroups_detail
site.servicegroups_detail

• 获取警报历史记录：

site.alert_history

4. 项目安装方式

NagiosHarder 的安装方式如上所述，通过 Ruby 的 gem 命令进行安装：

gem install nagiosharder

请确保您有一个合适的 Ruby 环境，并可以正常运行 gem 命令。安装后，您可以通过 require 'nagiosharder' 在 Ruby 脚本中引入该库，然后使用提供的 API 进行操作。