icinga2 0.5.2 → 0.6.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: de14f18250b64f14075bd07f86f69e72a075c39c
-  data.tar.gz: c76aa9d2f1231f46d97e249dc43e015efe853f90
+  metadata.gz: 0c01377a17aeaff33b892aa1ee1969eebba5a3a6
+  data.tar.gz: e11000a8b8dfbbbe64db0337580526b2872046e0
 SHA512:
-  metadata.gz: 3a17b15730f7113b11fd6d29a67b1f228ef27750b6c45ac03899ed15bf5487cb6de4bca2627826fd491879088de117180d3b6abca78798f6cd50af6325d03bd2
-  data.tar.gz: 4b944345390ceb5be902cf80cee0c54096fdc416afb3261239f65fb026202a9f029c46ea832bdc7120bdc8593242a8bbade7d2082366ba7556d8d27769754fd7
+  metadata.gz: eb1d5cb4779a5e9bbf4e8dc233c50f50a83721133d16f2a80098e21d77c4d83367e40b574a04dae797385b802ccef3115c98df68dc6b9f8aaadabc64e9a31050
+  data.tar.gz: c2cb76059fe23caaebd136ffc81361eeab3c3626c60b952fea3345cf5701bd3c65b0393568acff52f31417143ddba541a7f29dfc678fb010a52cfb76b4a40772

data/README.md

@@ -26,53 +26,78 @@ create an instance and get information about the Icinga2 Server
     }
 
     i = Icinga::Client.new( config )
-    puts i.applicationData()
+    puts i.application_data()
+
 
 ## Status
 
 supports the following API Calls:
 
+  - [Users](doc/status.md)
+    * application_data
+    * cib_data
+    * api_listener
+
   - [Users](doc/users.md)
-    * addUser
-    * deleteUser
-    * listUsers
-    * existsUser
+    * add_user( params = {} )
+    * delete_user( params = {} )
+    * users( params = {} )
+    * exists_user?( name )
+
   - [Usergroups](doc/usergroups.md)
-    * addUsergroup
-    * deleteUsergroup
-    * listUsergroups
-    * existsUsergroup
+    * add_usergroup( params = {} )
+    * delete_usergroup( params = {} )
+    * usergroups( params = {} )
+    * exists_usergroup?( name )
+
   - [Hosts](doc/hosts.md)
-    * addHost
-    * deleteHost
-    * listHosts
-    * existsHost
+    * add_host( params = {} )
+    * delete_host( params = {} )
+    * hosts( params = {} )
+    * exists_host?( name )
+    * host_objects( params = {} )
+    * host_problems
+    * problem_hosts( max_items = 5 )
+    * host_severity( host )
+
   - [Hostgroups](doc/hostgroups.md)
-    * addHostgroup
-    * deleteHostgroup
-    * listHostgroups
-    * existsHostgroup
+    * add_hostgroup(params = {})
+    * delete_hostgroup(params = {})
+    * hostgroups(params = {})
+    * exists_hostgroup?(name)
+
   - [Services](doc/services.md)
-    * addService
-    * deleteService
-    * listServices
-    * existsService
+    * add_services( host, services = {} )
+    * unhandled_services( params = {} )
+    * services( params = {} )
+    * exists_service?( params = {} )
+    * service_objects( params = {} )
+    * service_problems
+    * problem_services( max_items = 5 )
+    * update_host( hash, host )
+    * service_severity( service )
+
   - [Servicegroups](doc/servicegroups.md)
-    * addServicegroup
-    * deleteServicegroup
-    * listServicegroups
-    * existsServicegroup
+    * add_servicegroup( params = {} )
+    * delete_servicegroup( params = {} )
+    * servicegroups( params = {} )
+    * exists_servicegroup?( name )
+
   - [Downtimes](doc/downtimes.md)
-    * addDowntime
-    * listDowntimes
+    * add_downtime( params = {} )
+    * downtimes( params = {} )
+
   - [Notifications](doc/notifications.md)
