zabbix_manager 5.1.5 → 6.0.0

data/lib/zabbix_manager/basic/basic_logic.rb

@@ -1,195 +0,0 @@
-# frozen_string_literal: true
-
-class ZabbixManager
-  class Basic
-    # 使用 API 新增 Zabbix 监控对象（使用默认值）
-    def create(data)
-      log "[DEBUG] 调用 #{method_name}.create，参数: #{data.inspect}"
-
-      params = default_options.merge(data)
-      result = @client.api_request(method: "#{method_name}.create", params: params)
-      parse_keys result
-    end
-
-    # 使用 API 更新 Zabbix 监控对象
-    def update(data, force = false)
-      log "[DEBUG] 调用 #{method_name}.update，参数: #{data.inspect}"
-
-      dump = {}
-      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
-      if hash_equals?(dump, data) && !force
-        log "[DEBUG] 系统以有数据 #{dump} 和 待更新的数据 #{data} 相同，跳过本次更新"
-        data[key.to_sym].to_i
-      else
-        result = @client.api_request(method: "#{method_name}.update", params: data)
-        parse_keys result
-      end
-    end
-
-    # 使用 API 删除 Zabbix 监控对象
-    def delete(data)
-      log "[DEBUG] 调用 #{method_name}.delete，参数: #{data.inspect}"
-
-      result = @client.api_request(method: "#{method_name}.delete", params: [data].flatten)
-      parse_keys result
-    end
-
-    # 使用 API 获取或创建 Zabbix 监控对象
-    def get_or_create(data)
-      log "[DEBUG] 调用 #{method_name}.get_or_create，参数: #{data.inspect}"
-
-      if (id = get_id(identify.to_sym => data[identify.to_sym]))
-        id
-      else
-        create(data)
-      end
-    end
-
-    # 使用 API 批量获取或创建 Zabbix 监控对象
-    def get_or_create_keys(data)
-      log "[DEBUG] 调用 #{method_name}.get_or_create_keys，参数: #{data.inspect}"
-
-      ids = []
-      [data].flatten.each do |item|
-        if (id = get_or_create(item))
-          ids << { key.to_sym => id }
-        end
-      end
-      ids
-    end
-
-    # 使用 API 创建或更新 Zabbix 监控对象
-    def create_or_update(data)
-      log "[DEBUG] 调用 #{method_name}.create_or_update，参数: #{data.inspect}"
-
-      id = get_id(identify.to_sym => data[identify.to_sym])
-      id ? update(data.merge(key.to_sym => id.to_s)) : create(data)
-    end
-
-    # 使用 API 基于 key 打印 Zabbix 监控对象详情
-    def dump_by_id(data)
-      log "[DEBUG] 调用 #{method_name}.dump_by_id，参数: #{data.inspect}"
-
-      get_raw(
-        {
-          filter: {
-            key.to_sym => data[key.to_sym]
-          },
-          output: "extend"
-        }
-      )
-    end
-
-    # 使用 API 基于提供的数据查询 Zabbix 监控对象 id
-    def get_id(data)
-      log "[DEBUG] 调用 #{method_name}.get_id，参数: #{data.inspect}"
-
-      data = symbolize_keys(data) if data.key?(identify)
-      name = data[identify.to_sym]
-      raise ZbxError, "在调用 get_id 时未提供 identify #{identify}" if name.nil?
-
-      # 输出信息截取 key identify
-      result = get_raw(
-        {
-          filter: data,
-          output: [key, identify]
-        }
-      )
-
-      result.find { |item| item[identify] == data[identify.to_sym] }&.[](key)&.to_i
-    end
-
-    # 使用 API 基于提供的数据查询 Zabbix 监控对象 ids
-    def get_ids(data)
-      log "[DEBUG] 调用 #{method_name}.get_ids，参数: #{data.inspect}"
-
-      ids = []
-      [data].flatten.each do |item|
-        if (id = get_id(item))
-          ids << id
-        end
-      end
-      ids
-    end
-
-    # 使用 API 基于提供的数据查询 Zabbix 监控对象 id
-    def get_key_ids(data)
-      log "[DEBUG] 调用 #{method_name}.get_key_ids，参数: #{data.inspect}"
-
-      ids = []
-      [data].flatten.each do |item|
-        if (id = get_id(item))
-          ids << { key.to_sym => id }
-        end
-      end
-      ids
-    end
-
-    # 使用 API 基于 name 查询 Zabbix 监控对象 id
-    def get_ids_by_identify(data)
-      log "[DEBUG] 调用 #{method_name}.get_ids_by_identify，参数: #{data.inspect}"
-
-      result = get_raw(
-        {
-          filter: { identify.to_sym => [data].flatten },
-          output: [key]
-        }
-      )
-      result.empty? ? nil : result.map { |i| i[key] }
-    end
-
-    # 使用 API 基于 name 查询 Zabbix 监控对象 id
-    def get_key_ids_by_identify(data)
-      log "[DEBUG] 调用 #{method_name}.get_key_ids_by_identify，参数: #{data.inspect}"
-
-      result = get_raw(
-        {
-          filter: { identify.to_sym => [data].flatten },
-          output: [key]
-        }
-      )
-      result.empty? ? nil : result.map { |i| { key.to_sym => i[key] } }
-    end
-
-    # 使用 API 查询所有 Zabbix 监控对象的详细信息
-    def all
-      result = {}
-      get_raw({ output: "extend" }).each do |item|
-        result[item[identify]] = item[key]
-      end
-      result
-    end
-
-    # 使用 API 查询 Zabbix 监控对象的详细信息
-    def get_full_data(data)
-      log "[DEBUG] 调用 #{method_name}.get_full_data，参数: #{data.inspect}"
-
-      get_raw(
-        {
-          filter: {
-            identify.to_sym => data[identify.to_sym]
-          },
-          output: "extend"
-        }
-      )
-    end
-
-    # 使用 API 查询 Zabbix 监控对象的原始数据
-    def get_raw(data)
-      @client.api_request(
-        method: "#{method_name}.get",
-        params: data
-      )
-    end
-
-    # 使用 API 查询 Zabbix 监控对象的原始数据
-    def request_raw(method, data)
-      @client.api_request(
-        method: method,
-        params: data
-      )
-    end
-  end
-end

