icinga2 0.9.2.1 → 0.9.2.8

data/examples/users.rb

@@ -9,40 +9,11 @@
 # -----------------------------------------------------------------------------
 
 require_relative '../lib/icinga2'
+require_relative 'config'
 
 # -----------------------------------------------------------------------------
 
-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_api_pki_path  = ENV.fetch( 'ICINGA_API_PKI_PATH'     , '/etc/icinga2' )
-icinga_api_node_name = ENV.fetch( 'ICINGA_API_NODE_NAME'    , nil )
-icinga_cluster       = ENV.fetch( 'ICINGA_CLUSTER'          , false )
-icinga_satellite     = ENV.fetch( 'ICINGA_CLUSTER_SATELLITE', nil )
-
-
-# convert string to bool
-icinga_cluster   = icinga_cluster.to_s.eql?('true') ? true : false
-
-config = {
-  icinga: {
-    host: icinga_host,
-    api: {
-      port: icinga_api_port,
-      user: icinga_api_user,
-      password: icinga_api_pass,
-      pki_path: icinga_api_pki_path,
-      node_name: icinga_api_node_name
-    },
-    cluster: icinga_cluster,
-    satellite: icinga_satellite
-  }
-}
-
-# ---------------------------------------------------------------------------------------
-
-i = Icinga2::Client.new( config )
+i = Icinga2::Client.new( @config )
 
 unless( i.nil? )
 
@@ -87,8 +58,8 @@ unless( i.nil? )
     puts ''
 
     rescue => e
-      $stderr.puts( e )
-      $stderr.puts( e.backtrace.join("\n") )
+      warn( e )
+      warn( e.backtrace.join("\n") )
     end
 end
 

data/lib/icinga2/client.rb

@@ -1,5 +1,6 @@
 
 require_relative 'version'
+require_relative 'validator'
 require_relative 'network'
 require_relative 'statistics'
 require_relative 'converts'
@@ -45,6 +46,7 @@ module Icinga2
 
     include Logging
 
+    include Icinga2::Validator
     include Icinga2::Network
     include Icinga2::Statistics
     include Icinga2::Converts
@@ -61,48 +63,39 @@ module Icinga2
     # Returns a new instance of Client
     #
     # @param [Hash, #read] settings the settings for Icinga2
-    # @option settings [String] :host ('localhost') the Icinga2 Hostname
+    # @option settings [String] :host  the Icinga2 Hostname
     # @option settings [Integer] :port (5665) the Icinga2 API Port
-    # @option settings [String] :user the Icinga2 API User
+    # @option settings [String] :username the Icinga2 API User
     # @option settings [String] :password the Icinga2 API Password
     # @option settings [Integer] :version (1) the Icinga2 API Version
-    # @option settings [Bool] :cluster Icinga2 Cluster Mode
-    # @option settings [Bool] :notifications (false) enable Icinga2 Host Notifications
     #
     # @example to create an new Instance
     #    config = {
     #      icinga: {
     #        host: '192.168.33.5',
     #        api: {
-    #          port: 5665,
-    #          user: 'root',
+    #          username: 'root',
     #          password: 'icinga',
     #          version: 1
-    #        },
-    #        cluster: false,
-    #        satellite: true
+    #        }
     #      }
     #    }
-    #
     #    @icinga = Icinga2::Client.new(config)
     #
     # @return [instance, #read]
     #
     def initialize( settings )
 
-      raise ArgumentError.new('only Hash are allowed') unless( settings.is_a?(Hash) )
+      raise ArgumentError.new(format('wrong type. \'settings\' must be an Hash, given \'%s\'', settings.class.to_s)) unless( settings.is_a?(Hash) )
       raise ArgumentError.new('missing settings') if( settings.size.zero? )
 
-      icinga_host           = settings.dig(:icinga, :host)           || 'localhost'
+      icinga_host           = settings.dig(:icinga, :host)
       icinga_api_port       = settings.dig(:icinga, :api, :port)     || 5665
-      icinga_api_user       = settings.dig(:icinga, :api, :user)
+      icinga_api_user       = settings.dig(:icinga, :api, :username)
       icinga_api_pass       = settings.dig(:icinga, :api, :password)
       icinga_api_version    = settings.dig(:icinga, :api, :version)  || 1
       icinga_api_pki_path   = settings.dig(:icinga, :api, :pki_path)
       icinga_api_node_name  = settings.dig(:icinga, :api, :node_name)