-    * enableHostNotification
-    * disableHostNotification
-    * enableServiceNotification
-    * disableServiceNotification
-    * enableHostgroupNotification
-    * disableHostgroupNotification
-    * listNotifications
+    * enable_host_notification( host )
+    * disable_host_notification( host )
+    * enable_service_notification( params = {} )
+    * disable_service_notification( host )
+    * enable_hostgroup_notification( group )
+    * disable_hostgroup_notification( group )
+    * notifications( params = {} )
+    * host_notification( params = {} )
+    * hostgroup_notification( params = {} )
+    * service_notification( params = {} )
 
 
 ## create a own gem File
@@ -80,13 +105,13 @@ supports the following API Calls:
     #$ gem build icinga2.gemspec
     Successfully built RubyGem
     Name: icinga2
-    Version: 1.4.9
-    File: icinga2-1.4.9.gem
+    Version: 0.6.0
+    File: icinga2-0.6.0.gem
 
 ## install gem
 
-    #$ gem install ./icinga2-1.4.9.gem
-    Successfully installed icinga2-1.4.9
+    #$ gem install icinga2
+    Successfully installed icinga2-0.6.0
     1 gem installed
 
 ## test via CLI

data/doc/downtimes.md

@@ -1,7 +1,8 @@
 # Icinga2 - Downtimes
 
+
 ## add
-    addDowntime()
+    add_downtime()
 
-# list
-    listDowntimes()
+## list
+    downtimes()

data/doc/hostgroups.md

@@ -1,19 +1,22 @@
 # Icinga2 - Hostgroups
 
-## check
-    existsHostgroup()
 
 ## add
-    addHostgroup()
+    add_hostgroup()
+
+
+## delete
+    delete_hostgroup()
+
 
 ## list
 
 ### named
-    listHostgroups()
+    hostgroups()
 
 ### all
-    listHostgroups()
+    hostgroups()
 
-## delete
-    deleteHostgroup()
 
+## check
+    exists_hostgroup()

data/doc/hosts.md

@@ -1,8 +1,5 @@
 # Icinga2 - Hosts
 
-## check
-    existsHost()
-
 ## add
     vars = {
       'aws' => false
@@ -10,13 +7,28 @@
 
     addHost( 'foo-bar.lan', vars )
 
+## delete
+    deleteHost( 'foo-bar.lan' )
+
 ## list
 
 ### named
-    listHosts( 'foo-bar.lan' )
+    hosts( 'foo-bar.lan' )
 
 ### all
-    listHosts()
+    hosts()
 
-## delete
-    deleteHost( 'foo-bar.lan' )
+## check
+    existsHost()
+
+##
+    host_objects
+
+##
+    host_problems
+
+##
+    problem_hosts
+
+##
+    host_severity

data/doc/notifications.md

@@ -1,15 +1,32 @@
 # Icinga2 - Notifications
 
-    enableHostNotification()
 
-    disableHostNotification()
+## -
+    enable_host_notification( host )
 
-    enableServiceNotification()
+## -
+    disable_host_notification( host )
 
-    disableServiceNotification()
+## -
+    enable_service_notification( params = {} )
 
-    enableHostgroupNotification()
+## -
+    disable_service_notification( host )
 
-    disableHostgroupNotification()
+## -
+    enable_hostgroup_notification( group )
 
-    listNotifications()
+## -
+    disable_hostgroup_notification( group )
+
+## -
+    notifications( params = {} )
+
+## -
+    host_notification( params = {} )
+
+## -
+    hostgroup_notification( params = {} )
+
+## -
+    service_notification( params = {} )

data/doc/servicegroups.md

@@ -1,19 +1,22 @@
 # Icinga2 - Servicegroups
 
-## check
-    existsServicegroup()
 
 ## add
-    addServicegroup()
+    add_servicegroup()
+
+
+## delete
+    delete_servicegroup()
+
+
+## check
+    exists_servicegroup?
 
 ## list
 
 ### named
-    listServicegroups()
+    servicegroups()
 
 ### all
-    listServicegroups()
-
-## delete
-    deleteServicegroup()
+    servicegroups()
 

data/doc/services.md

@@ -1,9 +1,6 @@
 # Icinga2 - Services
 
 
-## check
-    existsService()
-
 ## add
     services = {
       'service-heap-mem' => {
@@ -12,15 +9,41 @@
       }
     }
 
-    i.addServices( 'foo-bar.lan', services )
+    i.add_services( 'foo-bar.lan', services )
+
+## -
+
+    unhandled_services
+
 
 ## list
 
 ### named
-    listServices( 'foo-bar.lan' )
+    services( 'foo-bar.lan' )
 
 ### all
-    listServices()
+    services()
 
 ## delete
 **not yet implemented**
+
+
+
+## check
+    exists_service?
+
+##
+    service_objects( params = {} )
+
+
+##
+    service_problems
+
+##
+    problem_services( max_items = 5 )
+
+##
+    update_host( hash, host )
+
+##
+    service_severity( service )

data/doc/usergroups.md

@@ -1,12 +1,16 @@
 # Icinga2 - Usergroups
 
-    existsUsergroup()
 
-    listUsergroups()
+    add_usergroup
 
-    addUsergroup()
 
-    deleteUsergroup()
+    delete_usergroup
+
+
+    usergroups
+
+
+    exists_usergroup?
 
 
 

data/doc/users.md

@@ -1,10 +1,5 @@
 # Icinga2 - Users
 
-## check, if User exists
-
-    existsUser?( $USERNAME )
-
-return `true` or `false`
 
 ## add User
 
@@ -16,7 +11,13 @@ return `true` or `false`
       :groups => ['icingaadmins']
     }
 
