zabbix_manager 5.0.1 → 5.0.2

data/lib/zabbix_manager/classes/mediatypes.rb

@@ -0,0 +1,109 @@
+class ZabbixManager
+  class Mediatypes < Basic
+    # The method name used for interacting with MediaTypes via Zabbix API
+    #
+    # @return [String]
+    def method_name
+      'mediatype'
+    end
+
+    # The id field name used for identifying specific MediaType objects via Zabbix API
+    #
+    # @return [String]
+    def identify
+      'name'
+    end
+
+    # The default options used when creating MediaType objects via Zabbix API
+    #
+    # @return [Hash]
+    def default_options
+      {
+        name: '', # Name
+        description: '', # Description
+        type: 0, # 0 - Email, 1 - External script, 2 - SMS, 3 - Jabber, 100 - EzTexting
+        smtp_server: '',
+        smtp_helo: '',
+        smtp_email: '', # Email address of Zabbix server
+        exec_path: '',  # Name of external script
+        gsm_modem: '',  # Serial device name of GSM modem
+        username: '', # Jabber user name used by Zabbix server
+        passwd: '' # Jabber password used by Zabbix server
+      }
+    end
+
+    # def log(message)
+    #   STDERR.puts
+    #   STDERR.puts message.to_s
+    #   STDERR.puts
+    # end
+
+    # Update MediaType object using API
+    #
+    # @param data [Hash] Should include object's id field name (identify) and id value
+    # @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, force = false)
+      log "[DEBUG] Call update with parameters: #{data.inspect}"
+      if data[key.to_sym].nil?
+        data[key.to_sym] = get_id(data)
+        log "[DEBUG] Enriched data with 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] Equal keys #{dump} and #{data}, skip update"
+        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
+
+    # Get MediaType object id from API based on provided data
+    #
+    # @param data [Hash]
+    # @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, #{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
+
+    # Create or update MediaType object using 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 [Integer] The object id if a single object is created
+    # @return [Boolean] True/False if multiple objects are created
+    def create_or_update(data)
+      log "[DEBUG] Call create_or_update with parameters: #{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/problems.rb

@@ -0,0 +1,133 @@
+class ZabbixManager
+  class Problems < Basic
+    # The method name used for interacting with Hosts via Zabbix API
+    #
+    # @return [String]
+    def method_name
+      'problem'
+    end
+
+    # The id field name used for identifying specific Problem objects via Zabbix API
+    #
+    # @return [String]
+    def identify
+      'name'
+    end
+
+    # The key field name used for Problem objects via Zabbix API
+    # However, Problem object does not have a unique identifier
+    #
+    # @return [String]
+    def key
+      'problemid'
+    end
+
+    # Returns the object's plural id field name (identify) based on key
+    # However, Problem object does not have a unique identifier
+    #
+    # @return [String]
+    def keys
+      'problemids'
+    end
+
+    # Dump Problem 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: 'problem.get',
+        params: {
+          filter: {
+            identify.to_sym => data[identify.to_sym]
+          },
+          output: 'extend'
+        }
+      )
+    end
+
+    # Get full/extended Problem 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}"
+
+      data = symbolize_keys(data)
+
+      @client.api_request(
+        method: "#{method_name}.get",
+        params: {
+          filter:                {
+            identify.to_sym => data[identify.to_sym]
+          },
+          eventids:              data[:eventids] || nil,
+          groupids:              data[:groupids] || nil,
+          hostids:               data[:hostids] || nil,
+          objectids:             data[:objectids] || nil,
+          applicationids:        data[:applicationids] || nil,
+          tags:                  data[:tags] || nil,
+          time_from:             data[:time_from] || nil,
+          time_till:             data[:time_till] || nil,
+          eventid_from:          data[:eventid_from] || nil,
+          eventid_till:          data[:eventid_till] || nil,
+          recent:                data[:recent] || false,
+          sortfield:             data[:sortfield] || ['eventid'],
+          sortorder:             data[:sortorder] || 'DESC',
+          countOutput:           data[:countOutput] || nil,
+          output:                'extend',
+          selectAcknowledges:    'extend',
+          selectTags:            'extend',
+          selectSuppressionData: 'extend'
+        }
+      )
+    end
+
+    # Get full/extended Zabbix data for Problem objects from 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 [Array<Hash>] Array of matching objects
+    def all
+      get_full_data({})
+    end
+
+    def remove_problem
+      # 设置时间区间
+      time_from = 180.days.ago.at_beginning_of_day.to_i
+      time_till = 14.days.ago.at_beginning_of_day.to_i
+
+      # 抓取制定区间的数据
+      data      = get_full_data(time_from: time_from, time_till: time_till)
+      event_ids = []
+
+      # 收集所有的 eventid
+      data.each do |item|
+        event_ids << item["eventid"]
+      end
+
+      # 返回 event_ids
+      ack_event event_ids
+    end
+
+    def ack_event(eventids)
+      # 请求后端
+      result = @client.api_request(
+        method: "event.acknowledge",
+        params: {
+          eventids: eventids,
+          action:   2,
+          message:  "由 RUBY SCRIPT 自动关闭"
+        }
+      )
+      # 返回运行结果
+      result
+    end
+  end
+end