-      @icinga_cluster       = settings.dig(:icinga, :cluster)        || false
-      @icinga_satellite     = settings.dig(:icinga, :satellite)
-      @icinga_notifications = settings.dig(:icinga, :notifications)  || false
 
       @last_call_timeout    = 320
       @last_cib_data_called = 0
@@ -116,13 +109,11 @@ module Icinga2
       _has_cert, @options = cert?(
         pki_path: icinga_api_pki_path,
         node_name: icinga_api_node_name,
-        user: icinga_api_user,
+        username: icinga_api_user,
         password: icinga_api_pass
       )
 
       @headers    = { 'Content-Type' => 'application/json', 'Accept' => 'application/json' }
-
-      self
     end
 
     # create a HTTP Header based on a Icinga2 Certificate or an User API Login
@@ -137,9 +128,9 @@ module Icinga2
     #    @icinga.cert?(pki_path: '/etc/icinga2', node_name: 'icinga2-dashing')
     #
     # @example with User
-    #    @icinga.cert?(user: 'root', password: 'icinga')
+    #    @icinga.cert?(username: 'root', password: 'icinga')
     #
-    # @return [Bool, #read]
+    # @return [Array]
     #
     def cert?( params )
 
@@ -148,7 +139,7 @@ module Icinga2
 
       pki_path     = params.dig(:pki_path)
       node_name    = params.dig(:node_name)
-      user         = params.dig(:user)
+      username     = params.dig(:username)
       password     = params.dig(:password)
 
       if( node_name.nil? )
@@ -156,7 +147,6 @@ module Icinga2
           node_name = Socket.gethostbyname(Socket.gethostname).first
           logger.debug(format('node name: %s', node_name))
         rescue SocketError => e
-
           raise format("can't resolve hostname (%s)", e)
         end
       end
@@ -184,19 +174,17 @@ module Icinga2
         } ]
 
       else
-
         logger.debug( 'PKI not found, using basic auth for connection to Icinga 2 API' )
 
-        raise ArgumentError.new('Missing user_name') if( user.nil? )
-        raise ArgumentError.new('Missing password')  if( password.nil? )
+        raise ArgumentError.new('Missing \'username\'') if( username.nil? )
+        raise ArgumentError.new('Missing \'password\'') if( password.nil? )
 
         [false, {
-          user: user,
+          user: username,
           password: password,
           verify_ssl: OpenSSL::SSL::VERIFY_NONE
         } ]
       end
-
     end
 
     # return Icinga2 Application data
@@ -214,28 +202,14 @@ module Icinga2
         options: @options
       )
 
-      #puts '---'
-      #puts data
-      #puts data.class.to_s
-      #puts '---'
-
       return nil if( data.nil? )
-#      return data if( data.is_a?(Hash) && data.dig('code').to_i != 200 )
-#puts '.'
 
       app_data = data.dig('icingaapplication','app')
 
-      #puts '---'
-      #puts app_data
-      #puts app_data.class.to_s
-      #puts '---'
-
       # version and revision
       @version, @revision = parse_version(app_data.dig('version'))
-
       #   - node_name
       @node_name = app_data.dig('node_name')
-
       #   - start_time
       @start_time = Time.at(app_data.dig('program_start').to_f)
 

data/lib/icinga2/converts.rb

@@ -8,6 +8,12 @@ module Icinga2
   #
   module Converts
 
+    HOST_STATE_STRING = %w[Up Down].freeze
+    SERVICE_STATE_STRING = %w[OK Warning Critical Unknown].freeze
+
+    HOST_STATE_COLOR = %w[green red].freeze
+    SERVICE_STATE_COLOR = %w[green yellow red purple].freeze
+
     # convert a Icinga2 state into a human readable state
     #
     # @param [String] state the Icinga2 State
@@ -15,33 +21,11 @@ module Icinga2
     #
     # @return [String]
     #
-    def self.state_to_string( state, is_host = false )
-
-      state =
-      if( is_host == true )
-        case state
-        when 0
-          'Up'
-        when 1
-          'Down'
-        else
-          'Undefined'
-        end
-      else
-        case state
-        when 0
-          'OK'
-        when 1
-          'Warning'
-        when 2
-          'Critical'
-        when 3
-          'Unknown'
-        else
-          'Undefined'
-        end
-      end
-      state
+    def state_to_string( state, is_host = false )
+      result = SERVICE_STATE_STRING[state] unless( is_host )
+      result = HOST_STATE_STRING[state] if( is_host )
+      result = 'Undefined' if( result.nil? )
+      result
     end
 
     # convert a Icinga2 state into a named color
