zabbix_manager 5.0.1 → 5.0.2

data/lib/zabbix_manager/classes/events.rb

@@ -0,0 +1,18 @@
+class ZabbixManager
+  class Events < Basic
+    # The method name used for interacting with Events via Zabbix API
+    #
+    # @return [String]
+    def method_name
+      'event'
+    end
+
+    # The id field name used for identifying specific Event objects via Zabbix API
+    #
+    # @return [String]
+    def identify
+      'name'
+    end
+
+  end
+end

data/lib/zabbix_manager/classes/graphs.rb

@@ -0,0 +1,111 @@
+class ZabbixManager
+  class Graphs < Basic
+    # The method name used for interacting with Graphs via Zabbix API
+    #
+    # @return [String]
+    def method_name
+      'graph'
+    end
+
+    # The id field name used for identifying specific Graph objects via Zabbix API
+    #
+    # @return [String]
+    def identify
+      'name'
+    end
+
+    # Get full/extended Graph 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}"
+
+      @client.api_request(
+        method: "#{method_name}.get",
+        params: {
+          search: {
+            identify.to_sym => data[identify.to_sym]
+          },
+          output: 'extend'
+        }
+      )
+    end
+
+    # Get Graph ids for Host from Zabbix API
+    #
+    # @param data [Hash] Should include host value to query for matching graphs
+    # @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 [Array] Returns array of Graph ids
+    def get_ids_by_host(data)
+      result = @client.api_request(
+        method: 'graph.get',
+        params: {
+          filter: {
+            host: data[:host]
+          },
+          output: 'extend'
+        }
+      )
+
+      result.map do |graph|
+        num  = graph['graphid']
+        name = graph['name']
+        filter = data[:filter]
+
+        num if filter.nil? || /#{filter}/ =~ name
+      end.compact
+    end
+
+    # Get Graph Item object using Zabbix API
+    #
+    # @param data [Hash] Needs to include graphids to properly identify Graph Items 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 [Hash]
+    def get_items(data)
+      @client.api_request(
+        method: 'graphitem.get',
+        params: {
+          graphids: [data],
+          output: 'extend'
+        }
+      )
+    end
+
+    # Get or Create Graph object using Zabbix API
+    #
+    # @param data [Hash] Needs to include name and templateid to properly identify Graphs 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(name: data[:name], templateid: data[:templateid]))
+        id = create(data)
+      end
+
+      id
+    end
+
+    # Create or update Graph object using Zabbix API
+    #
+    # @param data [Hash] Needs to include name and templateid to properly identify Graphs 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)
+      graphid = get_id(name: data[:name], templateid: data[:templateid])
+      graphid ? _update(data.merge(graphid: graphid)) : create(data)
+    end
+
+    def _update(data)
+      data.delete(:name)
+      update(data)
+    end
+  end
+end

data/lib/zabbix_manager/classes/hostgroups.rb

@@ -0,0 +1,58 @@
+class ZabbixManager
+  class HostGroups < Basic
+    # The method name used for interacting with HostGroups via Zabbix API
+    #
+    # @return [String]
+    def method_name
+      'hostgroup'
+    end
+
+    # The id field name used for identifying specific HostGroup objects via Zabbix API
+    #
+    # @return [String]
+    def identify
+      'name'
+    end
+
+    # The key field name used for HostGroup objects via Zabbix API
+    #
+    # @return [String]
+    def key
+      'groupid'
+    end
+
+    # 新增 get_hostgroup_ids 方法，使用列表 flatten 功能拉平属组对象
+    def get_hostgroup_ids(data)
+      result = @client.api_request(
+        method: 'hostgroup.get',
+        params: {
+          output: "extend",
+          filter: {
+            name: [data].flatten
+          }
+        }
+      ).map { |item| { groupid: item['groupid'] } }
+
+      # 检查是是否存在
+      result.empty? ? nil : result.flatten
+    end
+
+    # 新增 get_or_create_hostgroups 方法，查询或创建新的对象
+    def get_or_create_hostgroups(data)
+      # 是否存在设备属组，不存在则新建
+      [data].flatten.each do |item|
+        begin
+          result = get_hostgroup_ids(item)
+          @client.api_request(
+            method: 'hostgroup.create',
+            params: {
+              name: item
+            }
+          ) if result.nil?
+        rescue => e
+          ap e
+        end
+      end
+    end
+  end
+end

data/lib/zabbix_manager/classes/hosts.rb

