zabbix_manager 5.0.5 → 5.0.8

data/lib/zabbix_manager/classes/screens.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 class ZabbixManager
   class Screens < Basic
     # extracted from frontends/php/include/defines.inc.php
@@ -23,14 +25,14 @@ class ZabbixManager
     #
     # @return [String]
     def method_name
-      'screen'
+      "screen"
     end
 
     # The id field name used for identifying specific Screen objects via Zabbix API
     #
     # @return [String]
     def identify
-      'name'
+      "name"
     end
 
     # Delete Screen object using Zabbix API
@@ -40,8 +42,8 @@ class ZabbixManager
     # @raise [HttpError] Error raised when HTTP status from Zabbix Server response is not a 200 OK.
     # @return [Integer] Zabbix object id
     def delete(data)
-      result = @client.api_request(method: 'screen.delete', params: [data])
-      result.empty? ? nil : result['screenids'][0].to_i
+      result = @client.api_request(method: "screen.delete", params: [data])
+      result.empty? ? nil : result["screenids"][0].to_i
     end
 
     # Get or Create Screen object for Host using Zabbix API

data/lib/zabbix_manager/classes/scripts.rb

@@ -1,14 +1,16 @@
+# frozen_string_literal: true
+
 class ZabbixManager
   class Scripts < Basic
     def method_name
-      'script'
+      "script"
     end
 
     # The id field name used for identifying specific Screen objects via Zabbix API
     #
     # @return [String]
     def identify
-      'name'
+      "name"
     end
 
     # Submits a request to the zabbix api