@@ -51,33 +35,11 @@ module Icinga2
     #
     # @return [String]
     #
-    def self.state_to_color( state, is_host = false )
-
-      state =
-      if( is_host == true )
-        case state
-        when 0
-          'green'
-        when 1
-          'red'
-        else
-          'blue'
-        end
-      else
-        case state
-        when 0
-          'green'
-        when 1
-          'yellow'
-        when 2
-          'red'
-        when 3
-          'purple'
-        else
-          'blue'
-        end
-      end
-      state
+    def state_to_color( state, is_host = false )
+      result = SERVICE_STATE_COLOR[state] unless( is_host )
+      result = HOST_STATE_COLOR[state] if( is_host )
+      result = 'blue' if( result.nil? )
+      result
     end
 
     # reformat a service check name

data/lib/icinga2/downtimes.rb

@@ -4,19 +4,28 @@
 module Icinga2
 
   # namespace for downtimes handling
+  #
+  # Schedule a downtime for hosts and services.
+  #
   module Downtimes
 
     # add downtime
     #
     # @param [Hash] params
-    # @option params [String] :name
-    # @option params [String] :host_name
-    # @option params [String] :host_group
-    # @option params [Integer] :start_time (Time.new.to_i)
-    # @option params [Integer] :end_time
-    # @option params [String] :author
-    # @option params [String] :comment
-    # @option params [String] :type 'host' or 'service' downtime
+    # @option params [String] host_name
+    # @option params [String] host_group
+    # @option params [String] type 'host' or 'service' downtime
+    # @option params [Integer] start_time (Time.new.to_i) Timestamp marking the beginning of the downtime. (required)
+    # @option params [Integer] end_time Timestamp marking the end of the downtime.  (required)
+    # @option params [String] author Name of the author. (required)
+    # @option params [String] comment Comment text. (required)
+    # @option params [String] config_owner
+    # @option params [Integer] duration Duration of the downtime in seconds if fixed is set to false. (Required for flexible downtimes.)
+    # @option params [Integer] entry_time
+    # @option params [Boolean] fixed (true) Defaults to true. If true, the downtime is fixed otherwise flexible. See downtimes for more information.
+    # @option params [String] scheduled_by
+    # @option params [String] service_name
+    # @option params [String] triggered_by Sets the trigger for a triggered downtime. See downtimes for more information on triggered downtimes.
     #
     # @example
     #    param = {
@@ -37,60 +46,53 @@ module Icinga2
       raise ArgumentError.new(format('wrong type. \'params\' must be an Hash, given \'%s\'', params.class.to_s)) unless( params.is_a?(Hash) )
       raise ArgumentError.new('missing \'params\'') if( params.size.zero? )
 
-      name            = params.dig(:name)
-      host_name       = params.dig(:host_name)
-      host_group      = params.dig(:host_group)
-      start_time      = params.dig(:start_time) || Time.now.to_i
-      end_time        = params.dig(:end_time)
-      author          = params.dig(:author)
-      comment         = params.dig(:comment)
-      type            = params.dig(:type)
-      fixed           = params.dig(:fixed) || true
-      duration        = params.dig(:duration) || 30
-      entry_time      = params.dig(:entry_time)
-      scheduled_by    = params.dig(:scheduled_by)
-      service_name    = params.dig(:service_name)
-      triggered_by    = params.dig(:triggered_by)
-      config_owner    = params.dig(:config_owner)
+      host_name       = validate( params, required: false, var: 'host_name', type: String )
+      host_group      = validate( params, required: false, var: 'host_group', type: String )
+      start_time      = validate( params, required: false, var: 'start_time', type: Integer ) || Time.now.to_i
+      end_time        = validate( params, required: false, var: 'end_time', type: Integer )
+      author          = validate( params, required: true, var: 'author', type: String )
+      comment         = validate( params, required: true, var: 'comment', type: String )
+      type            = validate( params, required: false, var: 'type', type: String )
+      fixed           = validate( params, required: false, var: 'fixed', type: Boolean ) || true
+      duration_required = true if( fixed == false )
+      duration        = validate( params, required: duration_required, var: 'duration', type: Integer )
+      entry_time      = validate( params, required: false, var: 'entry_time', type: Integer )
+      scheduled_by    = validate( params, required: false, var: 'scheduled_by', type: String )
+      service_name    = validate( params, required: false, var: 'service_name', type: String )
+      triggered_by    = validate( params, required: false, var: 'triggered_by', type: String )
+      config_owner    = validate( params, required: false, var: 'config_owner', type: String )
       filter          = nil
 
       # sanitychecks
       #