@@ -0,0 +1,218 @@
+class ZabbixManager
+  class Hosts < Basic
+    # The method name used for interacting with Hosts via Zabbix API
+    #
+    # @return [String]
+    def method_name
+      'host'
+    end
+
+    # The id field name used for identifying specific Host objects via Zabbix API
+    #
+    # @return [String]
+    def identify
+      'host'
+    end
+
+    # Dump Host 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: 'host.get',
+        params: {
+          filter: {
+            key.to_sym => data[key.to_sym]
+          },
+          output: 'extend',
+          # selectHosts: 'shorten'
+        }
+      )
+    end
+
+    # The default options used when creating Host objects via Zabbix API
+    #
+    # @return [Hash]
+    def default_options
+      {
+        host:           nil,
+        interfaces:     {
+          main:    1,
+          useip:   1,
+          type:    2,
+          ip:      nil,
+          dns:     "",
+          port:    161,
+          details: {
+            version:   2,
+            community: "transsion"
+          }
+        },
+        status:         0,
+        available:      1,
+        groups:         [],
+        proxy_hostid:   nil,
+        inventory_mode: 1
+      }
+    end
+
+    # Unlink/Remove Templates from Hosts using Zabbix API
+    #
+    # @param data [Hash] Should include hosts_id array and templates_id array
+    # @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 [Boolean]
+    def unlink_templates(data)
+      result = @client.api_request(
+        method: 'host.massRemove',
+        params: {
+          hostids:   data[:hosts_id],
+          templates: data[:templates_id]
+        }
+      )
+      result.empty? ? false : true
+    end
+
+    # Create or update Host object using Zabbix API
+    #
+    # @param data [Hash] Needs to include host to properly identify Hosts 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
+
+    # 根据主机 hostid 获取 interfaceid
+    def get_interface_id(hostid)
+      log "[DEBUG] Call _get_interface_id with parameters: #{hostid.inspect}"
+
+      # 请求后端接口
+      result = @client.api_request(
+        method: "hostinterface.get",
+        params: {
+          hostids: hostid
+        }
+      )
+      # 是否为空
+      result.empty? ? nil : result[0]["interfaceid"]
+    end
+
+    # 批量删除主机
+    def mojo_delete(data)
+      hostid = get_id(host: data[:host])
+      log "[DEBUG] Call get_id with parameters: #{hostid.inspect}"
+
+      result = @client.api_request(
+        method: "host.delete",
+        params: [hostid]
+      )
+
+      # 是否为空
+      if result.present?
+        p "成功移除监控主机 #{data.ip}"
+      else
+        p "未能移除监控主机 #{data.ip}"
+      end
+    end
+
+    # 测试数据
+    def update_mojo
+      data = {
+        name:           "SZX1-16-SW3111111111",
+        groups:         [
+                          {
+                            groupid: 22
+                          }
+                        ],
+        templates:      [
+                          {
+                            templateid: 10227
+                          }
+                        ],
+        inventory_mode: 1,
+        hostid:         15951
+      }
+
+      # 请求后端接口
+      @client.api_request(method: "host.update", params: data)
+    end
+
+    # 根据主机名查询 hostid
+    def get_host_id(name)
+      result = @client.api_request(
+        method: 'host.get',
+        params: {
+          output: "extend",
+          filter: {
+            host: name
+          }
+        }
+      )
+
+      # 检查是是否存在
+      result.empty? ? nil : result[0]["hostid"]
+    end
+
+    # 根据可见名称查询 hostid
+    def get_hostid_by_name(name)
+      result = @client.api_request(
+        method: 'host.get',
+        params: {
+          output: "extend",
+          filter: {
+            name: name
+          }
+        }
+      )
+
+      # 检查是是否存在
+      result.empty? ? nil : result[0]["hostid"]
+    end
+
+    # update host index to serail
+    def update_host_to_serial(data)
+      # 检索出监控对象的 hostdid
+      hostid = get_hostid_by_name(host: data[:name])
+
+      if hostid.present?
+        p "已存在监控对象，正在更新 #{data[:name]} 的索引数据 #{data[:host]}"
+        # 数据更新期间不处理模板信息 | TODO 后续需要考虑实现
+        data.delete(:templates)
+        mojo_update("host.update", data.merge(hostid: hostid))
+      else
+        p "未检索到 #{data[:host]} 监控对象"
+      end
+    end
+
+    # create_or_update
+    def create_or_update(data)
+      hostid = get_id(host: data[:host])
+      # 此处更新需要拆分为 hosts 和 interfaces 的数据更新
+      if hostid.present?
+        p "已存在监控对象，正在更新 #{data[:host]} 监控数据"
+
+        # 查询接口对象
+        interfaceid = get_interface_id(hostid)
+        # 绑定接口属性
+        interfaces               = data.delete(:interfaces)
+        interfaces[:interfaceid] = interfaceid
+
+        # 数据更新期间不处理模板信息 | TODO 后续需要考虑实现
+        data.delete(:templates)
+
+        # 分别更新接口和关联信息
+        mojo_update("hostinterface.update", interfaces)
+        mojo_update("host.update", data.merge(hostid: hostid))
+      else
+        p "正在创建 #{data[:host]} 监控对象"
+        # 新增监控对象
+        create data
+      end
+    rescue => e
+      puts "创建或新增主机 #{data[:host]} 异常，异常信息：#{e}"
+      # raise NotImplementedError
+    end
+  end
+end

data/lib/zabbix_manager/classes/httptests.rb

