zabbix_manager 5.0.1 → 5.0.2

data/lib/zabbix_manager/classes/triggers.rb

@@ -0,0 +1,166 @@
+class ZabbixManager
+  class Triggers < Basic
+    # The method name used for interacting with Triggers via Zabbix API
+    #
+    # @return [String]
+    def method_name
+      'trigger'
+    end
+
+    # The id field name used for identifying specific Trigger objects via Zabbix API
+    #
+    # @return [String]
+    def identify
+      'description'
+    end
+
+    # Dump Trigger object data by key from Zabbix API
+    #
+    # @param data [Hash] Should include desired object's key and value
+    # @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 [Hash]
+    def dump_by_id(data)
+      log "[DEBUG] Call dump_by_id with parameters: #{data.inspect}"
+
+      @client.api_request(
+        method: 'trigger.get',
+        params: {
+          filter:           {
+            keys.to_sym => data[keys.to_sym]
+          },
+          output:           'extend',
+          select_items:     'extend',
+          select_functions: 'extend'
+        }
+      )
+    end
+
+    # Safely update Trigger object using Zabbix API by deleting and replacing trigger
+    #
+    # @param data [Hash] Needs to include description and hostid to properly identify Triggers via Zabbix API
+    # @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 safe_update(data)
+      log "[DEBUG] Call safe_update with parameters: #{data.inspect}"
+
+      dump    = {}
+      item_id = data[key.to_sym].to_i
+      dump_by_id(key.to_sym => data[key.to_sym]).each do |item|
+        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] + ')'
+      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.delete(:templateid)
+
+      log "[DEBUG] expression: #{dump[:expression]}\n data: #{data[:expression]}"
+
+      if hash_equals?(dump, data)
+        log "[DEBUG] Equal keys #{dump} and #{data}, skip safe_update"
+        item_id
+      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
+        # create new trigger
+        data.delete(:triggerid)
+        create(data)
+      end
+    end
+
+    # Get or Create Trigger object using Zabbix API
+    #
+    # @param data [Hash] Needs to include description and hostid to properly identify Triggers via Zabbix API
+    # @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 get_or_create(data)
+      log "[DEBUG] Call get_or_create with parameters: #{data.inspect}"
+
+      unless (id = get_id(description: data[:description], hostid: data[:hostid]))
+        id = create(data)
+      end
+      id
+    end
+
+    # Create or update Trigger object using Zabbix API
+    #
+    # @param data [Hash] Needs to include description and hostid to properly identify Triggers via Zabbix API
+    # @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 create_or_update(data)
+      triggerid = get_id(description: data[:description], hostid: data[:hostid])
+
+      triggerid ? update(data.merge(triggerid: triggerid)) : create(data)
+    end
+
+    # 测试数据
+    def mojo_data
+      data = {
+        comments:            "MOJO1",
+        opdata:              "MOJO_OPDATA",
+        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",
+      }
+
+      create_trigger data.stringify_keys!
+
+    end
+
+    # 设置触发器
+    def create_trigger(data = {})
+      data = data.with_indifferent_access
+      # 请求生成触发器
+      result = @client.api_request(
+        method: 'trigger.create',
+        params: {
+          comments:            data["comments"],
+          priority:            data["priority"],
+          description:         data["description"],
+          expression:          data["expression"],
+          recovery_expression: data["recovery_expression"],
+          opdata:              data["opdata"],
+          recovery_mode:       1,
+          type:                0,
+          manual_close:        1,
+        }
+      )
+      # 检查是是否存在
+      result.empty? ? nil : result["triggerids"]
+    end
+
+    # 更新触发器
+    def update_trigger(triggerid, data = {})
+      data = data.with_indifferent_access
+      # 请求生成触发器
+      result = @client.api_request(
+        method: 'trigger.update',
+        params: {
+          triggerid:           triggerid.to_i,
+          comments:            data["comments"],
+          priority:            data["priority"],
+          description:         data["description"],
+          expression:          data["expression"],
+          recovery_expression: data["recovery_expression"],
+          opdata:              data["opdata"],
+          recovery_mode:       1,
+          type:                1,
+          manual_close:        1,
+        }
+      )
+      ap result
+      # 检查是是否存在
+      result.empty? ? nil : result["triggerids"]
+    end
+  end
+end

