zabbixapi_mgx 5.0.0.pre.alpha1

data/lib/zabbixapi/classes/drules.rb

@@ -0,0 +1,55 @@
+class ZabbixApi
+  class Drules < Basic
+    # The method name used for interacting with Drules via Zabbix API
+    #
+    # @return [String]
+    def method_name
+      'drule'
+    end
+
+    # The id field name used for identifying specific Drule objects via Zabbix API
+    #
+    # @return [String]
+    def identify
+      'name'
+    end
+
+    # The default options used when creating Drule objects via Zabbix API
+    #
+    # @return [Hash]
+    def default_options
+      {
+        name: nil,
+        iprange: nil,
+        delay: 3600,
+        status: 0,
+      }
+    end
+
+    # Get or Create Drule object using Zabbix API
+    #
+    # @param data [Hash] Needs to include name to properly identify Drule via Zabbix API
+    # @raise [ApiError] 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]))
+        id = create(data)
+      end
+      id
+    end
+
+    # Create or update Drule object using Zabbix API
+    #
+    # @param data [Hash] Needs to include name to properly identify Drules via Zabbix API
+    # @raise [ApiError] 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)
+      druleid = get_id(name: data[:name])
+      druleid ? update(data.merge(druleid: druleid)) : create(data)
+    end
+  end
+end

data/lib/zabbixapi/classes/errors.rb

@@ -0,0 +1,28 @@
+class ZabbixApi
+  class BaseError < RuntimeError
+    attr_accessor :response, :error, :error_message
+
+    def initialize(message, response = nil)
+      super(message)
+      @response = response
+
+      set_error! if @response
+    end
+
+  private
+
+    def set_error!
+      @error = @response['error']
+      @error_message = "#{@error['message']}: #{@error['data']}"
+    rescue StandardError
+      @error = nil
+      @error_message = nil
+    end
+  end
+
+  class ApiError < BaseError
+  end
+
+  class HttpError < BaseError
+  end
+end

data/lib/zabbixapi/classes/events.rb

@@ -0,0 +1,17 @@
+class ZabbixApi
+  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/zabbixapi/classes/graphs.rb

@@ -0,0 +1,111 @@
+class ZabbixApi
+  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 [ApiError] 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 [ApiError] 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 [ApiError] 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 [ApiError] 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 [ApiError] 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/zabbixapi/classes/hostgroups.rb

@@ -0,0 +1,24 @@
+class ZabbixApi
+  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
+  end
+end

data/lib/zabbixapi/classes/hosts.rb

@@ -0,0 +1,80 @@
+class ZabbixApi
+  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 [ApiError] 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',
+          selectGroups: 'extend'
+        }
+      )
+    end
+
+    # The default options used when creating Host objects via Zabbix API
+    #
+    # @return [Hash]
+    def default_options
+      {
+        host: nil,
+        interfaces: [],
+        status: 0,
+        available: 1,
+        groups: [],
+        proxy_hostid: nil
+      }
+    end
+
+    # Unlink/Remove Templates from Hosts using Zabbix API
+    #
+    # @param data [Hash] Should include hosts_id array and templates_id array
+    # @raise [ApiError] 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 [ApiError] 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)
+      hostid = get_id(host: data[:host])
+      hostid ? update(data.merge(hostid: hostid)) : create(data)
+    end
+  end
+end

data/lib/zabbixapi/classes/httptests.rb

@@ -0,0 +1,54 @@
+class ZabbixApi
+  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 [ApiError] 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 [ApiError] 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/zabbixapi/classes/items.rb

@@ -0,0 +1,83 @@
+class ZabbixApi
+  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 [ApiError] 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 [ApiError] 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
+  end
+end

data/lib/zabbixapi/classes/maintenance.rb

@@ -0,0 +1,17 @@
+class ZabbixApi
+  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

data/lib/zabbixapi/classes/mediatypes.rb

@@ -0,0 +1,109 @@
+class ZabbixApi
+  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 [ApiError] 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 [ApiError] 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 ApiError.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 [ApiError] 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/zabbixapi/classes/problems.rb

@@ -0,0 +1,101 @@
+class ZabbixApi
+  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 [ApiError] 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 [ApiError] 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 [ApiError] 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
+  end
+end