icinga2 0.9.2.8 → 1.0.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 7f33482da16075121f4e961b687fdb49458a197c
-  data.tar.gz: f3aba7b6edf26ae6bfe5b014a265e6a3a0ed4a59
+  metadata.gz: 9a7a28e46c91e531a8442586d4f1a920ad2e01c2
+  data.tar.gz: 949ef6c923a5f5efe3a4dde2b983a5877f5e3e17
 SHA512:
-  metadata.gz: f5d780e4b7d7bb08dd97f87a75a4c0148a3e70b1439151bee9d18abe86503045455e9630d0caee5f5bef4680afb8c4a8b38dfe682960dfa1440066b66b4e46cc
-  data.tar.gz: 86dfdbd9573c2a55da7a57f0d1e2c2b1e13b43b5c0a63f8f7f11e32baeaaff826eaefffd40f482912fc99b4a52e1a5ee605d5e8b0a8aedffecfa05851ae6726f
+  metadata.gz: 8fbf96dde58391e3a0cba5d6fc497359fe52835919043f170df30c55ed9adf9e2d34a218076e36755da54271845807736fd861174833e48bd8c784ae6179fe5f
+  data.tar.gz: f8310775e88be3c876024b5510d1f0e26a85147f9dab5ac8994cb73fe4edc0d71692b2f4a6b3ec5a63d7c0c3cc9e8d8319b5f1842c63c3914c46e5b316ea5a30

data/README.md