-      raise ArgumentError.new('Missing name') if( name.nil? )
-      raise ArgumentError.new("wrong downtype type. only 'host' or' service' allowed ('#{type}' giving)") if( %w[host service].include?(type.downcase) == false )
-      raise ArgumentError.new('choose host or host_group, not both') if( !host_group.nil? && !host_name.nil? )
-      raise ArgumentError.new('Missing downtime author') if( author.nil? )
-      raise ArgumentError.new("these author are not exists: #{author}") unless( exists_user?( author ) )
-      raise ArgumentError.new('Missing downtime comment') if( comment.nil? )
-      raise ArgumentError.new('Missing downtime end_time') if( end_time.nil? )
-      raise ArgumentError.new('end_time are equal or smaller then start_time') if( end_time.to_i <= start_time )
-
-      raise ArgumentError.new(format('wrong type. \'duration\' must be Integer, given \'%s\'', duration.class.to_s)) unless( duration.is_a?(Integer) )
-      raise ArgumentError.new(format('wrong type. \'fixed\' must be True or False, given \'%s\'', fixed.class.to_s)) unless( fixed.is_a?(TrueClass) || fixed.is_a?(FalseClass) )
+      raise ArgumentError.new(format('wrong downtype type. only \'host\' os \'service\' allowed, given \%s\'', type)) if( %w[host service].include?(type.downcase) == false )
+      raise ArgumentError.new('choose \'host_name\' or \'host_group\', not both') unless( host_group.nil? || host_name.nil? )
+      raise ArgumentError.new(format('these \'author\' are not exists: \'%s\'', author)) unless( exists_user?( author ) )
+      raise ArgumentError.new('Missing downtime \'end_time\'') if( end_time.nil? )
+      raise ArgumentError.new('\'end_time\' are equal or smaller then \'start_time\'') if( end_time.to_i <= start_time )
 
       # TODO
-      # check if host_name exists!
+      #  - more flexibility (e.g. support scheduled_by ...)
 
+      unless( host_name.nil? )
+        return { 'code' => 404, 'name' => host_name, 'status' => 'Object not Found' } unless( exists_host?( host_name ) )
+        filter = format( 'host.name == "%s"', host_name )
+      end
 