-    addUser( var )
+    add_user var
+
+return `Hash`
+
+## delete User
+
+    delete_user { :name => $USERNAME }
 
 return `Hash`
 
@@ -24,18 +25,18 @@ return `Hash`
 
 ### named User
 
-    listUsers( { :name => $USERNAME } )
+    users { :name => $USERNAME }
 
 return `Hash`
 
 ### all Users
 
-    listUsers()
+    users
 
 return `Hash`
 
-## delete User
+## check, if User exists
 
-    deleteUser( { :name => $USERNAME } )
+    exists_user? $USERNAME
 
-return `Hash`
+return `true` or `false`

data/examples/test.rb

@@ -1,4 +1,5 @@
 #!/usr/bin/env ruby
+# frozen_string_literal: true
 #
 # 23.01.2017 - Bodo Schulz
 #
@@ -11,26 +12,26 @@ 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 )
+icinga_host         = ENV.fetch( 'ICINGA_HOST'             , 'icinga2' )
+icinga_api_port     = ENV.fetch( 'ICINGA_API_PORT'         , 5665 )
+icinga_api_user     = ENV.fetch( 'ICINGA_API_USER'         , 'admin' )
+icinga_api_pass     = ENV.fetch( 'ICINGA_API_PASSWORD'     , nil )
+icinga_cluster      = ENV.fetch( 'ICINGA_CLUSTER'          , false )
+icinga_satellite    = ENV.fetch( 'ICINGA_CLUSTER_SATELLITE', nil )
 
 # convert string to bool
