zabbixapi_mgx 5.0.0.pre.alpha1

data/lib/zabbixapi/classes/proxies.rb

@@ -0,0 +1,48 @@
+class ZabbixApi
+  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 [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 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 [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] 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 [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] Returns true if the given proxies are writable
+    def iswritable(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

@@ -0,0 +1,94 @@
+class ZabbixApi
+  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 [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 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 [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_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/zabbixapi/classes/scripts.rb

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

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

data/lib/zabbixapi/classes/templates.rb

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

data/lib/zabbixapi/classes/triggers.rb

@@ -0,0 +1,105 @@
+class ZabbixApi
+  class Triggers < Basic
+    # The method name used for interacting with Triggers via Zabbix API
+    #
+    # @return [String]
+    def method_name
+      'trigger'
+    end
+
+    # The id field name used for identifying specific Trigger objects via Zabbix API
+    #
+    # @return [String]
+    def identify
+      'description'
+    end
+
+    # Dump Trigger 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: 'trigger.get',
+        params: {
+          filter: {
+            key.to_sym => data[key.to_sym]
+          },
+          output: 'extend',
+          select_items: 'extend',
+          select_functions: 'extend'
+        }
+      )
+    end
+
+    # Safely update Trigger object using Zabbix API by deleting and replacing trigger
+    #
+    # @param data [Hash] Needs to include description and hostid to properly identify Triggers 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 safe_update(data)
+      log "[DEBUG] Call safe_update with parameters: #{data.inspect}"
+
+      dump = {}
+      item_id = data[key.to_sym].to_i
+      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
+
+      expression = dump[:items][0][:key_] + '.' + dump[:functions][0][:function] + '(' + dump[:functions][0][:parameter] + ')'
+      dump[:expression] = dump[:expression].gsub(/\{(\d*)\}/, "{#{expression}}") # TODO: ugly regexp
+      dump.delete(:functions)
+      dump.delete(:items)
+
+      old_expression = data[:expression]
+      data[:expression] = data[:expression].gsub(/\{.*\:/, '{') # TODO: ugly regexp
+      data.delete(:templateid)
+
+      log "[DEBUG] expression: #{dump[:expression]}\n data: #{data[:expression]}"
+
+      if hash_equals?(dump, data)
+        log "[DEBUG] Equal keys #{dump} and #{data}, skip safe_update"
+        item_id
+      else
+        data[:expression] = old_expression
+        # disable old trigger
+        log '[DEBUG] disable :' + @client.api_request(method: "#{method_name}.update", params: [{ triggerid: data[:triggerid], status: '1' }]).inspect
+        # create new trigger
+        data.delete(:triggerid)
+        create(data)
+      end
+    end
+
+    # Get or Create Trigger object using Zabbix API
+    #
+    # @param data [Hash] Needs to include description and hostid to properly identify Triggers 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(description: data[:description], hostid: data[:hostid]))
+        id = create(data)
+      end
+      id
+    end
+
+    # Create or update Trigger object using Zabbix API
+    #
+    # @param data [Hash] Needs to include description and hostid to properly identify Triggers 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)
+      triggerid = get_id(description: data[:description], hostid: data[:hostid])
+
+      triggerid ? update(data.merge(triggerid: triggerid)) : create(data)
+    end
+  end
+end

data/lib/zabbixapi/classes/unusable.rb

@@ -0,0 +1,8 @@
+class ZabbixApi
+  class Triggers < Basic
+    def create_or_update(data)
+      log "[DEBUG] Call create_or_update with parameters: #{data.inspect}"
+      get_or_create(data)
+    end
+  end
+end

data/lib/zabbixapi/classes/usergroups.rb

@@ -0,0 +1,73 @@
+class ZabbixApi
+  class Usergroups < Basic
+    # The method name used for interacting with Usergroups via Zabbix API
+    #
+    # @return [String]
+    def method_name
+      'usergroup'
+    end
+
+    # The key field name used for Usergroup objects via Zabbix API
+    #
+    # @return [String]
+    def key
+      'usrgrpid'
+    end
+
+    # The id field name used for identifying specific Usergroup 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 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
+
+    # 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
+
+    # Update users in usergroups 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