data/lib/zabbix_manager/classes/proxies.rb

@@ -0,0 +1,68 @@
+class ZabbixManager
+  class Proxies < Basic
+    # The method name used for interacting with Proxies via Zabbix API
+    #
+    # @return [String]
+    def method_name
+      'proxy'
+    end
+
+    # The id field name used for identifying specific Proxy objects via Zabbix API
+    #
+    # @return [String]
+    def identify
+      'host'
+    end
+
+    # Delete Proxy object using Zabbix API
+    #
+    # @param data [Array] Should include array of proxyid's
+    # @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 Proxy object id that was deleted
+    def delete(data)
+      result = @client.api_request(method: 'proxy.delete', params: data)
+      result.empty? ? nil : result['proxyids'][0].to_i
+    end
+
+    # Check if a Proxy object is readable using Zabbix API
+    #
+    # @param data [Array] Should include array of proxyid's
+    # @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] Returns true if the given proxies are readable
+    def isreadable(data)
+      @client.api_request(method: 'proxy.isreadable', params: data)
+    end
+
+    # Check if a Proxy object is writable using Zabbix API
+    #
+    # @param data [Array] Should include array of proxyid's
+    # @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] Returns true if the given proxies are writable
+    def iswritable(data)
+      @client.api_request(method: 'proxy.iswritable', params: data)
+    end
+
+    # 新增代理服务器查询接口
+    def get_proxy_id(proxy)
+      # 边界条件判断
+      return nil if proxy.nil?
+
+      # 请求后端接口，只支持单个代理节点
+      result = @client.api_request(
+        method: 'proxy.get',
+        params: {
+          output: "extend",
+          filter: {
+            host: proxy
+          }
+        }
+      )
+
+      # 返回代理节点
+      result.empty? ? nil : result[0]["proxyid"]
+    end
+  end
+end

data/lib/zabbix_manager/classes/roles.rb

