bodsch / ruby-icinga2

An enhanced Ruby gem to communicate with Icinga2 API

ruby-icinga2

An enhanced ruby gem to communicate with Icinga2 API

Requirements

• ruby version => 2.0
• rest-client ~> 2.0
• json ~> 2.1
• openssl ~> 2.0 (only with ruby >= 2.3)
• ruby_dig (only with ruby < 2.3)

Install

gem install icinga2

Usage

create an instance

require 'icinga2'

config = {
  icinga: {
    host: icinga_host,
    api: {
      port: icinga_api_port,
      username: icinga_api_user,
      password: icinga_api_pass
    }
  }
}

@icinga = Icinga2::Client.new( config )

Use the examples

You can use the Icinga Vagrant-Box from the Icinga Team or my own Docker Container as Datasource.

Remember Change the exported Environment Variables to your choosed Datasource!

you can find many examples under the directory examples:

$ export ICINGA_HOST=localhost ; export ICINGA_API_USER=root ; export ICINGA_API_PASSWORD=icinga
$ ruby examples/informations.rb
$ ruby examples/statistics.rb
$ ruby examples/users.rb

and so on.

Test via CLI

$ irb
irb(main):001:0> require 'icinga2'
 => true
irb(main):002:0> config = { icinga: { host: 'localhost', api: { username: 'root', password: 'icinga' } } }
 => {:icinga=>{:host=>"localhost", :api=>{:username=>"root", :password=>"icinga"}}}
irb(main):003:0> i = Icinga2::Client.new( config )
irb(main):004:0> i.available?
=> true
irb(main):005:0>

Create a own gem file

$ gem build icinga2.gemspec
Successfully built RubyGem
Name: icinga2
Version: 0.9.2.7
File: icinga2-0.9.2.7.gem

Install local gem

$ gem install icinga2
Successfully installed icinga2-0.9.2.7
1 gem installed

Status

supports the following API Calls:

• Users

  • add user
  • delete user
  • list users
  • check if user exists

• Usergroups

  • add usergroup
  • delete usergroup
  • list usergroups
  • check if usergroup exists

• Hosts

  • add host
  • delete host
  • modify host
  • list hosts
  • check if host exists
  • list host objects
  • count of hosts with problems
  • list of hosts with problems
  • count of all hosts
  • count hosts with problems
  • calculate host severity (protected)

• Hostgroups

  • add hostgroup
  • delete hostgroup
  • list hostgroups
  • check if hostgroup exists

• Services

  • add service
  • delete service
  • list unhandled services
  • list services
  • check if service exists
  • list service objects
  • count services with problems
  • list of services with problems
  • count of all services
  • count all services with handled problems
  • calculate service severity (protected)

• Servicegroups

  • add servicegroup
  • delete servicegroup
  • list servicegroups
  • check if servicegroup exists

• Downtimes

  • add downtime
  • remove downtime
  • list downtimes

• Notifications

  • enable host notifications
  • disable host notifications
  • enable service notifications
  • disable service notifications
  • enable hostgroup notifications
  • disable hostgroup notifications
  • list all notifications
  • host notification (protected)
  • hostgroup notification (protected)
  • service notification (protected)

• Statistics

  • statistic data for latence and execution time
  • statistic data for interval data
  • statistic data for services
  • statistic data for hosts
  • queue statistics from the api

ruby-icinga2's Issues

support ssl certificates

support and test ssl-certificates