data/lib/zabbix_manager/classes/unusable.rb

@@ -0,0 +1,8 @@
+class ZabbixManager
+  class Triggers < Basic
+    def create_or_update(data)
+      log "[DEBUG] Call create_or_update with parameters: #{data.inspect}"
+      get_or_create(data)
+    end
+  end
+end

data/lib/zabbix_manager/classes/usergroups.rb

@@ -0,0 +1,73 @@
+class ZabbixManager
+  class Usergroups < Basic
+    # The method name used for interacting with Usergroups via Zabbix API
+    #
+    # @return [String]
+    def method_name
+      'usergroup'
+    end
+
+    # The key field name used for Usergroup objects via Zabbix API
+    #
+    # @return [String]
+    def key
+      'usrgrpid'
+    end
+
+    # The id field name used for identifying specific Usergroup objects via Zabbix API
+    #
+    # @return [String]
+    def identify
+      'name'
+    end
+
+    # Set permissions for usergroup using Zabbix API
+    #
+    # @param data [Hash] Needs to include usrgrpids and hostgroupids along with permissions to set
+    # @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 (usergroup)
+    def permissions(data)
+      permission = data[:permission] || 2
+      result = @client.api_request(
+        method: 'usergroup.update',
+        params: {
+          usrgrpid: data[:usrgrpid],
+          rights: data[:hostgroupids].map { |t| { permission: permission, id: t } }
+        }
+      )
+      result ? result['usrgrpids'][0].to_i : nil
+    end
+
+    # Add users to usergroup using Zabbix API
+    #
+    # @deprecated Zabbix has removed massAdd in favor of update.
+    # @param data [Hash] Needs to include userids and usrgrpids to mass add users to groups
+    # @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 (usergroup)
+    def add_user(data)
+      update_users(data)
+    end
+
+    # Update users in usergroups using Zabbix API
+    #
+    # @param data [Hash] Needs to include userids and usrgrpids to mass update users in groups
+    # @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 (usergroup)
+    def update_users(data)
+      user_groups = data[:usrgrpids].map do |t|
+        {
+          usrgrpid: t,
+          userids: data[:userids],
+        }
+      end
+      result = @client.api_request(
+        method: 'usergroup.update',
+        params: user_groups,
+      )
+      result ? result['usrgrpids'][0].to_i : nil
+    end
+  end
+end

data/lib/zabbix_manager/classes/usermacros.rb