@@ -0,0 +1,114 @@
+class ZabbixManager
+  class Roles < Basic
+    # The method name used for interacting with Role via Zabbix API
+    #
+    # @return [String]
+    def method_name
+      'role'
+    end
+
+    # The key field name used for Role objects via Zabbix API
+    #
+    # @return [String]
+    def key
+      'roleid'
+    end
+
+    # The id field name used for identifying specific Role 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 rules(data)
+      rules = data[:rules] || 2
+      result = @client.api_request(
+        method: 'role.update',
+        params: {
+          roleid: data[:roleid],
+          rules: 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
+
+    # Dump Role 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: 'role.get',
+        params: {
+          output: 'extend',
+          selectRules: 'extend',
+          roleids: data[:id]
+        }
+      )
+    end
+
+    # Get Role ids by Role Name 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_name(data)
+      result = @client.api_request(
+        method: 'role.get',
+        params: {
+          filter: {
+            name: data[:name]
+          },
+          output: 'extend'
+        }
+      )
+
+      result.map do |rule|
+        rule['roleid']
+      end.compact
+    end
+
+    # Update users in Userroles 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/screens.rb

@@ -0,0 +1,94 @@
+class ZabbixManager
+  class Screens < Basic
+    # extracted from frontends/php/include/defines.inc.php
+    # SCREEN_RESOURCE_GRAPH => 0,
+    # SCREEN_RESOURCE_SIMPLE_GRAPH => 1,
+    # SCREEN_RESOURCE_MAP => 2,
+    # SCREEN_RESOURCE_PLAIN_TEXT => 3,
+    # SCREEN_RESOURCE_HOSTS_INFO => 4,
+    # SCREEN_RESOURCE_TRIGGERS_INFO => 5,
+    # SCREEN_RESOURCE_SERVER_INFO => 6,
+    # SCREEN_RESOURCE_CLOCK => 7,
+    # SCREEN_RESOURCE_SCREEN => 8,
+    # SCREEN_RESOURCE_TRIGGERS_OVERVIEW => 9,
+    # SCREEN_RESOURCE_DATA_OVERVIEW => 10,
+    # SCREEN_RESOURCE_URL => 11,
+    # SCREEN_RESOURCE_ACTIONS => 12,
+    # SCREEN_RESOURCE_EVENTS => 13,
+    # SCREEN_RESOURCE_HOSTGROUP_TRIGGERS => 14,
+    # SCREEN_RESOURCE_SYSTEM_STATUS => 15,
+    # SCREEN_RESOURCE_HOST_TRIGGERS => 16
+
+    # The method name used for interacting with Screens via Zabbix API
+    #
+    # @return [String]
+    def method_name
+      'screen'
+    end
+
+    # The id field name used for identifying specific Screen objects via Zabbix API
+    #
+    # @return [String]
+    def identify
+      'name'
+    end
+
+    # Delete Screen object using Zabbix API
+    #
+    # @param data [String, Array] Should include id's of the screens 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] Zabbix object id
+    def delete(data)
+      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
+    #
+    # @param data [Hash] Needs to include screen_name and graphids to properly identify Screens 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_for_host(data)
+      screen_name = data[:screen_name]
+      graphids = data[:graphids]
+      screenitems = []
+      hsize = data[:hsize] || 3
+      valign = data[:valign] || 2
+      halign = data[:halign] || 2
+      rowspan = data[:rowspan] || 1
+      colspan = data[:colspan] || 1
+      height = data[:height] || 320 # default 320
+      width = data[:width] || 200 # default 200
+      vsize = data[:vsize] || [1, (graphids.size / hsize).to_i].max
+      screenid = get_id(name: screen_name)
+
+      unless screenid
+        # Create screen
+        graphids.each_with_index do |graphid, index|
+          screenitems << {
+            resourcetype: 0,
+            resourceid: graphid,
+            x: (index % hsize).to_i,
+            y: (index % graphids.size / hsize).to_i,
+            valign: valign,
+            halign: halign,
+            rowspan: rowspan,
+            colspan: colspan,
+            height: height,
+            width: width
+          }
+        end
+
+        screenid = create(
+          name: screen_name,
+          hsize: hsize,
+          vsize: vsize,
+          screenitems: screenitems
+        )
+      end
+      screenid
+    end
+  end
+end

data/lib/zabbix_manager/classes/scripts.rb

@@ -0,0 +1,35 @@
+class ZabbixManager
+  class Scripts < Basic
+    def method_name
+      'script'
+    end
+
+    # The id field name used for identifying specific Screen objects via Zabbix API
+    #
+    # @return [String]
+    def identify
+      'name'
+    end
+
+    # Submits a request to the zabbix api
+    # data - A Hash containing the scriptid and hostid
+    #
+    # Example:
+    #   execute({ scriptid: '12', hostid: '32 })
+    #
+    # Returns nothing
+    def execute(data)
+      @client.api_request(
+        method: 'script.execute',
+        params: {
+          scriptid: data[:scriptid],
+          hostid: data[:hostid]
+        }
+      )
+    end
+
+    def getscriptsbyhost(data)
+      @client.api_request(method: 'script.getscriptsbyhosts', params: data)
+    end
+  end
+end

data/lib/zabbix_manager/classes/server.rb

@@ -0,0 +1,16 @@
+class ZabbixManager
+  class Server
+    # @return [String]
+    attr_reader :version
+
+    # Initializes a new Server object with ZabbixManager Client and fetches Zabbix Server API version
+    #
+    # @param client [ZabbixManager::Client]
+    # @return [ZabbixManager::Client]
+    # @return [String] Zabbix API version number
+    def initialize(client)
+      @client = client
+      @version = @client.api_version()
+    end
+  end
+end

data/lib/zabbix_manager/classes/templates.rb

@@ -0,0 +1,123 @@
+class ZabbixManager
+  class Templates < Basic
+    # The method name used for interacting with Templates via Zabbix API
+    #
+    # @return [String]
+    def method_name
+      'template'
+    end
+
+    # The id field name used for identifying specific Template objects via Zabbix API
+    #
+    # @return [String]
+    def identify
+      'host'
+    end
+
+    # Delete Template object using Zabbix API
+    #
+    # @param data [Array] Should include array of templateid's
+    # @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 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
+    end
+
+    # Get Template ids for Host from Zabbix API
+    #
+    # @param data [Hash] Should include host value to query for matching templates
+    # @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 Template ids
+    def get_ids_by_host(data)
+      @client.api_request(method: 'template.get', params: data).map do |tmpl|
+        tmpl['templateid']
+      end
+    end
+
+    # Get or Create Template object using Zabbix API
+    #
+    # @param data [Hash] Needs to include host to properly identify Templates 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)
+      unless (templateid = get_id(host: data[:host]))
+        templateid = create(data)
+      end
+      templateid
+    end
+
+    # Mass update Templates for 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 mass_update(data)
+      result = @client.api_request(
+        method: 'template.massUpdate',
+        params: {
+          hosts:     data[:hosts_id].map { |t| { hostid: t } },
+          templates: data[:templates_id].map { |t| { templateid: t } }
+        }
+      )
+      result.empty? ? false : true
+    end
+
+    # Mass add Templates to 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 mass_add(data)
+      result = @client.api_request(
+        method: 'template.massAdd',
+        params: {
+          hosts:     data[:hosts_id].map { |t| { hostid: t } },
+          templates: data[:templates_id].map { |t| { templateid: t } }
+        }
+      )
+      result.empty? ? false : true
+    end
+
+    # Mass remove Templates to 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 mass_remove(data)
+      result = @client.api_request(
+        method: 'template.massRemove',
+        params: {
+          hostids:     data[:hosts_id],
+          templateids: data[:templates_id],
+          groupids:    data[:group_id],
+          force:       1
+        }
+      )
+      result.empty? ? false : true
+    end
+
+    # 新增 get_template_id 方法，使用列表 flatten 功能拉平数组对象
+    def get_template_ids(data)
+      # 直接调后端接口
+      result = @client.api_request(
+        method: 'template.get',
+        params: {
+          output: "extend",
+          filter: {
+            host: [data].flatten
+          }
+        }
+      ).map { |temp| [templateid: temp['templateid']]}
+
+      # 返回 template 模板数组对象
+      result.empty? ? nil : result.flatten
+    end
+  end
+end