bug undefined method `each' for nil:NilClass

cm-icinga-client        | /usr/lib/ruby/gems/2.4.0/gems/icinga2-0.6.6.0/lib/icinga2/services.rb:233:in `problem_services': undefined method `each' for nil:NilClass (NoMethodError)
cm-icinga-client        |       from /usr/lib/ruby/gems/2.4.0/gems/icinga2-0.6.6.0/lib/icinga2/status.rb:202:in `extract_data'
cm-icinga-client        |       from /usr/lib/ruby/gems/2.4.0/gems/icinga2-0.6.6.0/lib/icinga2.rb:134:in `initialize'
cm-icinga-client        |       from /usr/local/lib/icinga.rb:56:in `initialize'
cm-icinga-client        |       from /usr/local/bin/icinga-client.rb:74:in `new'
cm-icinga-client        |       from /usr/local/bin/icinga-client.rb:74:in `<main>'

Zone setting in config

Hello,

Is there a way to set zone when connecting to multi-zone instance API?

config = {
  icinga: {
    host: "host",
    zone: "zone",
    api: {
      port: port,
      username: "username",
      password: "password"
    }
  }
}

better implemantation of eval()

bundler exec rake style:ruby

lib/icinga2/hosts.rb:97:15: C: The use of eval is a serious security risk.
          v = eval(attr)
              ^^^^
lib/icinga2/hosts.rb:105:16: C: The use of eval is a serious security risk.
           v = eval(attr)
               ^^^^
lib/icinga2/hosts.rb:116:16: C: The use of eval is a serious security risk.
           v = eval(attr)
               ^^^^
lib/icinga2/hosts.rb:121:13: C: The use of eval is a serious security risk.
        v = eval(attr)
            ^^^^

add modify_hosts

add function, to modify host vars and attributes

use ruby code style

Documentation create instance

add require, replace :pass and Icinga::Client.new

require 'icinga2'

config = {
  :icinga => {
    :host      => 'fornax.icinga-book.local',
    :api       => {
      :port => api_port,
      :user => api_user,
      :password => api_password
    }
  }
}

@icinga = Icinga2::Client.new( config )

API Calls for Service Object

• vars (Dictionary)
• action_url (String)
• check_command (String)
• check_interval (Number)
• check_period (String)
• check_timeout (Value)
• command_endpoint (String)
• enable_active_checks (Number)
• enable_event_handler (Number)
• enable_flapping (Number)
• enable_notifications (Number)
• enable_passive_checks (Number)
• enable_perfdata (Number)
• event_command (String)
• flapping_threshold (Number)
• flapping_threshold_high (Number)
• flapping_threshold_low (Number)
• icon_image (String)
• icon_image_alt (String)
• max_check_attempts (Number)
• notes (String)
• notes_url (String)
• retry_interval (Number)
• volatile (Number)
• display_name (String)
• host_name (String)

add add_service

add function to add a service

reduce requirements

for better support of older distributions (centos7,rhel7,etc) downgrady the requirements.
use ruby 2.2 insteed ob 2.3

for compatibily use https://github.com/Invoca/ruby_dig

API Calls for Servicegroup Object

• vars (Dictionary)
• action_url (String)
• display_name (String)
• notes (String)
• notes_url (String

implement reconnect to icinga2 service

this should be fix this problem: mocdaniel/dashing-icinga2#9

support configuration packages

https://www.icinga.com/docs/icinga2/latest/doc/12-icinga2-api/#configuration-management

fix: fix problems with wrong or old certificate

rewrite network class for a better handling of all requests

look at @dnsmichi 's code: https://github.com/Icinga/dashing-icinga2/blob/master/lib/icinga2.rb

API Calls for Hostgroup Object

• vars (Dictionary)
• action_url (String)
• display_name (String)
• notes (String)
• notes_url (String

API Calls for Host Object

• vars (Dictionary)
• action_url (String)
• check_command (String)
• check_interval (Number)
• check_period (String)
• check_timeout (Value)
• command_endpoint (String)
• enable_active_checks (Number)
• enable_event_handler (Number)
• enable_flapping (Number)
• enable_notifications (Number)
• enable_passive_checks (Number)
• enable_perfdata (Number)
• event_command (String)
• flapping_threshold (Number)
• flapping_threshold_high (Number)
• flapping_threshold_low (Number)
• icon_image (String)
• icon_image_alt (String)
• max_check_attempts (Number)
• notes (String)
• notes_url (String)
• retry_interval (Number)
• volatile (Number)
• address (String)
• address6 (String)
• display_name (String)

add modify_service

add function, to modify service

Direct match attributes in lib funs to icinga2 objects attributes

Hello,

I found that this lib doesn't have a direct match to icinga2 object attributes.

for example section in lib/icinga2/hosts.rb

      payload = {
        'templates' => [ 'generic-host' ],
        'attrs'     => {
          'address'              => fqdn,
          'display_name'         => display_name,
          'max_check_attempts'   => max_check_attempts.to_i,
          'check_interval'       => check_interval.to_i,
          'retry_interval'       => retry_interval.to_i,
          'enable_notifications' => notifications,
          'action_url'           => action_url,
          'notes'                => notes,
          'notes_url'            => notes_url
        }
      }

so I have to look at this library file and find that to set address attribute I have to define fqdn in add_host options. This is strange because i'm waiting that setting 'address' in options will set the same attribute in object. Agree?

What do you think if I'll send PR that will do direct match from funcs options to icinga2 object options?

more examples

we need more examples.
the folder examples are the home of this.

complete all api calls

to locate all api calls an implement they in the SDK
take a lock https://gist.github.com/bodsch/1b78bfa81512694ad63a23e8c2b15386