@@ -0,0 +1,228 @@
+class ZabbixManager
+  class Usermacros < Basic
+    # The id field name used for identifying specific User macro objects via Zabbix API
+    #
+    # @return [String]
+    def identify
+      'macro'
+    end
+
+    # The method name used for interacting with User macros via Zabbix API
+    #
+    # @return [String]
+    def method_name
+      'usermacro'
+    end
+
+    # Get User macro object id from Zabbix API based on provided data
+    #
+    # @param data [Hash] Needs to include macro to properly identify user macros via Zabbix API
+    # @raise [ManagerError] Error returned when there is a problem with the Zabbix API call or missing object's id field name (identify).
+    # @raise [HttpError] Error raised when HTTP status from Zabbix Server response is not a 200 OK.
+    # @return [Integer] Zabbix object id
+    def get_id(data)
+      log "[DEBUG] Call get_id with parameters: #{data.inspect}"
+
+      # symbolize keys if the user used string keys instead of symbols
+      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?
+
+      result = request(data, 'usermacro.get', 'hostmacroid')
+
+      !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
+    #
+    # @param data [Hash] Needs to include macro to properly identify global macros via Zabbix API
+    # @raise [ManagerError] Error returned when there is a problem with the Zabbix API call or missing object's id field name (identify).
+    # @raise [HttpError] Error raised when HTTP status from Zabbix Server response is not a 200 OK.
+    # @return [Integer] Zabbix object id
+    def get_id_global(data)
+      log "[DEBUG] Call get_id_global with parameters: #{data.inspect}"
+
+      # symbolize keys if the user used string keys instead of symbols
+      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?
+
+      result = request(data, 'usermacro.get', 'globalmacroid')
+
+      !result.empty? && result[0].key?('globalmacroid') ? result[0]['globalmacroid'].to_i : nil
+    end
+
+    # Get full/extended User macro data from Zabbix API
+    #
+    # @param data [Hash] Should include object's id field name (identify) and id value
+    # @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 [Hash]
+    def get_full_data(data)
+      log "[DEBUG] Call get_full_data with parameters: #{data.inspect}"
+
+      request(data, 'usermacro.get', 'hostmacroid')
+    end
+
+    # Get full/extended Global macro data from Zabbix API
+    #
+    # @param data [Hash] Should include object's id field name (identify) and id value
+    # @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 [Hash]
+    def get_full_data_global(data)
+      log "[DEBUG] Call get_full_data_global with parameters: #{data.inspect}"
+
+      request(data, 'usermacro.get', 'globalmacroid')
+    end
+
+    # Create new User macro object using Zabbix API (with defaults)
+    #
+    # @param data [Hash] Needs to include hostid, macro, and value to create User macro via Zabbix API
+    # @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] 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')
+    end
+
+    # Create new Global macro object using Zabbix API (with defaults)
+    #
+    # @param data [Hash] Needs to include hostid, macro, and value to create Global macro via Zabbix API
+    # @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] 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')
+    end
+
+    # Delete User macro object using Zabbix API
+    #
+    # @param data [Hash] Should include hostmacroid's of User macros to delete
+    # @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] The object id if a single object is deleted
+    # @return [Boolean] True/False if multiple objects are deleted
+    def delete(data)
+      data_delete = [data]
+      request(data_delete, 'usermacro.delete', 'hostmacroids')
+    end
+
+    # Delete Global macro object using Zabbix API
+    #
+    # @param data [Hash] Should include hostmacroid's of Global macros to delete
+    # @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] The object id if a single object is deleted
+    # @return [Boolean] True/False if multiple objects are deleted
+    def delete_global(data)
+      data_delete = [data]
+      request(data_delete, 'usermacro.deleteglobal', 'globalmacroids')
+    end
+
+    # Update User macro object using Zabbix API
+    #
+    # @param data [Hash] Should include object's id field name (identify), id value, and fields to update
+    # @param force [Boolean] Whether to force an object update even if provided data matches Zabbix
+    # @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] 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')
+    end
+
+    # Update Global macro object using Zabbix API
+    #
+    # @param data [Hash] Should include object's id field name (identify), id value, and fields to update
+    # @param force [Boolean] Whether to force an object update even if provided data matches Zabbix
+    # @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] 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')
+    end
+
+    # Get or Create User macro object using Zabbix API
+    #
+    # @param data [Hash] Needs to include macro and hostid to properly identify User macros via Zabbix API
+    # @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 get_or_create(data)
+      log "[DEBUG] Call get_or_create with parameters: #{data.inspect}"
+
+      unless (id = get_id(macro: data[:macro], hostid: data[:hostid]))
+        id = create(data)
+      end
+      id
+    end
+
+    # Get or Create Global macro object using Zabbix API
+    #
+    # @param data [Hash] Needs to include macro and hostid to properly identify Global macros via Zabbix API
+    # @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 get_or_create_global(data)
+      log "[DEBUG] Call get_or_create_global with parameters: #{data.inspect}"
+
+      unless (id = get_id_global(macro: data[:macro], hostid: data[:hostid]))
+        id = create_global(data)
+      end
+      id
+    end
+
+    # Create or update User macro object using Zabbix API
+    #
+    # @param data [Hash] Needs to include macro and hostid to properly identify User macros via Zabbix API
+    # @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 create_or_update(data)
+      hostmacroid = get_id(macro: data[:macro], hostid: data[:hostid])
+      hostmacroid ? update(data.merge(hostmacroid: hostmacroid)) : create(data)
+    end
+
+    # Create or update Global macro object using Zabbix API
+    #
+    # @param data [Hash] Needs to include macro and hostid to properly identify Global macros via Zabbix API
+    # @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 create_or_update_global(data)
+      globalmacroid = get_id_global(macro: data[:macro], hostid: data[:hostid])
+      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 })
+        else
+          @client.api_request(method: method, params: { filter: data })
+        end
+      else
+        result = @client.api_request(method: method, params: data)
+
+        result.key?(result_key) && !result[result_key].empty? ? result[result_key][0].to_i : nil
+      end
+    end
+  end
+end

