zabbixapi 4.0.0 → 5.0.0.pre.alpha1

data/lib/zabbixapi/classes/maintenance.rb

@@ -10,7 +10,7 @@ class ZabbixApi
     # The id field name used for identifying specific Maintenance objects via Zabbix API
     #
     # @return [String]
-    def indentify
+    def identify
       'name'
     end
   end

data/lib/zabbixapi/classes/mediatypes.rb

@@ -10,8 +10,8 @@ class ZabbixApi
     # The id field name used for identifying specific MediaType objects via Zabbix API
     #
     # @return [String]
-    def indentify
-      'description'
+    def identify
+      'name'
     end
 
     # The default options used when creating MediaType objects via Zabbix API
@@ -19,16 +19,91 @@ class ZabbixApi
     # @return [Hash]
     def default_options
       {
-        :description => '',  # Name
-        :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
+        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

data/lib/zabbixapi/classes/proxies.rb

@@ -10,7 +10,7 @@ class ZabbixApi
     # The id field name used for identifying specific Proxy objects via Zabbix API
     #
     # @return [String]
-    def indentify
+    def identify
       'host'
     end
 
@@ -21,7 +21,7 @@ class ZabbixApi
     # @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 = @client.api_request(method: 'proxy.delete', params: data)
       result.empty? ? nil : result['proxyids'][0].to_i
     end
 
@@ -32,7 +32,7 @@ class ZabbixApi
     # @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)
+      @client.api_request(method: 'proxy.isreadable', params: data)
     end
 
     # Check if a Proxy object is writable using Zabbix API
@@ -42,7 +42,7 @@ class ZabbixApi
     # @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)
+      @client.api_request(method: 'proxy.iswritable', params: data)
     end
   end
 end

data/lib/zabbixapi/classes/roles.rb

@@ -0,0 +1,114 @@
+class ZabbixApi
+  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 [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 (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 [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 (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 [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: '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 [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_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 [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 (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/zabbixapi/classes/screens.rb

@@ -29,7 +29,7 @@ class ZabbixApi
     # The id field name used for identifying specific Screen objects via Zabbix API
     #
     # @return [String]
-    def indentify
+    def identify
       'name'
     end
 
@@ -40,7 +40,7 @@ class ZabbixApi
     # @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 = @client.api_request(method: 'screen.delete', params: [data])
       result.empty? ? nil : result['screenids'][0].to_i
     end
 
@@ -62,29 +62,30 @@ class ZabbixApi
       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)
+      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,
+            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
+          name: screen_name,
+          hsize: hsize,
+          vsize: vsize,
+          screenitems: screenitems
         )
       end
       screenid

data/lib/zabbixapi/classes/scripts.rb

@@ -1,27 +1,35 @@
 class ZabbixApi
   class Scripts < Basic
-
     def method_name
-      "script"
+      'script'
     end
 
-    def indentify
-      "name"
+    # 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]
+        method: 'script.execute',
+        params: {
+          scriptid: data[:scriptid],
+          hostid: data[:hostid]
         }
       )
     end
 
     def getscriptsbyhost(data)
-      @client.api_request(:method => "script.getscriptsbyhosts", :params => data)
+      @client.api_request(method: 'script.getscriptsbyhosts', params: data)
     end
-
   end
 end