-      if( !host_name.nil? )
-
-        filter = format( 'host.name=="%s"', host_name )
-      elsif( !host_group.nil? )
-
-        # check if hostgroup available ?
-        #
+      unless( host_group.nil? )
+        return { 'code' => 404, 'name' => host_group, 'status' => 'Object not Found' } unless( exists_hostgroup?( host_group ) )
         filter = format( '"%s" in host.groups', host_group )
       end
 
       payload = {
         type: type.capitalize, # we need the first char as Uppercase
+        filter: filter,
+        fixed: fixed,
         start_time: start_time,
         end_time: end_time,
         author: author,
         comment: comment,
-        fixed: fixed,
         duration: duration,
-        filter: filter,
         entry_time: entry_time,
         scheduled_by: scheduled_by,
         host_name: host_name,

data/lib/icinga2/hostgroups.rb

@@ -9,11 +9,12 @@ module Icinga2
     # add a hostgroup
     #
     # @param [Hash] params
-    # @option params [String] :host_group hostgroup to create
-    # @option params [String] :display_name the displayed name
-    # @option params [String] :notes
-    # @option params [String] :notes_url
-    # @option params [String] :action_url
+    # @option params [String] host_group hostgroup to create
+    # @option params [String] display_name the displayed name
+    # @option params [String] notes
+    # @option params [String] notes_url
+    # @option params [String] action_url
+    # @option params [Hash] vars ({})
     #
     # @example
     #   @icinga.add_hostgroup(host_group: 'foo', display_name: 'FOO')
@@ -25,27 +26,26 @@ module Icinga2
       raise ArgumentError.new(format('wrong type. \'params\' must be an Hash, given \'%s\'', params.class.to_s)) unless( params.is_a?(Hash) )
       raise ArgumentError.new('missing \'params\'') if( params.size.zero? )
 
-      host_group   = params.dig(:host_group)
-      display_name = params.dig(:display_name)
-      notes        = params.dig(:notes)
-      notes_url    = params.dig(:notes_url)
-      action_url   = params.dig(:action_url)
-
-      raise ArgumentError.new('Missing \'host_group\'') if( host_group.nil? )
-      raise ArgumentError.new('Missing \'display_name\'') if( display_name.nil? )
+      host_group = validate( params, required: true, var: 'host_group', type: String )
+      display_name = validate( params, required: false, var: 'display_name', type: String )
+      notes = validate( params, required: false, var: 'notes', type: String )
+      notes_url = validate( params, required: false, var: 'notes_url', type: String )
+      action_url = validate( params, required: false, var: 'action_url', type: String )
+      vars   = validate( params, required: false, var: 'vars', type: Hash ) || {}
 
       payload = {
-        'attrs' => {
-          'display_name' => display_name,
-          'notes' => notes,
-          'notes_url' => notes_url,
-          'action_url' => action_url
+        attrs: {
+          display_name: display_name,
+          notes: notes,
+          notes_url: notes_url,
+          action_url: action_url,
+          vars: vars
         }
       }
 
       # remove all empty attrs
       payload.reject!{ |_k, v| v.nil? }
-      payload['attrs'].reject!{ |_k, v| v.nil? }
+      payload[:attrs].reject!{ |_k, v| v.nil? }
 
       put(
         url: format('%s/objects/hostgroups/%s', @icinga_api_url_base, host_group),
@@ -58,10 +58,12 @@ module Icinga2
     # delete a hostgroup
     #
     # @param [Hash] params
-    # @option params [String] :name hostgroup to delete
+    # @option params [String] name hostgroup to delete
+    # @option params [Bool] cascade (false) delete hostgroup also when other objects depend on it
     #
     # @example
-    #   @icinga.delete_hostgroup(host_group: 'foo')
+    #   @icinga.delete_hostgroup(name: 'foo')
+    #   @icinga.delete_hostgroup(name: 'foo', cascade: true)
     #
     # @return [Hash] result
     #
@@ -70,12 +72,15 @@ module Icinga2
       raise ArgumentError.new(format('wrong type. \'params\' must be an Hash, given \'%s\'', params.class.to_s)) unless( params.is_a?(Hash) )
       raise ArgumentError.new('missing \'params\'') if( params.size.zero? )
 
-      host_group = params.dig(:host_group)
+      name = validate( params, required: true, var: 'name', type: String )
+      cascade = validate( params, required: false, var: 'cascade', type: Boolean ) || false
+
+      return { 'code' => 404, 'status' => 'Object not Found' } if( exists_hostgroup?( name ) == false )
 
-      raise ArgumentError.new('Missing \'host_group\'') if( host_group.nil? )
+      url = format( '%s/objects/hostgroups/%s%s', @icinga_api_url_base, name, cascade.is_a?(TrueClass) ? '?cascade=1' : nil )
 
       delete(
-        url: format('%s/objects/hostgroups/%s?cascade=1', @icinga_api_url_base, host_group),
+        url: url,
         headers: @headers,
         options: @options
       )
@@ -83,8 +88,7 @@ module Icinga2
 
     # returns all usersgroups
     #
-    # @param [Hash] params
-    # @option params [String] :host_group ('') optional for a single hostgroup
+    # @param [String] host_group (nil) optional for a single hostgroup
     #
     # @example to get all users
     #    @icinga.hostgroups
@@ -94,16 +98,12 @@ module Icinga2
     #
     # @return [Hash] returns a hash with all hostgroups
     #
-    def hostgroups( params = {} )
+    def hostgroups( host_group = nil )
 
-      host_group = params.dig(:host_group)
+      raise ArgumentError.new(format('wrong type. \'host_group\' must be an String, given \'%s\'', host_group.class.to_s)) unless( host_group.nil? || host_group.is_a?(String) )
 
-      url =
-      if( host_group.nil? )
-        format( '%s/objects/hostgroups'   , @icinga_api_url_base )
-      else
-        format( '%s/objects/hostgroups/%s', @icinga_api_url_base, host_group )
-      end
+      url = format( '%s/objects/hostgroups'   , @icinga_api_url_base )
+      url = format( '%s/objects/hostgroups/%s', @icinga_api_url_base, host_group ) unless( host_group.nil? )
 
       api_data(
         url: url,
@@ -126,7 +126,7 @@ module Icinga2
       raise ArgumentError.new(format('wrong type. \'host_group\' must be an String, given \'%s\'', host_group.class.to_s)) unless( host_group.is_a?(String) )
       raise ArgumentError.new('Missing \'host_group\'') if( host_group.size.zero? )
 
-      result = hostgroups(host_group: host_group)
+      result = hostgroups(host_group)
       result = JSON.parse( result ) if( result.is_a?(String) )
       result = result.first if( result.is_a?(Array) )