data/lib/zabbix_manager/classes/users.rb

@@ -0,0 +1,64 @@
+class ZabbixManager
+  class Users < Basic
+    # The method name used for interacting with Users via Zabbix API
+    #
+    # @return [String]
+    def method_name
+      'user'
+    end
+
+    # The keys field name used for User objects via Zabbix API
+    #
+    # @return [String]
+    def keys
+      'userids'
+    end
+
+    # The key field name used for User objects via Zabbix API
+    #
+    # @return [String]
+    def key
+      'userid'
+    end
+
+    # The id field name used for identifying specific User objects via Zabbix API
+    #
+    # @return [String]
+    def identify
+      'alias'
+    end
+
+    def medias_helper(data, action)
+      result = @client.api_request(
+        method: "user.#{action}",
+        params: data[:userids].map do |t|
+          {
+            userid: t,
+            user_medias: data[:media],
+          }
+        end,
+      )
+      result ? result['userids'][0].to_i : nil
+    end
+
+    # Add media to users using Zabbix API
+    #
+    # @param data [Hash] Needs to include userids and media to mass add media to users
+    # @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 (media)
+    def add_medias(data)
+      medias_helper(data, 'update')
+    end
+
+    # Update media for users using Zabbix API
+    #
+    # @param data [Hash] Needs to include userids and media to mass update media for users
+    # @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 (user)
+    def update_medias(data)
+      medias_helper(data, 'update')
+    end
+  end
+end

data/lib/zabbix_manager/classes/valuemaps.rb

@@ -0,0 +1,50 @@
+class ZabbixManager
+  class ValueMaps < Basic
+    # The method name used for interacting with ValueMaps via Zabbix API
+    #
+    # @return [String]
+    def method_name
+      'valuemap'
+    end
+
+    # The key field name used for ValueMap objects via Zabbix API
+    #
+    # @return [String]
+    def key
+      'valuemapid'
+    end
+
+    # The id field name used for identifying specific ValueMap objects via Zabbix API
+    #
+    # @return [String]
+    def identify
+      'name'
+    end
+
+    # Get or Create ValueMap object using Zabbix API
+    #
+    # @param data [Hash] Needs to include valuemapids [List] to properly identify ValueMaps via Zabbix API
+    # @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 get_or_create(data)
+      log "[DEBUG] Call get_or_create with parameters: #{data.inspect}"
+
+      unless (id = get_id(valuemapids: data[:valuemapids]))
+        id = create(data)
+      end
+      id
+    end
+
+    # Create or update Item object using Zabbix API
+    #
+    # @param data [Hash] Needs to include valuemapids to properly identify ValueMaps via Zabbix API
+    # @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 create_or_update(data)
+      valuemapid = get_id(name: data[:name])
+      valuemapid ? update(data.merge(valuemapids: [:valuemapid])) : create(data)
+    end
+  end
+end