data/lib/zabbix_manager/classes/drules.rb

@@ -1,41 +0,0 @@
-# frozen_string_literal: true
-
-class ZabbixManager
-  class Drules < Basic
-    # 用于通过 Zabbix API 与 Drules 交互的方法名称
-    def method_name
-      "drule"
-    end
-
-    # 用于通过 Zabbix API 标识特定 Drule 对象的 id 字段名称
-    def identify
-      "name"
-    end
-
-    # 创建 Drule 对象时使用的默认选项
-    def default_options
-      {
-        name:    nil,
-        iprange: nil,
-        delay:   3600,
-        status:  0
-      }
-    end
-
-    # 通过 Zabbix API 获取或创建 Drule 对象
-    def get_or_create(data)
-      log "[DEBUG] 调用 get_or_create，参数为：#{data.inspect}"
-
-      unless (id = get_id(name: data[:name]))
-        id = create(data)
-      end
-      id
-    end
-
-    # 通过 Zabbix API 创建或更新 Drule 对象
-    def create_or_update(data)
-      druleid = get_id(name: data[:name])
-      druleid ? update(data.merge(druleid: druleid)) : create(data)
-    end
-  end
-end

data/lib/zabbix_manager/classes/hostgroups.rb

@@ -1,20 +0,0 @@
-# frozen_string_literal: true
-
-class ZabbixManager
-  class HostGroups < Basic
-    # 用于通过 Zabbix API 与 HostGroups 交互的方法名称
-    def method_name
-      "hostgroup"
-    end
-
-    # 用于通过 Zabbix API 标识特定 HostGroup 对象的 id 字段名称
-    def identify
-      "name"
-    end
-
-    # HostGroup 对象通过 Zabbix API 使用的 key 字段名称
-    def key
-      "groupid"
-    end
-  end
-end

data/lib/zabbix_manager/classes/hostinterfaces.rb

@@ -1,29 +0,0 @@
-# frozen_string_literal: true
-
-class ZabbixManager
-  class HostInterfaces < Basic
-    # 用于通过 Zabbix API 与 HostInterfaces 交互的方法名称
-    def method_name
-      "hostinterface"
-    end
-
-    # 用于通过 Zabbix API 标识特定 HostInterface 对象的 id 字段名称
-    def identify
-      "hostids"
-    end
-
-    # HostInterface 对象通过 Zabbix API 使用的 key 字段名称
-    def key
-      "interfaceid"
-    end
-
-    # 通过 Zabbix API 基于提供的 hostid 获取 Zabbix interface 的 id
-    # @note 基于 hostid 查询关联的 Interfaceid
-    def get_interfaceid(hostid)
-      result = get_raw({ output: key, identify.to_sym => hostid })
-
-      # 如果查询结果不为空，且第一个元素不为空，则继续获取 {interfaceid} 并转换为整数
-      result&.[](0)&.[](key)&.to_i
-    end
-  end
-end

data/lib/zabbix_manager/classes/httptests.rb

