icinga2 0.5.2

data/README.md

@@ -0,0 +1,118 @@
+# ruby-icinga2
+
+Small Ruby Class for the Icinga2 API
+
+
+## Requirements
+
+    gem install rest-client --no-rdoc --no-ri
+    gem install json --no-rdoc --no-ri
+
+## usage
+
+create an instance and get information about the Icinga2 Server
+
+    config = {
+      :icinga => {
+        :host      => icingaHost,
+        :api       => {
+          :port => icingaApiPort,
+          :user => icingaApiUser,
+          :pass => icingaApiPass
+        },
+        :cluster   => icingaCluster,
+        :satellite => icingaSatellite,
+      }
+    }
+
+    i = Icinga::Client.new( config )
+    puts i.applicationData()
+
+## Status
+
+supports the following API Calls:
+
+  - [Users](doc/users.md)
+    * addUser
+    * deleteUser
+    * listUsers
+    * existsUser
+  - [Usergroups](doc/usergroups.md)
+    * addUsergroup
+    * deleteUsergroup
+    * listUsergroups
+    * existsUsergroup
+  - [Hosts](doc/hosts.md)
+    * addHost
+    * deleteHost
+    * listHosts
+    * existsHost
+  - [Hostgroups](doc/hostgroups.md)
+    * addHostgroup
+    * deleteHostgroup
+    * listHostgroups
+    * existsHostgroup
+  - [Services](doc/services.md)
+    * addService
+    * deleteService
+    * listServices
+    * existsService
+  - [Servicegroups](doc/servicegroups.md)
+    * addServicegroup
+    * deleteServicegroup
+    * listServicegroups
+    * existsServicegroup
+  - [Downtimes](doc/downtimes.md)
+    * addDowntime
+    * listDowntimes
+  - [Notifications](doc/notifications.md)
+    * enableHostNotification
+    * disableHostNotification
+    * enableServiceNotification
+    * disableServiceNotification
+    * enableHostgroupNotification
+    * disableHostgroupNotification
+    * listNotifications
+
+
+## create a own gem File
+
+    #$ gem build icinga2.gemspec
+    Successfully built RubyGem
+    Name: icinga2
+    Version: 1.4.9
+    File: icinga2-1.4.9.gem
+
+## install gem
+
+    #$ gem install ./icinga2-1.4.9.gem
+    Successfully installed icinga2-1.4.9
+    1 gem installed
+
+## test via CLI
+
+    #$ export ICINGA_HOST=localhost ; export ICINGA_API_USER=root ; export ICINGA_API_PASSWORD=icinga
+    #$ irb
+    2.3.0 :001 > require 'icinga2'
+     => true
+    2.3.0 :002 > config = { :icinga => { :host => 'localhost', :api => { :user => 'root', :pass => 'icinga' } } }
+     => {:icinga=>{:host=>"localhost", :api=>{:user=>"root", :pass=>"icinga"}}}
+    2.3.0 :003 > i = Icinga2::Client.new( config )
+
+## test via example
+    #$ export ICINGA_HOST=localhost ; export ICINGA_API_USER=root ; export ICINGA_API_PASSWORD=icinga
+    #$ ruby examples/test.rb
+
+
+
+## Contributing
+
+1. Fork it
+2. Create your feature branch (`git checkout -b my-new-feature`)
+3. Commit your changes (`git commit -am 'Add some feature'`)
+4. Push to the branch (`git push origin my-new-feature`)
+5. Create new Pull Request
+
+
+
+

data/doc/downtimes.md

@@ -0,0 +1,7 @@
+# Icinga2 - Downtimes
+
+## add
+    addDowntime()
+
+# list
+    listDowntimes()

data/doc/examples