@@ -0,0 +1,54 @@
+class ZabbixManager
+  class HttpTests < Basic
+    # The method name used for interacting with HttpTests via Zabbix API
+    #
+    # @return [String]
+    def method_name
+      'httptest'
+    end
+
+    # The id field name used for identifying specific HttpTest objects via Zabbix API
+    #
+    # @return [String]
+    def identify
+      'name'
+    end
+
+    # The default options used when creating HttpTest objects via Zabbix API
+    #
+    # @return [Hash]
+    def default_options
+      {
+        hostid: nil,
+        name: nil,
+        steps: []
+      }
+    end
+
+    # Get or Create HttpTest object using Zabbix API
+    #
+    # @param data [Hash] Needs to include name and hostid to properly identify HttpTests 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(name: data[:name], hostid: data[:hostid]))
+        id = create(data)
+      end
+      id
+    end
+
+    # Create or update HttpTest object using Zabbix API
+    #
+    # @param data [Hash] Needs to include name and hostid to properly identify HttpTests 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)
+      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/items.rb

@@ -0,0 +1,145 @@
+class ZabbixManager
+  class Items < Basic
+    # The method name used for interacting with Items via Zabbix API
+    #
+    # @return [String]
+    def method_name
+      'item'
+    end
+
+    # The id field name used for identifying specific Item objects via Zabbix API
+    #
+    # @return [String]
+    def identify
+      'name'
+    end
+
+    # The default options used when creating Item objects via Zabbix API
+    #
+    # @return [Hash]
+    def default_options
+      {
+        name:                  nil,
+        key_:                  nil,
+        hostid:                nil,
+        delay:                 60,
+        history:               3600,
+        status:                0,
+        type:                  7,
+        snmp_community:        '',
+        snmp_oid:              '',
+        value_type:            3,
+        data_type:             0,
+        trapper_hosts:         'localhost',
+        snmp_port:             161,
+        units:                 '',
+        multiplier:            0,
+        delta:                 0,
+        snmpv3_securityname:   '',
+        snmpv3_securitylevel:  0,
+        snmpv3_authpassphrase: '',
+        snmpv3_privpassphrase: '',
+        formula:               0,
+        trends:                86400,
+        logtimefmt:            '',
+        valuemapid:            0,
+        delay_flex:            '',
+        authtype:              0,
+        username:              '',
+        password:              '',
+        publickey:             '',
+        privatekey:            '',
+        params:                '',
+        ipmi_sensor:           ''
+      }
+    end
+
+    # Get or Create Item object using Zabbix API
+    #
+    # @param data [Hash] Needs to include name and hostid to properly identify Items 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(name: data[:name], hostid: data[:hostid]))
+        id = create(data)
+      end
+      id
+    end
+
+    # Create or update Item object using Zabbix API
+    #
+    # @param data [Hash] Needs to include name and hostid to properly identify Items 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)
+      itemid = get_id(name: data[:name], hostid: data[:hostid])
+      itemid ? update(data.merge(itemid: itemid)) : create(data)
+    end
+
+    # 根据设备名称和接口名字查询监控项 | 15809 | GigabitEthernet1/0/12
+    def get_interface_items(hostid, name)
+      # 自动剔除收尾空白字串
+      iface = "Interface #{name.strip}("
+
+      # 模糊查询接口下所有监控项，同时过滤出特定的 snmp_oid
+      result = @client.api_request(
+        method: 'item.get',
+        params: {
+          # output:  ["itemid", "name", "snmp_oid", "key_", "triggerids"],
+          output:  'extend',
+          hostids: hostid,
+          search:  {
+            name: iface
+          },
+        }
+      ).select { |item| item["snmp_oid"].match?(/1.3.6.1.2.1.31.1.1.1.(6|10)./) }
+
+      # 检查是是否存在
+      result.empty? ? nil : result
+    end
+
+    # 创建单个 dns item
+    def create_dns_item(hostid, dns_name)
+      # 字串内插
+      item_name = "【DNS域名解析监控】#{dns_name}"
+      item_key_ = "net.dns.record[,#{dns_name},A,2,2]"
+
+      # 请求绑定 dns 监控项到特定的 hostid
+      result = @client.api_request(
+        method: 'item.create',
+        params: {
+          hostid: hostid,
+          name:   item_name,
+          key_:   item_key_,
+          # 代表 zabbix_agent
+          type: 0,
+          # 代表字符串
+          value_type: 1,
+          # 固定参数
+          delay:    "1m",
+          history:  "90d",
+          lifetime: "30d",
+          timeout:  "3s",
+        }
+      )
+      p "成功创建 dns监控 #{dns_name}"
+    rescue
+      p "创建 dns监控 #{dns_name} 异常"
+    end
+
+    # 查询某个监控项具体信息
+    def get_item_info
+      result = @client.api_request(
+        method: 'item.get',
+        params: {
+          output:  "extend",
+          hostids: "16914",
+        }
+      )
+    end
+  end
+end

data/lib/zabbix_manager/classes/maintenance.rb

@@ -0,0 +1,17 @@
+class ZabbixManager
+  class Maintenance < Basic
+    # The method name used for interacting with Maintenances via Zabbix API
+    #
+    # @return [String]
+    def method_name
+      'maintenance'
+    end
+
+    # The id field name used for identifying specific Maintenance objects via Zabbix API
+    #
+    # @return [String]
+    def identify
+      'name'
+    end
+  end
+end