@@ -1,40 +0,0 @@
-# frozen_string_literal: true
-
-class ZabbixManager
-  class HttpTests < Basic
-    # 用于通过 Zabbix API 与 HttpTests 交互的方法名称
-    def method_name
-      "httptest"
-    end
-
-    # 用于通过 Zabbix API 标识特定 HttpTest 对象的 id 字段名称
-    def identify
-      "name"
-    end
-
-    # 通过 Zabbix API 创建 HttpTest 对象时使用的默认选项
-    def default_options
-      {
-        hostid: nil,
-        name:   nil,
-        steps:  []
-      }
-    end
-
-    # 通过 Zabbix API 获取或创建 HttpTest 对象
-    def get_or_create(data)
-      log "[DEBUG] 使用参数调用 get_or_create: #{data.inspect}"
-
-      unless (id = get_id(name: data[:name], hostid: data[:hostid]))
-        id = create(data)
-      end
-      id
-    end
-
-    # 通过 Zabbix API 创建或更新 HttpTest 对象
-    def create_or_update(data)
-      httptestid = get_id(name: data[:name], hostid: data[:hostid])
-      httptestid ? update(data.merge(httptestid: httptestid)) : create(data)
-    end
-  end
-end

data/lib/zabbix_manager/classes/mediatypes.rb

@@ -1,79 +0,0 @@
-# frozen_string_literal: true
-
-class ZabbixManager
-  class Mediatypes < Basic
-    # 与 Zabbix API 交互的媒体类型方法名称
-    def method_name
-      "mediatype"
-    end
-
-    # 识别特定媒体类型对象的 id 字段名称
-    def identify
-      "name"
-    end
-
-    # 默认选项，用于通过 Zabbix API 创建媒体类型对象
-    def default_options
-      {
-        name: "", # 媒体类型名称
-        description: "", # 描述
-        type: 0, # 0 - 电子邮件，1 - 外部脚本，2 - 短信，3 - Jabber，100 - EzTexting
-        smtp_server: "",
-        smtp_helo: "",
-        smtp_email: "", # Zabbix 服务器的电子邮件地址
-        exec_path: "",  # 外部脚本的名称
-        gsm_modem: "",  # GSM modem 的串口设备名称
-        username: "", # Zabbix 服务器使用的 Jabber 用户名
-        passwd: "" # Zabbix 服务器使用的 Jabber 密码
-      }
-    end
-
-    # 使用 API 更新媒体类型对象
-    def update(data, force = false)
-      log "[DEBUG] 调用 update 方法，参数: #{data.inspect}"
-      if data[key.to_sym].nil?
-        data[key.to_sym] = get_id(data)
-        log "[DEBUG] 用 ID 丰富数据: #{data.inspect}"
-      end
-      dump = {}
-      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
-      if hash_equals?(dump, data) && !force
-        log "[DEBUG] 键 #{dump} 和 #{data} 相等，跳过更新"
-        data[key.to_sym].to_i
-      else
-        data_update = [data]
-        result = @client.api_request(method: "#{method_name}.update", params: data_update)
-        parse_keys result
-      end
-    end
-
-    # 从 API 获取媒体类型对象的 id
-    def get_id(data)
-      log "[DEBUG] 调用 get_id 方法，参数: #{data.inspect}"
-      data = symbolize_keys(data) if data.key?(identify)
-      name = data[identify.to_sym]
-      raise ZbxError, "未提供 #{identify} 参数，#{data} (#{method_name})" if name.nil?
-
-      result = @client.api_request(
-        method: "#{method_name}.get",
-        params: {
-          filter: { name: name },
-          output: [key, identify]
-        }
-      )
-      id = nil
-      result.each { |item| id = item[key].to_i if item[identify] == data[identify.to_sym] }
-      id
-    end
-
-    # 创建或更新媒体类型对象
-    def create_or_update(data)
-      log "[DEBUG] 调用 create_or_update 方法，参数: #{data.inspect}"
-
-      id = get_id(identify.to_sym => data[identify.to_sym])
-      id ? update(data.merge(key.to_sym => id.to_s)) : create(data)
-    end
-  end
-end

data/lib/zabbix_manager/classes/unusable.rb

@@ -1,11 +0,0 @@
-# frozen_string_literal: true
-
-class ZabbixManager
-  class Triggers < Basic
-    # 使用 Zabbix API 创建或更新触发器对象
-    def create_or_update(data)
-      log "[DEBUG] 调用 create_or_update 方法，参数: #{data.inspect}"
-      get_or_create(data)
-    end
-  end
-end

data/lib/zabbix_manager/classes/usergroups.rb

@@ -1,53 +0,0 @@
-# frozen_string_literal: true
-
-class ZabbixManager
-  class Usergroups < Basic
-    # 用于通过 Zabbix API 与 Usergroups 交互的方法名称
-    def method_name
-      "usergroup"
-    end
-
-    # 用于 Usergroup 对象通过 Zabbix API 的键字段名称
-    def key
-      "usrgrpid"
-    end
-
-    # 用于通过 Zabbix API 识别特定 Usergroup 对象的 id 字段名称
-    def identify
-      "name"
-    end
-
-    # 使用 Zabbix API 设置用户组的权限
-    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
-
-    # 使用 Zabbix API 将用户添加到用户组
-    def add_user(data)
-      update_users(data)
-    end
-
-    # 使用 Zabbix API 更新用户组中的用户
-    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