@@ -0,0 +1,122 @@
+
+To add hostgroup :
+
+curl -k -s -u icingaadmin:icinga 'https://localhost:5665/v1/objects/hostgroups/testgrp' \
+    -X PUT -d '{ "attrs": { "name" : "testgrp" ,"display_name" : "testgrp" , "state_loaded" :true }}'
+
+To add host :
+
+curl -k -s -u icingaadmin:icinga 'https://localhost:5665/v1/objects/hosts/8.8.8.8' \
+    -X PUT -d '{ "templates": [ "generic-host" ], "attrs": { "address": "8.8.8.8" , "groups" : [ "testgrp" ]} }'
+
+
+https://localhost:5665/v1/objects/users
+https://localhost:5665/v1/objects/usergroups
+
+
+https://localhost:5665/v1/objects/hostgroups
+https://localhost:5665/v1/objects/servicegroups
+
+https://localhost:5665/v1/objects/hosts
+https://localhost:5665/v1/objects/services
+
+# list service from host
+curl -k -u root:icinga -H 'Accept: application/json' -X GET  'https://localhost:5665/v1/objects/services/pandora-17-01!Runlevel-master-live-server'
+
+
+https://localhost:5665/v1/objects/notifications
+
+# get usergroups:
+curl -k -s -u root:icinga -H 'Accept: application/json' -X GET 'https://localhost:5665/v1/objects/usergroups'
+
+# add usergroup:
+curl -k -s -u root:icinga -H 'Accept: application/json' -X PUT 'https://localhost:5665/v1/objects/usergroups/foo' --data '{ "attrs": {"display_name": "Foo Bar" } }'
+
+# delete usergroup:
+curl -k -s -u root:icinga -H 'Accept: application/json' -H 'X-HTTP-Method-Override: DELETE' -X POST 'https://localhost:5665/v1/objects/usergroups/foo'
+
+
+# delete user:
+curl -k -s -u root:icinga -H 'Accept: application/json' -H 'X-HTTP-Method-Override: DELETE' -X POST 'https://localhost:5665/v1/objects/users/foo'
+
+# add user:
+curl -k -s -u root:icinga -H 'Accept: application/json' -X PUT 'https://localhost:5665/v1/objects/users/foo' --data '{ "attrs": {"display_name": "Foo Bar", "email": "foo.bar@coremedia.com","enable_notifications": false, "groups": [ "coreme
+dia" ] } }'
+
+
+
+# add notification
+curl -k -s -u root:icinga -H 'Accept: application/json' \
+  -X PUT 'https://localhost:5665/v1/objects/notifications/debian7.example.com!jabber' -d '{
+ "attrs": {
+ "command":"mail-service-notification",
+ "service_name":"apt",
+ "user_groups": ["icingaadmins"] } }'
+
+
+# delete notification
+curl -k -s -u root:icinga -H 'Accept: application/json' \
+  -H 'X-HTTP-Method-Override: DELETE' \
+  -X POST 'https://localhost:5665/v1/objects/notifications/debian7.example.com!apt!jabber?cascade=1'
+
+
+
+
+
+# enable notification für host:
+curl -k -s -u root:icinga -H 'Accept: application/json' -X POST 'https://localhost:5665/v1/objects/hosts/api_dummy_host_1' --data '{ "attrs": { "enable_notifications": true } }'
+
+# disable notification für host:
+curl -k -s -u root:icinga -H 'Accept: application/json' -X POST 'https://localhost:5665/v1/objects/hosts/api_dummy_host_1' --data '{ "attrs": { "enable_notifications": false } }'
+
+# enable notification für service x von host:
+curl -k -s -u root:icinga -H 'Accept: application/json' -X POST 'https://localhost:5665/v1/objects/services' --data '{ "filter": "host.name==\"api_dummy_host_1\"", "attrs": { "enable_notifications": true } }'
+
+# disable notification für service x von host:
+curl -k -s -u root:icinga -H 'Accept: application/json' -X POST 'https://localhost:5665/v1/objects/services' --data '{ "filter": "host.name==\"api_dummy_host_1\"", "attrs": { "enable_notifications": false } }'
+
+# enable notification für hostgroup:
+curl -k -s -u root:icinga -H 'Accept: application/json' -X POST 'https://localhost:5665/v1/objects/services' --data '{ "filter": "\"api_dummy_hostgroup\" in host.groups", "attrs": { "enable_notifications": true } }'
+
+# disable notification für hostgroup:
+curl -k -s -u root:icinga -H 'Accept: application/json' -X POST 'https://localhost:5665/v1/objects/services' --data '{ "filter": "\"api_dummy_hostgroup\" in host.groups", "attrs": { "enable_notifications": false } }'
+
+
+# get downtimes
+curl -k -s -u root:icinga -H 'Accept: application/json' -X GET 'https://localhost:5665/v1/objects/downtimes'
+
+# delete named downtime
+curl -k -s -u root:icinga -H 'Accept: application/json' -H 'X-HTTP-Method-Override: DELETE' -X POST 'https://localhost:5665/v1/objects/downtimes/icinga2-master!load!icinga2-master-1496045418-0'
+
+
+# schedule downtime for a host
+
+# current_time=$(date +%s)
+# 1449057010
+# current_time_add_30_second=$(date +%s --date="+30 seconds")
+# 1449057040
+curl -k -s -u root:icinga -H 'Accept: application/json' -X POST 'https://localhost:5665/v1/actions/schedule-downtime' \
+  --data '{ "type": "Host", "filter": "host.name==\"api_dummy_host_1\"", "start_time": 1449057685, "end_time": 1449057715, "author": "api_user", "comment": "api_comment", "fixed": true, "duration": 30 }'
+
+# schedule downtime for all services of a host - change the timestamps accordingly
+curl -k -s -u root:icinga -H 'Accept: application/json' -X POST 'https://localhost:5665/v1/actions/schedule-downtime' \
+  --data '{ "type": "Service", "filter": "host.name==\"api_dummy_host_1\"", "start_time": 1449064981, "end_time": 1449065129, "author": "api_user", "comment": "api_comment", "fixed": true, "duration": 30 }'
+
+
+# schedule downtime for all hosts and services in a hostgroup - change the timestamps accordingly
+curl -k -s -u root:icinga -H 'Accept: application/json' -X POST 'https://localhost:5665/v1/actions/schedule-downtime' \
+  --data '{ "type": "Host", "filter": "\"api_dummy_hostgroup\" in host.groups", "start_time": 1449065680, "end_time": 1449065823, "author": "api_user", "comment": "api_comment", "duration": 120, "fixed": true, "duration": 30 }'
+
+curl -k -s -u root:icinga -H 'Accept: application/json' -X POST 'https://localhost:5665/v1/actions/schedule-downtime' \
+  --data '{ "type": "Service", "filter": "\"api_dummy_hostgroup\" in host.groups)", "start_time": 1449065680, "end_time": 1449065823, "author": "api_user", "comment": "api_comment", "duration": 120, "fixed": true, "duration": 30 }'
+
+
+
+
+
+
+
+
+
+
+

