Skip to content
An enhanced Ruby gem to communicate with Icinga2 API
Branch: master
Clone or download
Fetching latest commit…
Cannot retrieve the latest commit at this time.
Permalink
Type Name Latest commit message Commit time
Failed to load latest commit information.
doc
examples
lib
spec
.gitignore
.rspec
.rubocop.yml
.travis.yml
AUTHORS
CONTRIBUTING.md
Gemfile
LICENSE
README.md
Rakefile
config.reek
icinga2.gemspec

README.md

ruby-icinga2

An enhanced ruby gem to communicate with Icinga2 API

Gem Version

Build Status Gem Downloads total Downloads Dependency Status

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:

You can’t perform that action at this time.