@@ -1,136 +0,0 @@
-# frozen_string_literal: true
-
-class ZabbixManager
-  class Usermacros < Basic
-    # 用于通过 Zabbix API 识别特定 User 宏对象的 id 字段名称
-    def identify
-      "macro"
-    end
-
-    # 用于通过 Zabbix API 与 User 宏交互的方法名称
-    def method_name
-      "usermacro"
-    end
-
-    # 通过 Zabbix API 根据提供的数据获取 User 宏对象的 id
-    def get_id(data)
-      log "[DEBUG] Call get_id with parameters: #{data.inspect}"
-
-      data = symbolize_keys(data) if data.key?(identify)
-      name = data[identify.to_sym]
-      raise ZbxError, "#{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
-
-    # 通过 Zabbix API 根据提供的数据获取 Global 宏对象的 id
-    def get_id_global(data)
-      log "[DEBUG] Call get_id_global with parameters: #{data.inspect}"
-
-      data = symbolize_keys(data) if data.key?(identify)
-      name = data[identify.to_sym]
-      raise ZbxError, "#{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
-
-    # 通过 Zabbix API 获取完整/扩展的 User 宏数据
-    def get_full_data(data)
-      log "[DEBUG] Call get_full_data with parameters: #{data.inspect}"
-
-      request(data, "usermacro.get", "hostmacroid")
-    end
-
-    # 通过 Zabbix API 获取完整/扩展的 Global 宏数据
-    def get_full_data_global(data)
-      log "[DEBUG] Call get_full_data_global with parameters: #{data.inspect}"
-
-      request(data, "usermacro.get", "globalmacroid")
-    end
-
-    # 通过 Zabbix API 创建新的 User 宏对象（使用默认值）
-    def create(data)
-      request(data, "usermacro.create", "hostmacroids")
-    end
-
-    # 通过 Zabbix API 创建新的 Global 宏对象（使用默认值）
-    def create_global(data)
-      request(data, "usermacro.createglobal", "globalmacroids")
-    end
-
-    # 通过 Zabbix API 删除 User 宏对象
-    def delete(data)
-      data_delete = [data]
-      request(data_delete, "usermacro.delete", "hostmacroids")
-    end
-
-    # 通过 Zabbix API 删除 Global 宏对象
-    def delete_global(data)
-      data_delete = [data]
-      request(data_delete, "usermacro.deleteglobal", "globalmacroids")
-    end
-
-    # 通过 Zabbix API 更新 User 宏对象
-    def update(data)
-      request(data, "usermacro.update", "hostmacroids")
-    end
-
-    # 通过 Zabbix API 更新 Global 宏对象
-    def update_global(data)
-      request(data, "usermacro.updateglobal", "globalmacroids")
-    end
-
-    # 通过 Zabbix API 获取或创建 User 宏对象
-    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
-
-    # 通过 Zabbix API 获取或创建 Global 宏对象
-    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
-
-    # 通过 Zabbix API 创建或更新 User 宏对象
-    def create_or_update(data)
-      hostmacroid = get_id(macro: data[:macro], hostid: data[:hostid])
-      hostmacroid ? update(data.merge(hostmacroid: hostmacroid)) : create(data)
-    end
-
-    # 通过 Zabbix API 创建或更新 Global 宏对象
-    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
-
-    # 自定义请求方法，以处理 User 和 Global 宏
-    def request(data, method, result_key)
-      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/valuemaps.rb

@@ -1,32 +0,0 @@
-# frozen_string_literal: true
-
-class ZabbixManager
-  class ValueMaps < Basic
-    # 用于通过 Zabbix API 与 ValueMaps 交互的方法名称
-    def method_name
-      "valuemap"
-    end
-
-    # 用于通过 Zabbix API 识别特定 ValueMap 对象的 id 字段名称
-    def identify
-      "name"
-    end
-
-    # 通过 Zabbix API 获取或创建 ValueMap 对象
-    def get_or_create(data)
-      log "[DEBUG] 调用 get_or_create 方法，参数: #{data.inspect}"
-
-      if (id = get_id(valuemapids: data[:valuemapids]))
-        id
-      else
-        create(data)
-      end
-    end
-
-    # 通过 Zabbix API 创建或更新 Item 对象
-    def create_or_update(data)
-      valuemapid = get_id(name: data[:name])
-      valuemapid ? update(data.merge(valuemapids: [:valuemapid])) : create(data)
-    end
-  end
-end