data/doc/hostgroups.md

@@ -0,0 +1,19 @@
+# Icinga2 - Hostgroups
+
+## check
+    existsHostgroup()
+
+## add
+    addHostgroup()
+
+## list
+
+### named
+    listHostgroups()
+
+### all
+    listHostgroups()
+
+## delete
+    deleteHostgroup()
+

data/doc/hosts.md

@@ -0,0 +1,22 @@
+# Icinga2 - Hosts
+
+## check
+    existsHost()
+
+## add
+    vars = {
+      'aws' => false
+    }
+
+    addHost( 'foo-bar.lan', vars )
+
+## list
+
+### named
+    listHosts( 'foo-bar.lan' )
+
+### all
+    listHosts()
+
+## delete
+    deleteHost( 'foo-bar.lan' )

data/doc/notifications.md

@@ -0,0 +1,15 @@
+# Icinga2 - Notifications
+
+    enableHostNotification()
+
+    disableHostNotification()
+
+    enableServiceNotification()
+
+    disableServiceNotification()
+
+    enableHostgroupNotification()
+
+    disableHostgroupNotification()
+
+    listNotifications()

data/doc/servicegroups.md

@@ -0,0 +1,19 @@
+# Icinga2 - Servicegroups
+
+## check
+    existsServicegroup()
+
+## add
+    addServicegroup()
+
+## list
+
+### named
+    listServicegroups()
+
+### all
+    listServicegroups()
+
+## delete
+    deleteServicegroup()
+

