icinga2 0.9.2.1 → 0.9.2.8

data/doc/method_list.html

@@ -132,6 +132,22 @@
   </li>
   
 
+  <li class="even ">
+    <div class="item">
+      <span class='object_link'><a href="Hash.html#assert_required_keys-instance_method" title="Hash#assert_required_keys (method)">#assert_required_keys</a></span>
+      <small>Hash</small>
+    </div>
+  </li>
+  
+
+  <li class="odd ">
+    <div class="item">
+      <span class='object_link'><a href="Hash.html#assert_valid_keys-instance_method" title="Hash#assert_valid_keys (method)">#assert_valid_keys</a></span>
+      <small>Hash</small>
+    </div>
+  </li>
+  
+
   <li class="even ">
     <div class="item">
       <span class='object_link'><a href="Icinga2/Client.html#available%3F-instance_method" title="Icinga2::Client#available? (method)">#available?</a></span>
@@ -646,7 +662,7 @@
 
   <li class="even ">
     <div class="item">
-      <span class='object_link'><a href="Icinga2/Converts.html#state_to_color-class_method" title="Icinga2::Converts.state_to_color (method)">state_to_color</a></span>
+      <span class='object_link'><a href="Icinga2/Converts.html#state_to_color-instance_method" title="Icinga2::Converts#state_to_color (method)">#state_to_color</a></span>
       <small>Icinga2::Converts</small>
     </div>
   </li>
@@ -654,7 +670,7 @@
 
   <li class="odd ">
     <div class="item">
-      <span class='object_link'><a href="Icinga2/Converts.html#state_to_string-class_method" title="Icinga2::Converts.state_to_string (method)">state_to_string</a></span>
+      <span class='object_link'><a href="Icinga2/Converts.html#state_to_string-instance_method" title="Icinga2::Converts#state_to_string (method)">#state_to_string</a></span>
       <small>Icinga2::Converts</small>
     </div>
   </li>
@@ -700,6 +716,22 @@
   </li>
   
 
+  <li class="odd ">
+    <div class="item">
+      <span class='object_link'><a href="Icinga2/Validator.html#validate-instance_method" title="Icinga2::Validator#validate (method)">#validate</a></span>
+      <small>Icinga2::Validator</small>
+    </div>
+  </li>
+  
+
+  <li class="even ">
+    <div class="item">
+      <span class='object_link'><a href="Icinga2/Validator.html#validate_options!-instance_method" title="Icinga2::Validator#validate_options! (method)">#validate_options!</a></span>
+      <small>Icinga2::Validator</small>
+    </div>
+  </li>
+  
+
   <li class="odd ">
     <div class="item">
       <span class='object_link'><a href="Icinga2/Client.html#version-instance_method" title="Icinga2::Client#version (method)">#version</a></span>

data/doc/services.md

@@ -7,26 +7,36 @@ Add a Service to Icinga2
 
 `params` is an `Hash` with following Parameters:
 
-| Parameter              | Type    | Example           | Description
-| :--------------------  | :-----: | :-----            | :-----------
-| `host_name`            | String  | `foo`             | existing Host for these Service
-| `name`                 | String  | `ping4`           | Service Name they will be create
-| `templates`            | Array   | `['own-service']` | (optional) a Array of templates (default: `['generic-service']`)
-| `vars`                 | Hash    | (see below)       | Hash with custom options
-
-Under the `vars` Hash is the structure very strict.
-They hold only a `attrs` Hash with all others variable.
-
-**Importand** The the `attrs` Hash has mandatory fields!
-
-| Parameter              | Type    | Example           | Description
-| :--------------------  | :-----: | :------------     | :-----------
-| `check_command`        | String  | `ping4`           | The Check Command to execute (**Importand** This Check-Comand must be exists! Otherwise an error will occur)
-| `check_interval`       | Integer | `10`              | The check Interval
-| `retry_interval`       | Integer | `30`              | The retry Interval
-| `vars`                 | Hash    | (see below)       | optional config params for the `check_command`
-
-For more custom fields, add an `vars` Hash with the config parameters of the `check_command` (see below in the examples)
+| Parameter                | Type    | Example           | Description
+| :--------------------    | :-----: | :-----            | :-----------
+| `host_name`              | String  | `foo`             | existing Host for these Service
+| `name`                   | String  | `ping4`           | Service Name they will be create
+| `display_name`           | String  | `ping4 check`     | displayed Name
+| `templates`              | Array   | `['own-service']` | (optional) a Array of templates (default: `['generic-service']`)
+| `check_command`          | String  | `ping4`           | The Check Command to execute (**Importand** This Check-Comand must be exists! Otherwise an error will occur)
+| `check_interval`         | Integer | `10`              | The check Interval
+| `retry_interval`         | Integer | `30`              | The retry Interval
+| `notes`                  | String  | ``                |
+| `notes_url`              | String  | ``                |
+| `action_url`             | String  | ``                |
+| `check_period`           | String  | ``                |
+| `check_timeout`          | Integer | ``                |
+| `command_endpoint`       | String  | ``                |
+| `enable_active_checks`   | Bool    | ``                |
+| `enable_event_handler`   | Bool    | ``                |
+| `enable_flapping`        | Bool    | ``                |
+| `enable_notifications`   | Bool    | ``                |
+| `enable_passive_checks`  | Bool    | ``                |
+| `enable_perfdata`        | Bool    | ``                |
+| `event_command`          | String  | ``                |
+| `flapping_threshold_high`| Integer | ``                |
+| `flapping_threshold_low` | Integer | ``                |
+| `flapping_threshold`     | Integer | ``                |
+| `icon_image_alt`         | String  | ``                |
+| `icon_image`             | String  | ``                |
+| `max_check_attempts`     | Integer | ``                |
+| `volatile`               | Bool    | ``                |
+| `vars`                   | Hash    | (see below)       | optional config params for the `check_command`
 
 The result are an `Hash`
 