@@ -20,7 +22,7 @@ class ZabbixManager
     # Returns nothing
     def execute(data)
       @client.api_request(
-        method: 'script.execute',
+        method: "script.execute",
         params: {
           scriptid: data[:scriptid],
           hostid: data[:hostid]
@@ -29,7 +31,7 @@ class ZabbixManager
     end
 
     def getscriptsbyhost(data)
-      @client.api_request(method: 'script.getscriptsbyhosts', params: data)
+      @client.api_request(method: "script.getscriptsbyhosts", params: data)
     end
   end
 end

data/lib/zabbix_manager/classes/server.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 class ZabbixManager
   class Server
     # @return [String]
@@ -10,7 +12,7 @@ class ZabbixManager
     # @return [String] Zabbix API version number
     def initialize(client)
       @client = client
-      @version = @client.api_version()
+      @version = @client.api_version
     end
   end
 end

data/lib/zabbix_manager/classes/templates.rb

@@ -1,17 +1,19 @@
+# frozen_string_literal: true
+
 class ZabbixManager
   class Templates < Basic
     # The method name used for interacting with Templates via Zabbix API
     #
     # @return [String]
     def method_name
-      'template'
+      "template"
     end
 
     # The id field name used for identifying specific Template objects via Zabbix API
     #
     # @return [String]
     def identify
-      'host'
+      "host"
     end
 
     # Delete Template object using Zabbix API
@@ -21,8 +23,8 @@ class ZabbixManager
     # @raise [HttpError] Error raised when HTTP status from Zabbix Server response is not a 200 OK.
     # @return [Integer] The Template object id that was deleted
     def delete(data)
-      result = @client.api_request(method: 'template.delete', params: [data])
-      result.empty? ? nil : result['templateids'][0].to_i
+      result = @client.api_request(method: "template.delete", params: [data])
+      result.empty? ? nil : result["templateids"][0].to_i
     end
 
     # Get Template ids for Host from Zabbix API
@@ -32,8 +34,8 @@ class ZabbixManager
     # @raise [HttpError] Error raised when HTTP status from Zabbix Server response is not a 200 OK.
     # @return [Array] Returns array of Template ids
     def get_ids_by_host(data)
-      @client.api_request(method: 'template.get', params: data).map do |tmpl|
-        tmpl['templateid']
+      @client.api_request(method: "template.get", params: data).map do |tmpl|
+        tmpl["templateid"]
       end
     end
 
@@ -58,9 +60,9 @@ class ZabbixManager
     # @return [Boolean]
     def mass_update(data)
       result = @client.api_request(
-        method: 'template.massUpdate',
+        method: "template.massUpdate",
         params: {
-          hosts:     data[:hosts_id].map { |t| { hostid: t } },
+          hosts: data[:hosts_id].map { |t| { hostid: t } },
           templates: data[:templates_id].map { |t| { templateid: t } }
         }
       )
@@ -75,9 +77,9 @@ class ZabbixManager
     # @return [Boolean]
     def mass_add(data)
       result = @client.api_request(
-        method: 'template.massAdd',
+        method: "template.massAdd",
         params: {
-          hosts:     data[:hosts_id].map { |t| { hostid: t } },
+          hosts: data[:hosts_id].map { |t| { hostid: t } },
           templates: data[:templates_id].map { |t| { templateid: t } }
         }
       )
@@ -92,12 +94,12 @@ class ZabbixManager
     # @return [Boolean]
     def mass_remove(data)
       result = @client.api_request(
-        method: 'template.massRemove',
+        method: "template.massRemove",
         params: {
-          hostids:     data[:hosts_id],
+          hostids: data[:hosts_id],
           templateids: data[:templates_id],
-          groupids:    data[:group_id],
-          force:       1
+          groupids: data[:group_id],
+          force: 1
         }
       )
       result.empty? ? false : true
@@ -107,14 +109,14 @@ class ZabbixManager
     def get_template_ids(data)
       # 直接调后端接口
       result = @client.api_request(
-        method: 'template.get',
+        method: "template.get",
         params: {
           output: "extend",
           filter: {
             host: [data].flatten
           }
         }
-      ).map { |temp| [templateid: temp['templateid']]}
+      ).map { |temp| [templateid: temp["templateid"]] }
 
       # 返回 template 模板数组对象
       result.empty? ? nil : result.flatten

data/lib/zabbix_manager/classes/triggers.rb

@@ -1,17 +1,19 @@
+# frozen_string_literal: true
+
 class ZabbixManager
   class Triggers < Basic
     # The method name used for interacting with Triggers via Zabbix API
     #
     # @return [String]
     def method_name
-      'trigger'
+      "trigger"
     end
 
     # The id field name used for identifying specific Trigger objects via Zabbix API
     #
     # @return [String]
     def identify
-      'description'
+      "description"
     end
 
     # Dump Trigger object data by key from Zabbix API
@@ -24,14 +26,14 @@ class ZabbixManager
       log "[DEBUG] Call dump_by_id with parameters: #{data.inspect}"
 
       @client.api_request(
-        method: 'trigger.get',
+        method: "trigger.get",
         params: {
           filter:           {
             keys.to_sym => data[keys.to_sym]
           },
-          output:           'extend',
-          select_items:     'extend',
-          select_functions: 'extend'
+          output:           "extend",
+          select_items:     "extend",
+          select_functions: "extend"
         }
       )
     end
@@ -51,13 +53,13 @@ class ZabbixManager
         dump = symbolize_keys(item) if item[key].to_i == data[key.to_sym].to_i
       end
 
-      expression        = dump[:items][0][:key_] + '.' + dump[:functions][0][:function] + '(' + dump[:functions][0][:parameter] + ')'
+      expression        = "#{dump[:items][0][:key_]}.#{dump[:functions][0][:function]}(#{dump[:functions][0][:parameter]})"
       dump[:expression] = dump[:expression].gsub(/\{(\d*)\}/, "{#{expression}}") # TODO: ugly regexp
       dump.delete(:functions)
       dump.delete(:items)
 
       old_expression    = data[:expression]
-      data[:expression] = data[:expression].gsub(/\{.*\:/, '{') # TODO: ugly regexp
+      data[:expression] = data[:expression].gsub(/\{.*:/, "{") # TODO: ugly regexp
       data.delete(:templateid)
 
       log "[DEBUG] expression: #{dump[:expression]}\n data: #{data[:expression]}"
@@ -68,7 +70,10 @@ class ZabbixManager
       else
         data[:expression] = old_expression
         # disable old trigger
-        log '[DEBUG] disable :' + @client.api_request(method: "#{method_name}.update", params: [{ triggerid: data[:triggerid], status: '1' }]).inspect
+        log "[DEBUG] disable :" + @client.api_request(method: "#{method_name}.update",
+                                                      params: [{
+                                                                 triggerid: data[:triggerid], status: "1"
+                                                               }]).inspect
         # create new trigger
         data.delete(:triggerid)
         create(data)
@@ -110,11 +115,10 @@ class ZabbixManager
         priority:            1,
         description:         "MOJO1",
         expression:          "{SZX1-ISP-SW7:net.if.in[ifHCInOctets.1].avg(15m)}>=450000000 or {SZX1-ISP-SW7:net.if.out[ifHCOutOctets.1].avg(15m)}>=450000000",
-        recovery_expression: "{SZX1-ISP-SW7:net.if.in[ifHCInOctets.1].avg(15m)}<=350000000 or {SZX1-ISP-SW7:net.if.out[ifHCOutOctets.1].avg(15m)}<=350000000",
+        recovery_expression: "{SZX1-ISP-SW7:net.if.in[ifHCInOctets.1].avg(15m)}<=350000000 or {SZX1-ISP-SW7:net.if.out[ifHCOutOctets.1].avg(15m)}<=350000000"
       }
 
       create_trigger data.stringify_keys!
-
     end
 
     # 设置触发器
@@ -122,7 +126,7 @@ class ZabbixManager
       data = data.with_indifferent_access
       # 请求生成触发器
       result = @client.api_request(
-        method: 'trigger.create',
+        method: "trigger.create",
         params: {
           comments:            data["comments"],
           priority:            data["priority"],
@@ -132,7 +136,7 @@ class ZabbixManager
           opdata:              data["opdata"],
           recovery_mode:       1,
           type:                0,
-          manual_close:        1,
+          manual_close:        1
         }
       )
       # 检查是是否存在
@@ -144,9 +148,9 @@ class ZabbixManager
       data = data.with_indifferent_access
       # 请求生成触发器
       result = @client.api_request(
-        method: 'trigger.update',
+        method: "trigger.update",
         params: {
-          triggerid:           triggerid.to_i,
+          triggerid:           triggerid,
           comments:            data["comments"],
           priority:            data["priority"],
           description:         data["description"],
@@ -155,12 +159,26 @@ class ZabbixManager
           opdata:              data["opdata"],
           recovery_mode:       1,
           type:                1,
-          manual_close:        1,
+          manual_close:        1
         }
       )
-      #ap result
+      # ap result
       # 检查是是否存在
       result.empty? ? nil : result["triggerids"]
     end
+
+    # 添加触发器依赖项
+    def add_trigger_dependency(triggerid, depend_on_trigger_id)
+      log "[DEBUG] Call add_trigger_dependency with parameters: #{triggerid} #{depend_on_trigger_id}"
+      # 请求生成触发器
+      result = @client.api_request(
+        method: "trigger.adddependencies",
+        params: {
+          triggerid:          triggerid,
+          dependsOnTriggerid: depend_on_trigger_id
+        }
+      )
+      result.empty? ? nil : result["triggerids"]
+    end
   end
 end

data/lib/zabbix_manager/classes/unusable.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 class ZabbixManager
   class Triggers < Basic
     def create_or_update(data)

data/lib/zabbix_manager/classes/usergroups.rb

@@ -1,24 +1,26 @@
+# frozen_string_literal: true
+
 class ZabbixManager
   class Usergroups < Basic
     # The method name used for interacting with Usergroups via Zabbix API
     #
     # @return [String]
     def method_name
-      'usergroup'
+      "usergroup"
     end
 
     # The key field name used for Usergroup objects via Zabbix API
     #
     # @return [String]
     def key
-      'usrgrpid'
+      "usrgrpid"
     end
 
     # The id field name used for identifying specific Usergroup objects via Zabbix API
     #
     # @return [String]
     def identify
-      'name'
+      "name"
     end
 
     # Set permissions for usergroup using Zabbix API
@@ -30,13 +32,13 @@ class ZabbixManager
     def permissions(data)
       permission = data[:permission] || 2
       result = @client.api_request(
-        method: 'usergroup.update',
+        method: "usergroup.update",
         params: {
           usrgrpid: data[:usrgrpid],
           rights: data[:hostgroupids].map { |t| { permission: permission, id: t } }
         }
       )
-      result ? result['usrgrpids'][0].to_i : nil
+      result ? result["usrgrpids"][0].to_i : nil
     end
 
     # Add users to usergroup using Zabbix API
@@ -60,14 +62,14 @@ class ZabbixManager
       user_groups = data[:usrgrpids].map do |t|
         {
           usrgrpid: t,
-          userids: data[:userids],
+          userids: data[:userids]
         }
       end
       result = @client.api_request(
-        method: 'usergroup.update',
-        params: user_groups,
+        method: "usergroup.update",
+        params: user_groups
       )
-      result ? result['usrgrpids'][0].to_i : nil
+      result ? result["usrgrpids"][0].to_i : nil
     end
   end
 end

data/lib/zabbix_manager/classes/usermacros.rb

@@ -1,17 +1,19 @@
+# frozen_string_literal: true
+
 class ZabbixManager
   class Usermacros < Basic
     # The id field name used for identifying specific User macro objects via Zabbix API
     #
     # @return [String]
     def identify
-      'macro'
+      "macro"
     end
 
     # The method name used for interacting with User macros via Zabbix API
     #
     # @return [String]
     def method_name
-      'usermacro'
+      "usermacro"
     end
 
     # Get User macro object id from Zabbix API based on provided data
@@ -27,11 +29,11 @@ class ZabbixManager
       data = symbolize_keys(data) if data.key?(identify)
       # raise an error if identify name was not supplied
       name = data[identify.to_sym]
-      raise ManagerError.new("#{identify} not supplied in call to get_id") if name.nil?
+      raise ManagerError, "#{identify} not supplied in call to get_id" if name.nil?
 
-      result = request(data, 'usermacro.get', 'hostmacroid')
+      result = request(data, "usermacro.get", "hostmacroid")
 
-      !result.empty? && result[0].key?('hostmacroid') ? result[0]['hostmacroid'].to_i : nil
+      !result.empty? && result[0].key?("hostmacroid") ? result[0]["hostmacroid"].to_i : nil
     end
 
     # Get Global macro object id from Zabbix API based on provided data
@@ -47,11 +49,11 @@ class ZabbixManager
       data = symbolize_keys(data) if data.key?(identify)
       # raise an error if identify name was not supplied
       name = data[identify.to_sym]
-      raise ManagerError.new("#{identify} not supplied in call to get_id_global") if name.nil?
+      raise ManagerError, "#{identify} not supplied in call to get_id_global" if name.nil?
 
-      result = request(data, 'usermacro.get', 'globalmacroid')
+      result = request(data, "usermacro.get", "globalmacroid")
 
-      !result.empty? && result[0].key?('globalmacroid') ? result[0]['globalmacroid'].to_i : nil
+      !result.empty? && result[0].key?("globalmacroid") ? result[0]["globalmacroid"].to_i : nil
     end
 
     # Get full/extended User macro data from Zabbix API
@@ -63,7 +65,7 @@ class ZabbixManager
     def get_full_data(data)
       log "[DEBUG] Call get_full_data with parameters: #{data.inspect}"
 
-      request(data, 'usermacro.get', 'hostmacroid')
+      request(data, "usermacro.get", "hostmacroid")
     end
 
     # Get full/extended Global macro data from Zabbix API
@@ -75,7 +77,7 @@ class ZabbixManager
     def get_full_data_global(data)
       log "[DEBUG] Call get_full_data_global with parameters: #{data.inspect}"
 
-      request(data, 'usermacro.get', 'globalmacroid')
+      request(data, "usermacro.get", "globalmacroid")
     end
 
     # Create new User macro object using Zabbix API (with defaults)
@@ -86,7 +88,7 @@ class ZabbixManager
     # @return [Integer] The object id if a single object is created
     # @return [Boolean] True/False if multiple objects are created
     def create(data)
-      request(data, 'usermacro.create', 'hostmacroids')
+      request(data, "usermacro.create", "hostmacroids")
     end
 
     # Create new Global macro object using Zabbix API (with defaults)
@@ -97,7 +99,7 @@ class ZabbixManager
     # @return [Integer] The object id if a single object is created
     # @return [Boolean] True/False if multiple objects are created
     def create_global(data)
-      request(data, 'usermacro.createglobal', 'globalmacroids')
+      request(data, "usermacro.createglobal", "globalmacroids")
     end
 
     # Delete User macro object using Zabbix API
@@ -109,7 +111,7 @@ class ZabbixManager
     # @return [Boolean] True/False if multiple objects are deleted
     def delete(data)
       data_delete = [data]
-      request(data_delete, 'usermacro.delete', 'hostmacroids')
+      request(data_delete, "usermacro.delete", "hostmacroids")
     end
 
     # Delete Global macro object using Zabbix API
@@ -121,7 +123,7 @@ class ZabbixManager
     # @return [Boolean] True/False if multiple objects are deleted
     def delete_global(data)
       data_delete = [data]
-      request(data_delete, 'usermacro.deleteglobal', 'globalmacroids')
+      request(data_delete, "usermacro.deleteglobal", "globalmacroids")
     end
 
     # Update User macro object using Zabbix API
@@ -133,7 +135,7 @@ class ZabbixManager
     # @return [Integer] The object id if a single object is created
     # @return [Boolean] True/False if multiple objects are created
     def update(data)
-      request(data, 'usermacro.update', 'hostmacroids')
+      request(data, "usermacro.update", "hostmacroids")
     end
 
     # Update Global macro object using Zabbix API
@@ -145,7 +147,7 @@ class ZabbixManager
     # @return [Integer] The object id if a single object is created
     # @return [Boolean] True/False if multiple objects are created
     def update_global(data)
-      request(data, 'usermacro.updateglobal', 'globalmacroids')
+      request(data, "usermacro.updateglobal", "globalmacroids")
     end
 
     # Get or Create User macro object using Zabbix API
@@ -200,29 +202,28 @@ class ZabbixManager
       globalmacroid ? update_global(data.merge(globalmacroid: globalmacroid)) : create_global(data)
     end
 
-  private
-
-    # Custom request method to handle both User and Global macros in one
-    #
-    # @param data [Hash] Needs to include macro and hostid to properly identify Global macros via Zabbix API
-    # @param method [String] Zabbix API method to use for the request
-    # @param result_key [String] Which key to use for parsing results based on User vs Global macros
-    # @raise [ManagerError] Error returned when there is a problem with the Zabbix API call.
-    # @raise [HttpError] Error raised when HTTP status from Zabbix Server response is not a 200 OK.
-    # @return [Integer] Zabbix object id
-    def request(data, method, result_key)
-      # Zabbix has different result formats for gets vs updates
-      if method.include?('.get')
-        if result_key.include?('global')
-          @client.api_request(method: method, params: { globalmacro: true, filter: data })
+    private
+      # Custom request method to handle both User and Global macros in one
+      #
+      # @param data [Hash] Needs to include macro and hostid to properly identify Global macros via Zabbix API
+      # @param method [String] Zabbix API method to use for the request
+      # @param result_key [String] Which key to use for parsing results based on User vs Global macros
+      # @raise [ManagerError] Error returned when there is a problem with the Zabbix API call.
+      # @raise [HttpError] Error raised when HTTP status from Zabbix Server response is not a 200 OK.
+      # @return [Integer] Zabbix object id
+      def request(data, method, result_key)
+        # Zabbix has different result formats for gets vs updates
+        if method.include?(".get")
+          if result_key.include?("global")
+            @client.api_request(method: method, params: { globalmacro: true, filter: data })
+          else
+            @client.api_request(method: method, params: { filter: data })
+          end
         else
-          @client.api_request(method: method, params: { filter: data })
-        end
-      else
-        result = @client.api_request(method: method, params: data)
+          result = @client.api_request(method: method, params: data)
 
-        result.key?(result_key) && !result[result_key].empty? ? result[result_key][0].to_i : nil
+          result.key?(result_key) && !result[result_key].empty? ? result[result_key][0].to_i : nil
+        end
       end
-    end
   end
 end

data/lib/zabbix_manager/classes/users.rb

@@ -1,31 +1,33 @@
+# frozen_string_literal: true
+
 class ZabbixManager
   class Users < Basic
     # The method name used for interacting with Users via Zabbix API
     #
     # @return [String]
     def method_name
-      'user'
+      "user"
     end
 
     # The keys field name used for User objects via Zabbix API
     #
     # @return [String]
     def keys
-      'userids'
+      "userids"
     end
 
     # The key field name used for User objects via Zabbix API
     #
     # @return [String]
     def key
-      'userid'
+      "userid"
     end
 
     # The id field name used for identifying specific User objects via Zabbix API
     #
     # @return [String]
     def identify
-      'alias'
+      "alias"
     end
 
     def medias_helper(data, action)
@@ -34,11 +36,11 @@ class ZabbixManager
         params: data[:userids].map do |t|
           {
             userid: t,
-            user_medias: data[:media],
+            user_medias: data[:media]
           }
-        end,
+        end
       )
-      result ? result['userids'][0].to_i : nil
+      result ? result["userids"][0].to_i : nil
     end
 
     # Add media to users using Zabbix API
@@ -48,7 +50,7 @@ class ZabbixManager
     # @raise [HttpError] Error raised when HTTP status from Zabbix Server response is not a 200 OK.
     # @return [Integer] Zabbix object id (media)
     def add_medias(data)
-      medias_helper(data, 'update')
+      medias_helper(data, "update")
     end
 
     # Update media for users using Zabbix API
@@ -58,7 +60,7 @@ class ZabbixManager
     # @raise [HttpError] Error raised when HTTP status from Zabbix Server response is not a 200 OK.
     # @return [Integer] Zabbix object id (user)
     def update_medias(data)
-      medias_helper(data, 'update')
+      medias_helper(data, "update")
     end
   end
 end

data/lib/zabbix_manager/classes/valuemaps.rb

@@ -1,24 +1,26 @@
+# frozen_string_literal: true
+
 class ZabbixManager
   class ValueMaps < Basic
     # The method name used for interacting with ValueMaps via Zabbix API
     #
     # @return [String]
     def method_name
-      'valuemap'
+      "valuemap"
     end
 
     # The key field name used for ValueMap objects via Zabbix API
     #
     # @return [String]
     def key
-      'valuemapid'
+      "valuemapid"
     end
 
     # The id field name used for identifying specific ValueMap objects via Zabbix API
     #
     # @return [String]
     def identify
-      'name'
+      "name"
     end
 
     # Get or Create ValueMap object using Zabbix API