data/doc/services.md

@@ -0,0 +1,26 @@
+# Icinga2 - Services
+
+
+## check
+    existsService()
+
+## add
+    services = {
+      'service-heap-mem' => {
+        'display_name'  => 'Tomcat - Heap Memory',
+        'check_command' => 'tomcat-heap-memory',
+      }
+    }
+
+    i.addServices( 'foo-bar.lan', services )
+
+## list
+
+### named
+    listServices( 'foo-bar.lan' )
+
+### all
+    listServices()
+
+## delete
+**not yet implemented**

data/doc/usergroups.md

@@ -0,0 +1,12 @@
+# Icinga2 - Usergroups
+
+    existsUsergroup()
+
+    listUsergroups()
+
+    addUsergroup()
+
+    deleteUsergroup()
+
+
+

data/doc/users.md

@@ -0,0 +1,41 @@
+# Icinga2 - Users
+
+## check, if User exists
+
+    existsUser?( $USERNAME )
+
+return `true` or `false`
+
+## add User
+
+    var =  {
+      :name => 'foo',
+      :display_name => 'FOO',
+      :email => 'foo@bar.com',
+      :pager => '0000',
+      :groups => ['icingaadmins']
+    }
+
+    addUser( var )
+
+return `Hash`
+
+## list User
+
+### named User
+
+    listUsers( { :name => $USERNAME } )
+
+return `Hash`
+
+### all Users
+
+    listUsers()
+
+return `Hash`
+
+## delete User
+
+    deleteUser( { :name => $USERNAME } )
+
+return `Hash`

data/examples/test.rb