@@ -144,6 +144,7 @@ supports the following API Calls:
 
   - [Downtimes](doc/downtimes.md)
     * [add downtime](doc/downtimes.md#add-downtime)
+    * [remove downtime](doc/downtimes.md#remove-downtime)
     * [list downtimes](doc/downtimes.md#list-downtimes)
 
   - [Notifications](doc/notifications.md)
@@ -165,12 +166,3 @@ supports the following API Calls:
     * [statistic data for hosts](doc/statistics.md#stats-hosts)
     * [queue statistics from the api](doc/statistics.md#stats-work-queue)
 
-
-
-## 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

@@ -18,6 +18,45 @@
     @icinga.add_downtime( param )
 
 
+## <a name="remove-downtime"></a>remove a downtime
+    remove_downtime( params )
+
+### Example
+
+remove all downtimes from the user `icingaadmin` and the comment `test downtime`
+
+```bash
+param = {
+  comment: 'test downtime',
+  author: 'icingaadmin'
+}
+@icinga.remove_downtime(param)
+```
+
+remove a downtime from a host but not the services filtered by the author name.
+This example uses filter variables explained in the
+[advanced filters](https://github.com/Icinga/icinga2/blob/master/doc/12-icinga2-api.md#icinga2-api-advanced-filters)
+chapter from the official API documentation.
+
+```bash
+param = {
+  filter: '"host.name == filterHost && !service && downtime.author == filterAuthor"',
+  filter_vars: { filterHost: 'c1-mysql-1', filterAuthor: 'icingaadmin' }
+)
+@icinga.remove_downtime(param)
+```
+
+remove a downtime for service `ping4` and host `c1-mysql-1`
+
+```bash
+param = {
+  host_name: 'c1-mysql-1',
+  service_name: 'ping4'
+}
+@icinga.remove_downtime(param)
+```
+
+
 ## <a name="list-downtimes"></a>list all downtimes
     downtimes
 

data/lib/icinga2/actions.rb

@@ -0,0 +1,152 @@
+
+# frozen_string_literal: false
+
+module Icinga2
+
+  # namespace for action handling
+  #
+  # There are several actions available for Icinga 2 provided by the /v1/actions URL endpoint.
+  #
+  #
+  # original API Documentation: https://www.icinga.com/docs/icinga2/latest/doc/12-icinga2-api/#actions
+  #
+  module Actions
+
+    # Process a check result for a host or a service.
+    #
+    # FUNCTION IS NOT IMPLEMENTED YET
+    #
+    # original Documentation: https://www.icinga.com/docs/icinga2/latest/doc/12-icinga2-api/#process-check-result
+    #
+    # @param [Hash] params
+    # @option params [Integer] exit_status For services: 0=OK, 1=WARNING, 2=CRITICAL, 3=UNKNOWN, for hosts: 0=OK, 1=CRITICAL.
+    # @option params [String] plugin_output One or more lines of the plugin main output. Does not contain the performance data.
+    # @option params [Array] performance_data The performance data.
+    # @option params [Array] check_command The first entry should be the check commands path, then one entry for each command line option followed by an entry for each of its argument.
+    # @option params [String] check_source Usually the name of the command_endpoint
+    # @option params [Integer] execution_start The timestamp where a script/process started its execution.
+    # @option params [Integer] execution_end The timestamp where a script/process ended its execution. This timestamp is used in features to determine e.g. the metric timestamp.
+    # @option params [String] host_name
+    # @option params [String] service_name
+    # @option params [String] type
+    # @option params [String] filter
+    #
+    # @example
+    #   params = {
+    #     host_name: 'example.localdomain',
+    #     service_name: 'passive-ping6',
+    #     exit_status: 2,
+    #     plugin_output: 'PING CRITICAL - Packet loss = 100%',
+    #     performance_data: [
+    #       'rta=5000.000000ms;3000.000000;5000.000000;0.000000',
+    #       'pl=100%;80;100;0'
+    #     ],
+    #     check_source: 'example.localdomain'
+    #   }
+    #   process_check_result(params)
+    #
+    #   params = {
+    #     exit_status: 1,
+    #     plugin_output: 'Host is not available.',
+    #     type: 'Host',
+    #     filter: 'host.name == "example.localdomain"'
+    #   }
+    #   process_check_result(params)
+    #
+    # @return [Hash] result
+    #
+#     def process_check_result(params)
+#
+#       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? )
+#
+#       # exit_status      = validate( params, required: true, var: 'exit_status', type: Integer )
+#       # plugin_output    = validate( params, required: true, var: 'plugin_output', type: String )
+#       # performance_data = validate( params, required: false, var: 'performance_data', type: Array )
+#       # check_command    = validate( params, required: false, var: 'check_command', type: Array )
+#       # check_source     = validate( params, required: false, var: 'check_source', type: String )
+#       # execution_start  = validate( params, required: false, var: 'execution_start', type: Integer )
+#       # execution_end    = validate( params, required: false, var: 'execution_end', type: String )
+#
+#     end
+
+    #
+    # original Documentation: https://www.icinga.com/docs/icinga2/latest/doc/12-icinga2-api/#reschedule-check
+#     def reschedule_check(params)
+#
+#       # $ curl -k -s -u root:icinga -H 'Accept: application/json' -X POST 'https://localhost:5665/v1/actions/reschedule-check' \
+#       # -d '{ "type": "Service", "filter": "service.name==\"ping6\"" }' | python -m json.tool
+#     end
+
+    #
+    # original Documentation: https://www.icinga.com/docs/icinga2/latest/doc/12-icinga2-api/#send-custom-notification
+#     def send_custom_notification
+#     end
+
+    #
+    # original Documentation: https://www.icinga.com/docs/icinga2/latest/doc/12-icinga2-api/#delay-notification
+#     def delay_notification
+#     end
+
+    #
+    # original Documentation: https://www.icinga.com/docs/icinga2/latest/doc/12-icinga2-api/#acknowledge-problem
+#     def acknowledge_problem
+#     end
+
+    #
+    # original Documentation: https://www.icinga.com/docs/icinga2/latest/doc/12-icinga2-api/#remove-acknowledgement
+#     def remove_acknowledgement
+#     end
+
+    #
+    # original Documentation: https://www.icinga.com/docs/icinga2/latest/doc/12-icinga2-api/#add-comment
+#     def add_comment
+#     end
+
+    #
+    # original Documentation: https://www.icinga.com/docs/icinga2/latest/doc/12-icinga2-api/#remove-comment
+#     def remove_comment
+#     end
+
+    #
+    # original Documentation: https://www.icinga.com/docs/icinga2/latest/doc/12-icinga2-api/#schedule-downtime
+#     def schedule_downtime
+#     end
+
+    # Shuts down Icinga2.
+    #
+    # @example
+    #    shutdown_process
+    #
+    # @return [Hash]
+    #
+    def shutdown_process
+      post(
+        url: format('%s/actions/shutdown-process', @icinga_api_url_base),
+        headers: @headers,
+        options: @options
+      )
+    end
+
+    # Restarts Icinga2.
+    #
+    # @example
+    #    restart_process
+    #
+    # @return [Hash]
+    #
+    def restart_process
+      post(
+        url: format('%s/actions/restart-process', @icinga_api_url_base),
+        headers: @headers,
+        options: @options
+      )
+    end
+
+    #
+    # original Documentation: https://www.icinga.com/docs/icinga2/latest/doc/12-icinga2-api/#generate-ticket
+#     def generate_ticket
+#     end
+
+  end
+end

data/lib/icinga2/client.rb

@@ -13,6 +13,8 @@ require_relative 'services'
 require_relative 'servicegroups'
 require_relative 'users'
 require_relative 'usergroups'
+require_relative 'configuration_management'
+require_relative 'actions'
 
 # -------------------------------------------------------------------------------------------------------------------
 #
@@ -59,15 +61,19 @@ module Icinga2
     include Icinga2::Servicegroups
     include Icinga2::Users
     include Icinga2::Usergroups
+    include Icinga2::ConfigurationManagement
+    include Icinga2::Actions
 
     # Returns a new instance of Client
     #
     # @param [Hash, #read] settings the settings for Icinga2
-    # @option settings [String] :host  the Icinga2 Hostname
-    # @option settings [Integer] :port (5665) the Icinga2 API Port
-    # @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 [String] host  the Icinga2 Hostname
+    # @option settings [Integer] port (5665) the Icinga2 API Port
+    # @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 [String] pki_path the location of the Certificate Files
+    # @option settings [String] node_name overwrite the Icnag2 hostname for the PKI. if the node_name no set, we try to resolve with gethostbyname()
     #
     # @example to create an new Instance
     #    config = {
@@ -119,16 +125,16 @@ module Icinga2
     # create a HTTP Header based on a Icinga2 Certificate or an User API Login
     #
     # @param [Hash, #read] params
-    # @option params [String] :pki_path the location of the Certificate Files
-    # @option params [String] :node_name the Icinga2 Hostname
-    # @option params [String] :user the Icinga2 API User
-    # @option params [String] :password the Icinga2 API Password
+    # @option params [String] pki_path the location of the Certificate Files
+    # @option params [String] node_name the Icinga2 Hostname
+    # @option params [String] user the Icinga2 API User
+    # @option params [String] password the Icinga2 API Password
     #
     # @example with Certificate
-    #    @icinga.cert?(pki_path: '/etc/icinga2', node_name: 'icinga2-dashing')
+    #    cert?(pki_path: '/etc/icinga2', node_name: 'icinga2-dashing')
     #
     # @example with User
-    #    @icinga.cert?(username: 'root', password: 'icinga')
+    #    cert?(username: 'root', password: 'icinga')
     #
     # @return [Array]
     #
@@ -190,7 +196,7 @@ module Icinga2
     # return Icinga2 Application data
     #
     # @example
-    #    @icinga.application_data
+    #    application_data
     #
     # @return [Hash]
     #
@@ -203,6 +209,7 @@ module Icinga2
       )
 
       return nil if( data.nil? )
+      return nil unless(data.is_a?(Hash))
 
       app_data = data.dig('icingaapplication','app')
 
@@ -219,7 +226,7 @@ module Icinga2
     # return Icinga2 CIB
     #
     # @example
-    #    @icinga.cib_data
+    #    cib_data
     #
     # @return [Hash]
     #
@@ -278,7 +285,7 @@ module Icinga2
     # return Icinga2 Status Data
     #
     # @example
-    #    @icinga.status_data
+    #    status_data
     #
     # @return [Hash]
     #
@@ -296,7 +303,7 @@ module Icinga2
     # return Icinga2 API Listener
     #
     # @example
-    #    @icinga.api_listener
+    #    api_listener
     #
     # @return [Hash]
     #
@@ -314,7 +321,7 @@ module Icinga2
     # check the availability of a Icinga network connect
     #
     # @example
-    #    @icinga.available?
+    #    available?
     #
     # @return [Bool]
     #
@@ -330,9 +337,9 @@ module Icinga2
     # return Icinga2 version and revision
     #
     # @example
-    #    @icinga.version.values
+    #    version.values
     #
-    #    v = @icinga.version
+    #    v = version
     #    version = v.dig(:version)
     #
     # @return [Hash]
@@ -355,7 +362,7 @@ module Icinga2
     # return Icinga2 node_name
     #
     # @example
-    #    @icinga.node_name
+    #    node_name
     #
     # @return [String]
     #
@@ -371,7 +378,7 @@ module Icinga2
     # return Icinga2 start time
     #
     # @example
-    #    @icinga.start_time
+    #    start_time
     #
     # @return [String]
     #
@@ -387,8 +394,8 @@ module Icinga2
     # return Icinga2 uptime
     #
     # @example
-    #    @icinga.cib_data
-    #    @icinga.uptime
+    #    cib_data
+    #    uptime
     #
     # @return [String]
     #

data/lib/icinga2/configuration_management.rb

@@ -0,0 +1,312 @@
+
+# frozen_string_literal: true
+
+module Icinga2
+
+  # namespace for config packages
+  #
+  # The main idea behind configuration management is to allow external applications creating configuration packages and stages based on configuration files and directory trees.
+  #
+  # This replaces any additional SSH connection and whatnot to dump configuration files to Icinga 2 directly.
+  #
+  # In case you are pushing a new configuration stage to a package, Icinga 2 will validate the configuration asynchronously and populate a status log which can be fetched in a separated request.
+  #
+  # original API Documentation: https://www.icinga.com/docs/icinga2/latest/doc/12-icinga2-api/#configuration-management
+  #
+  module ConfigurationManagement
+
+    # create a new empty configuration package.
+    #
+    # Package names starting with an underscore are reserved for internal packages and can not be used.
+    #
+    # @param [String] name the name for the new package.
+    #
+    # @example
+    #    create_config_package('cfg-package')
+    #
+    # @return [Hash]
+    #
+    def create_config_package(name)
+
+      raise ArgumentError.new(format('wrong type. \'name\' must be an String, given \'%s\'', name.class.to_s)) unless( name.is_a?(String) )
+      raise ArgumentError.new('missing \'name\'') if( name.size.zero? )
+
+      return { 'code' => 404, 'name' => name, 'status' => 'Package names starting with an underscore are reserved for internal packages and can not be used.'  } if( name.initial == '_' )
+
+      post(
+        url: format( '%s/config/packages/%s', @icinga_api_url_base, name ),
+        headers: @headers,
+        options: @options
+      )
+    end
+
+    # Configuration files in packages are managed in stages.
+    # Stages provide a way to maintain multiple configuration versions for a package.
+    #
+    # @param [Hash] params
+    # @option params [String] package name of the package
+    # @option params [String] name name for the package
+    # @option params [Bool] cluser (false) package for an satellite
+    # @option params [Bool] reload (true) reload icinga2 after upload
+    # @option params [String] vars
+    #
+    # @example
+    #    params = {
+    #      package: 'cfg-package',
+    #      name: 'host1',
+    #      cluster: false,
+    #      vars:  'object Host "cmdb-host" { chec_command = "dummy" }',
+    #      reload: false
+    #    }
+    #    upload_config_package(params)
+    #
+    # @return [Hash]
+    #
+    def upload_config_package(params)
+
+      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? )
+
+      package = validate( params, required: true, var: 'package', type: String )
+      name    = validate( params, required: true, var: 'name', type: String )
+      cluster = validate( params, required: false, var: 'cluster', type: Boolean ) || false
+      vars    = validate( params, required: false, var: 'vars', type: String )
+      reload  = validate( params, required: false, var: 'reload', type: Boolean ) || true
+      name    = name.gsub('.conf','')
+
+      return { 'code' => 404, 'status' => format('no package \'%s\' exists', package) } unless(package_exists?(package))
+
+      path = 'conf.d'
+      path = 'zones.d/satellite' if(cluster)
+      file = format( '%s/%s.conf', path, name )
+
+      payload = {
+        'files' => {
+          file.to_s => vars
+        },
+        'reload' => reload
+      }
+
+      post(
+        url: format( '%s/config/stages/%s', @icinga_api_url_base, package ),
+        headers: @headers,
+        options: @options,
+        payload: payload
+      )
+    end
+
+    # A list of packages.
+    #
+    # @example
+    #    list_config_packages
+    #
+    # @return [Hash]
+    #
+    def list_config_packages
+
+      get(
+        url: format( '%s/config/packages', @icinga_api_url_base ),
+        headers: @headers,
+        options: @options
+      )
+    end
+
+    # A list of packages and their stages.
+    #
+    # @param [Hash] params
+    # @option params [String] package
+    # @option params [String] stage
+    #
+    # @example
+    #    params = {
+    #      package: 'cfg-package',
+    #      stage: 'example.localdomain-1441625839-0'
+    #    }
+    #    list_config_stages(params)
+    #
+    # @return [Hash]
+    #
+    def list_config_stages(params)
+
+      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? )
+
+      package = validate( params, required: true, var: 'package', type: String )
+      stage   = validate( params, required: true, var: 'stage', type: String )
+
+      get(
+        url: format( '%s/config/stages/%s/%s', @icinga_api_url_base, package, stage ),
+        headers: @headers,
+        options: @options
+      )
+    end
+
+
+    # fetched the whole config package and return them as a String.
+    #
+    # @param [Hash] params
+    # @option params [String] package
+    # @option params [String] stage
+    # @option params [Bool] cluser (false) package for an satellite
+    # @option params [String] name
+    #
+    # @example
+    #    params = {
+    #      package: 'cfg-package',
+    #      stage: 'example.localdomain-1441625839-0',
+    #      name: 'host1',
+    #      cluster: false
+    #    }
+    #    fetch_config_stages(params)
+    #
+    # @return [String]
+    #
+    def fetch_config_stages(params)
+
+      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? )
+
+      package = validate( params, required: true, var: 'package', type: String )
+      stage   = validate( params, required: true, var: 'stage', type: String )
+      name    = validate( params, required: true, var: 'name', type: String )
+      cluster = validate( params, required: false, var: 'cluster', type: Boolean ) || false
+      name    = name.gsub('.conf','')
+
+      return { 'code' => 404, 'status' => format('no package \'%s\' exists', package) } unless(package_exists?(package))
+
+      path = 'conf.d'
+      path = 'zones.d/satellite' if(cluster)
+      file = format( '%s/%s/%s/%s.conf', package, stage, path, name )
+
+      get(
+        url: format( '%s/config/files/%s', @icinga_api_url_base, file ),
+        headers: {},
+        options: @options
+      )
+    end
+
+    # fetch the startup.log from the named packe / stage combination to see possible errors.
+    #
+    # @param [Hash] params
+    # @option params [String] package
+    # @option params [String] stage
+    # @option params [Bool] cluser (false) package for an satellite
+    #
+    # @example
+    #    params = {
+    #      package: 'cfg-package',
+    #      stage: 'example.localdomain-1441625839-0',
+    #      cluster: false
+    #    }
+    #    package_stage_errors(params)
+    #
+    # @return [String]
+    #
+    def package_stage_errors(params)
+
+      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? )
+
+      package = validate( params, required: true, var: 'package', type: String )
+      stage   = validate( params, required: true, var: 'stage', type: String )
+      # cluster = validate( params, required: false, var: 'cluster', type: Boolean ) || false
+
+      return { 'code' => 404, 'status' => format('no package \'%s\' exists', package) } unless(package_exists?(package))
+
+      file = format( '%s/%s/startup.log', package, stage )
+
+      get(
+        url: format( '%s/config/files/%s', @icinga_api_url_base, file ),
+        headers: {},
+        options: @options
+      )
+    end
+
+    # Deleting Configuration Package Stage
+    #
+    # @param [Hash] params
+    # @option params [String] package
+    # @option params [String] stage
+    #
+    # @example
+    #    params = {
+    #      package: 'cfg-package',
+    #      stage: 'example.localdomain-1441625839-0',
+    #      cluster: false
+    #    }
+    #    remove_config_stage(params)
+    #
+    # @return [Hash]
+    #
+    def remove_config_stage(params)
+
+      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? )
+
+      package = validate( params, required: true, var: 'package', type: String )
+      stage   = validate( params, required: true, var: 'stage', type: String )
+
+      return { 'code' => 404, 'name' => package, 'status' => 'Package names starting with an underscore are reserved for internal packages and can not be used.'  } if( package.initial == '_' )
+      return { 'code' => 404, 'status' => format('no package \'%s\' exists', name) } unless(package_exists?(package))
+
+      delete(
+        url: format( '%s/config/stages/%s/%s', @icinga_api_url_base, package, stage ),
+        headers: @headers,
+        options: @options
+      )
+    end
+
+    # Deleting Configuration Package
+    #
+    # @param [String] name the name for the package.
+    #
+    # @example
+    #    remove_config_package('cfg-package')
+    #
+    # @return [Hash]
+    #
+    def remove_config_package(name)
+
+      raise ArgumentError.new(format('wrong type. \'name\' must be an String, given \'%s\'', name.class.to_s)) unless( name.is_a?(String) )
+      raise ArgumentError.new('missing \'name\'') if( name.size.zero? )
+
+      return { 'code' => 404, 'name' => name, 'status' => 'Package names starting with an underscore are reserved for internal packages and can not be used.'  } if( name.initial == '_' )
+      return { 'code' => 404, 'status' => format('no package \'%s\' exists', name) } unless(package_exists?(name))
+
+      delete(
+        url: format( '%s/config/packages/%s', @icinga_api_url_base, name ),
+        headers: @headers,
+        options: @options
+      )
+    end
+
+    # check if a package exists
+    #
+    # @param [String] name the name for the package.
+    #
+    # @example
+    #    package_exists?('cfg-package')
+    #
+    # @return [Bool]
+    #
+    def package_exists?(name)
+
+      raise ArgumentError.new(format('wrong type. \'name\' must be an String, given \'%s\'', name.class.to_s)) unless( name.is_a?(String) )
+      raise ArgumentError.new('missing \'name\'') if( name.size.zero? )
+
+      current_packages = list_config_packages
+
+      return { 'code' => 404, 'status' => 'error to get packages' } if( current_packages.nil? && current_packages.dig('code') != 200 )
+
+      current_packages = current_packages.dig('results')
+
+      data = current_packages.select { |k,_| k['name'] == name }
+      data = data.first if( data )
+
+      return false unless(data)
+
+      true
+    end
+
+  end
+end