@@ -35,13 +45,9 @@ The result are an `Hash`
     @icinga.add_services(
       host_name: 'foo',
       name: 'ping4',
-      vars: {
-        attrs: {
-          check_command: 'ping4',
-          check_interval: 10,
-          retry_interval: 30
-        }
-      }
+      check_command: 'ping4',
+      check_interval: 10,
+      retry_interval: 30
     )
 
 or
@@ -49,17 +55,13 @@ or
     @icinga.add_service(
       host_name: 'foo',
       name: 'http',
+      check_command: 'http',
+      check_interval: 10,
+      retry_interval: 30,
       vars: {
-        attrs: {
-          check_command: 'http',
-          check_interval: 10,
-          retry_interval: 30,
-          vars: {
-            http_address: '127.0.0.1',
-            http_url: '/access/index',
-            http_port: 80
-          }
-        }
+        http_address: '127.0.0.1',
+        http_url: '/access/index',
+        http_port: 80
       }
     )
 
@@ -97,14 +99,9 @@ Modify an Service.
 
 | Parameter              | Type    | Example           | Description
 | :--------------------  | :-----: | :-----            | :-----------
-| `name`         | String  | `ping4`           | Service Name they will be deleted
+| `name`                 | String  | `ping4`           | Service Name they will be deleted
 | `templates`            | Array   | `['own-service']` | (optional) a Array of templates (default: `['generic-service']`)
-| `vars`                 | Hash    | (see below)       | Hash with custom options
-
-Under the `vars` Hash is the structure very strict.
-They hold only a `attrs` Hash with all others variable. (similar to `add_service`)
-
-For more custom fields, add an `vars` Hash with the config parameters of the `check_command` (see below in the examples)
+| `vars`                 | Hash    | (see below)       | Hash with custom options (see `add_services()`)
 
 The result are an `Hash`
 
@@ -112,15 +109,11 @@ The result are an `Hash`
 
     @icinga.modify_service(
       name: 'http2',
+      check_interval: 60,
+      retry_interval: 10,
       vars: {
-        attrs: {
-          check_interval: 60,
-          retry_interval: 10,
-          vars: {
-            http_url: '/access/login'     ,
-            http_address: '10.41.80.63'
-          }
-        }
+        http_url: '/access/login'     ,
+        http_address: '10.41.80.63'
       }
     )
 
@@ -286,13 +279,3 @@ The result are an `Integer`
     service_severity( {'attrs' => { 'state' => 0.0, 'acknowledgement' => 0.0, 'downtime_depth' => 0.0 } } )
 
 
-
-## <a name=""></a>*update_host( hash, host )* (private)
-
-update host
-
-The result are an `Hash`
-
-### Example
-    service_severity( {'attrs' => { 'state' => 0.0, 'acknowledgement' => 0.0, 'downtime_depth' => 0.0 } } )
-

data/doc/top-level-namespace.html

@@ -6,7 +6,7 @@
 <title>
   Top Level Namespace
   
-    &mdash; Documentation by YARD 0.9.4
+    &mdash; Documentation by YARD 0.9.11
   
 </title>
 
@@ -28,7 +28,7 @@
   </head>
   <body>
     <div class="nav_wrap">
-      <iframe id="nav" src="class_list.html"></iframe>
+      <iframe id="nav" src="class_list.html?1"></iframe>
       <div id="resizer"></div>
     </div>
 
@@ -59,8 +59,6 @@
         <div class="clear"></div>
       </div>
 
-      <iframe id="search_frame" src="class_list.html"></iframe>
-
       <div id="content"><h1>Top Level Namespace
   
   
@@ -104,9 +102,9 @@
 </div>
 
       <div id="footer">
-  Generated on Sun Nov 12 15:48:13 2017 by
+  Generated on Sat Dec  9 20:28:06 2017 by
   <a href="http://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
-  0.9.4 (ruby-2.2.8).
+  0.9.11 (ruby-2.2.8).
 </div>
 
     </div>

data/examples/_blank.rb

@@ -61,8 +61,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/examples/config.rb

@@ -0,0 +1,23 @@
+
+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 )
+
+@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
+    }
+  }
+}
+
+# ---------------------------------------------------------------------------------------
+

data/examples/downtimes.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? )
 
@@ -68,8 +39,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/examples/hostgroups.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? )
 
@@ -80,8 +51,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/examples/hosts.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? )
 
@@ -165,12 +136,26 @@ unless( i.nil? )
     puts i.hosts(name: 'c1-mysql-1')
     puts ''
 
+    puts '= list named Hosts \'c1-mysql-1\' (with attrs and filter)'
+    puts i.hosts(
+      name: 'c1-mysql-1',
+      attrs: %w[display_name name address]
+    )
+    puts ''
+
+    puts '= host object with attrs and filter'
+    # Get host name, address of hosts belonging to a specific hostgroup
+    puts i.host_objects(
+      attrs: %w[display_name name address],
+      filter: '"linux-servers" in host.groups'
+    )
+
     puts ' ------------------------------------------------------------- '
     puts ''
 
     rescue => e
-      $stderr.puts( e )
-      $stderr.puts( e.backtrace.join("\n") )
+      warn( e )
+      warn( e.backtrace.join("\n") )
     end
 end