@@ -0,0 +1,150 @@
+#!/usr/bin/env ruby
+#
+# 23.01.2017 - Bodo Schulz
+#
+#
+# v0.9.2
+
+# -----------------------------------------------------------------------------
+
+require_relative '../lib/icinga2'
+
+# -----------------------------------------------------------------------------
+
+icingaHost         = ENV.fetch( 'ICINGA_HOST'             , 'icinga2' )
+icingaApiPort      = ENV.fetch( 'ICINGA_API_PORT'         , 5665 )
+icingaApiUser      = ENV.fetch( 'ICINGA_API_USER'         , 'admin' )
+icingaApiPass      = ENV.fetch( 'ICINGA_API_PASSWORD'     , nil )
+icingaCluster      = ENV.fetch( 'ICINGA_CLUSTER'          , false )
+icingaSatellite    = ENV.fetch( 'ICINGA_CLUSTER_SATELLITE', nil )
+
+# convert string to bool
+icingaCluster   = icingaCluster.to_s.eql?('true') ? true : false
+
+config = {
+  :icinga => {
+    :host     => icingaHost,
+    :api      => {
+      :port     => icingaApiPort,
+      :user     => icingaApiUser,
+      :password => icingaApiPass
+    },
+    :cluster   => icingaCluster,
+    :satellite => icingaSatellite,
+  }
+}
+
+# ---------------------------------------------------------------------------------------
+
+i = Icinga2::Client.new( config )
+
+if( i != nil )
+
+  # run tests ...
+  #
+  #
+
+  puts "Information about Icinga2:"
+  puts i.applicationData()
+  puts i.CIBData()
+  puts i.apiListener()
+  puts ""
+
+  puts "check if Host 'icinga2-master' exists:"
+  puts i.existsHost?( 'icinga2-master' ) ? 'true' : 'false'
+  puts "get host Objects from 'icinga2-master'"
+  puts i.hostObjects()
+  puts "Host problems:"
+  puts i.hostProblems()
+  puts "Problem Hosts:"
+  puts i.problemHosts()
+
+  puts "list named Hosts:"
+  puts i.listHosts( { :name => 'icinga2-master' } )
+  puts "list all Hosts:"
+  puts i.listHosts()
+  puts ""
+
+  puts "check if Hostgroup 'linux-servers' exists:"
+  puts i.existsHostgroup?( 'linux-servers' ) ? 'true' : 'false'
+  puts "add hostgroup 'foo'"
+  puts i.addHostgroup( { :name => 'foo', :display_name => 'FOO' } )
+  puts "list named Hostgroup 'foo'"
+  puts i.listHostgroups( { :name => 'foo' } )
+  puts "list all Hostgroups:"
+  puts i.listHostgroups()
+  puts "delete Hostgroup 'foo'"
+  puts i.deleteHostgroup( { :name => 'foo' } )
+  puts ""
+
+  puts "check if service 'users' on host 'icinga2-master' exists:"
+  puts i.existsService?( { :host => 'icinga2-master', :service => 'users' } )  ? 'true' : 'false'
+
+  puts "get service Objects"
+  puts i.serviceObjects()
+  puts "Service problems:"
+  puts i.serviceProblems()
+  puts "Problem Services:"
+  puts i.problemServices()
+
+  puts "list named Service 'ping4' from Host 'icinga2-master'"
+  puts i.listServices( { :host => 'icinga2-master', :service => 'ping4' } )
+  puts "list all Services:"
+  puts i.listServices()
+  puts ""
+
+  puts "check if Servicegroup 'disk' exists:"
+  puts i.existsServicegroup?( 'disk' ) ? 'true' : 'false'
+  puts "add Servicegroup 'foo'"
+  puts i.addServicegroup( { :name => 'foo', :display_name => 'FOO' } )
+  puts "list named Servicegroup 'foo'"
+  puts i.listServicegroups( { :name => 'foo' } )
+  puts "list all Servicegroup:"
+  puts i.listServicegroups()
+  puts "delete Servicegroup 'foo'"
+  puts i.deleteServicegroup( { :name => 'foo' } )
+  puts ""
+
+  puts "check if Usergroup 'icingaadmins' exists:"
+  puts i.existsUsergroup?( 'icingaadmins' ) ? 'true' : 'false'
+  puts "add Usergroup 'foo'"
+  puts i.addUsergroup( { :name => 'foo', :display_name => 'FOO' } )
+  puts "list named Usergroup 'foo'"
+  puts i.listUsergroups( { :name => 'foo' } )
+  puts "list all Usergroup:"
+  puts i.listUsergroups()
+  puts "delete Usergroup 'foo'"
+  puts i.deleteUsergroup( { :name => 'foo' } )
+  puts ""
+
+  puts "check if User 'icingaadmin' exists:"
+  puts i.existsUser?( 'icingaadmin' ) ? 'true' : 'false'
+  puts "add User 'foo'"
+  puts i.addUser( { :name => 'foo', :display_name => 'FOO', :email => 'foo@bar.com', :pager => '0000', :groups => ['icingaadmins'] } )
+  puts "list named User 'foo'"
+  puts i.listUsers( { :name => 'foo' } )
+  puts "list all User:"
+  puts i.listUsers()
+  puts "delete User 'foo'"
+  puts i.deleteUser( { :name => 'foo' } )
+  puts ""
+
+  puts "add Downtime 'test':"
+  puts i.addDowntime( { :name => 'test', :type => 'service', :host => 'icinga2-master', :comment => 'test downtime', :author => 'icingaadmin', :start_time => Time.now.to_i, :end_time => Time.now.to_i + 20 } )
+  puts "list all Downtimes:"
+  puts i.listDowntimes()
+
+  puts "list all Notifications:"
+  puts i.listNotifications()
+
+  puts i.enableHostNotification( 'icinga2-master' )
+  puts i.disableHostNotification( 'icinga2-master' )
+
+ puts i.disableServiceNotification( 'icinga2-master' )
+
+
+end
+
+# -----------------------------------------------------------------------------
+
+# EOF