-icingaCluster   = icingaCluster.to_s.eql?('true') ? true : false
+icinga_cluster   = icinga_cluster.to_s.eql?('true') ? true : false
 
 config = {
-  :icinga => {
-    :host     => icingaHost,
-    :api      => {
-      :port     => icingaApiPort,
-      :user     => icingaApiUser,
-      :password => icingaApiPass
+  icinga: {
+    host: icinga_host,
+    api: {
+      port: icinga_api_port,
+      user: icinga_api_user,
+      password: icinga_api_pass
     },
-    :cluster   => icingaCluster,
-    :satellite => icingaSatellite,
+    cluster: icinga_cluster,
+    satellite: icinga_satellite
   }
 }
 
@@ -38,109 +39,112 @@ config = {
 
 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 ""
+unless( i.nil? )
+
+#  # run tests ...
+#  #
+#  #
+#
+puts 'Information about Icinga2:'
+puts i.application_data
+#  puts i.cib_data()
+#  puts i.api_listener
+#  puts ''
+#
+#  puts "check if Host 'icinga2-master' exists:"
+#  puts i.exists_host?( 'icinga2-master' ) ? 'true' : 'false'
+#  puts "get host Objects from 'icinga2-master'"
+#  puts i.host_objects
+#  puts 'Host problems:'
+#  puts i.host_problems
+#  puts 'Problem Hosts:'
+#  puts i.problem_hosts
+#
+#  puts 'list named Hosts:'
+#  puts i.hosts( name: 'icinga2-master' )
+#  puts 'list all Hosts:'
+#  puts i.hosts
+#  puts ''
+#
+#  puts "check if Hostgroup 'linux-servers' exists:"
+#  puts i.exists_hostgroup?( 'linux-servers' ) ? 'true' : 'false'
+#  puts "add hostgroup 'foo'"
+#  puts i.add_hostgroup( name: 'foo', display_name: 'FOO' )
+#  puts "list named Hostgroup 'foo'"
+#  puts i.hostgroups( name: 'foo' )
+#  puts 'list all Hostgroups:'
+#  puts i.hostgroups
+#  puts "delete Hostgroup 'foo'"
+#  puts i.delete_hostgroup( name: 'foo' )
+#  puts ''
+#
+#  puts "check if service 'users' on host 'icinga2-master' exists:"
+#  puts i.exists_service?( host: 'icinga2-master', service: 'users' )  ? 'true' : 'false'
+#
+#  puts 'get service Objects'
+#  puts i.service_objects
+#  puts 'Service problems:'
+#  puts i.service_problems
+#  puts 'Problem Services:'
+#  puts i.problem_services
+#
+#  puts "list named Service 'ping4' from Host 'icinga2-master'"
+#  puts i.services( host: 'icinga2-master', service: 'ping4' )
+#  puts 'list all Services:'
+#  puts i.services
+#  puts ''
+#
+#  puts "check if Servicegroup 'disk' exists:"
+#  puts i.exists_servicegroup?( 'disk' ) ? 'true' : 'false'
+#  puts "add Servicegroup 'foo'"
+#  puts i.add_servicegroup( name: 'foo', display_name: 'FOO' )
+#  puts "list named Servicegroup 'foo'"
+#  puts i.servicegroups( name: 'foo' )
+#  puts 'list all Servicegroup:'
+#  puts i.servicegroups
+#  puts "delete Servicegroup 'foo'"
+#  puts i.delete_servicegroup( name: 'foo' )
+#  puts ''
+#
+#  puts "check if Usergroup 'icingaadmins' exists:"
+#  puts i.exists_usergroup?( 'icingaadmins' ) ? 'true' : 'false'
+#  puts "add Usergroup 'foo'"
+#  puts i.add_usergroup( name: 'foo', display_name: 'FOO' )
+#  puts "list named Usergroup 'foo'"
+#  puts i.usergroups( name: 'foo' )
+#  puts 'list all Usergroup:'
+#  puts i.usergroups
+#  puts "delete Usergroup 'foo'"
+#  puts i.delete_usergroup( name: 'foo' )
+#  puts ''
+#
+#  puts "check if User 'icingaadmin' exists:"
+#  puts i.exists_user?( 'icingaadmin' ) ? 'true' : 'false'
+#  puts "add User 'foo'"
+#  puts i.add_user( name: 'foo', display_name: 'FOO', email: 'foo@bar.com', pager: '0000', groups: ['icingaadmins'] )
+#  puts "list named User 'foo'"
+#  puts i.users( name: 'foo' )
+#  puts 'list all User:'
+#  puts i.users
+#  puts "delete User 'foo'"
+#  puts i.delete_user( 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 i.add_downtime( name: 'test', type: 'service', host: 'icinga2', comment: 'test downtime', author: 'icingaadmin', start_time: Time.now.to_i, end_time: Time.now.to_i + 20 )
+  puts 'list all Downtimes:'
+  puts i.downtimes
 
-  puts "list all Notifications:"
-  puts i.listNotifications()
+  puts 'list all Notifications:'
+  puts i.notifications
 
-  puts i.enableHostNotification( 'icinga2-master' )
-  puts i.disableHostNotification( 'icinga2-master' )
+  puts 'enable Notifications for host:'
+  puts i.enable_host_notification( 'icinga2' )
+  puts 'disable Notifications for host:'
+  puts i.disable_host_notification( 'icinga2' )
 
- puts i.disableServiceNotification( 'icinga2-master' )
+  puts 'disable Notifications for host and services:'
+  puts i.disable_service_notification( 'icinga2' )
 
 
 end