zabcon 0.0.1

data/libs/zabcon_exceptions.rb

@@ -0,0 +1,45 @@
+#GPL 2.0  http://www.gnu.org/licenses/gpl-2.0.html
+#Zabbix CLI Tool and associated files
+#Copyright (C) 2009,2010 Andrew Nelson nelsonab(at)red-tux(dot)net
+#
+#This program is free software; you can redistribute it and/or
+#modify it under the terms of the GNU General Public License
+#as published by the Free Software Foundation; either version 2
+#of the License, or (at your option) any later version.
+#
+#This program is distributed in the hope that it will be useful,
+#but WITHOUT ANY WARRANTY; without even the implied warranty of
+#MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+#GNU General Public License for more details.
+#
+#You should have received a copy of the GNU General Public License
+#along with this program; if not, write to the Free Software
+#Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA  02110-1301, USA.
+
+##########################################
+# Subversion information
+# $Id: zabcon_exceptions.rb 258 2010-12-28 22:49:21Z nelsonab $
+# $Revision: 258 $
+##########################################
+
+#------------------------------------------------------------------------------
+#
+# Class ZbxAP_ParameterError
+#
+# Exception class for parameter errors for Argument Processor calls.
+#
+#------------------------------------------------------------------------------
+
+require 'libs/zdebug'
+require 'libs/exceptions'
+
+#---------------------------------------------------------
+#These general exceptions are only used internally and are
+#not meant to be used by the end consumer of this program
+#---------------------------------------------------------
+
+class Redirect < Exception
+end
+
+class ZabconError < ZError
+end

data/libs/zabcon_globals.rb

@@ -0,0 +1,210 @@
+#GPL 2.0  http://www.gnu.org/licenses/gpl-2.0.html
+#Zabbix CLI Tool and associated files
+#Copyright (C) 2009,2010 Andrew Nelson nelsonab(at)red-tux(dot)net
+#
+#This program is free software; you can redistribute it and/or
+#modify it under the terms of the GNU General Public License
+#as published by the Free Software Foundation; either version 2
+#of the License, or (at your option) any later version.
+#
+#This program is distributed in the hope that it will be useful,
+#but WITHOUT ANY WARRANTY; without even the implied warranty of
+#MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+#GNU General Public License for more details.
+#
+#You should have received a copy of the GNU General Public License
+#along with this program; if not, write to the Free Software
+#Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA  02110-1301, USA.
+
+##########################################
+# Subversion information
+# $Id: zabcon_exceptions.rb 181 2010-04-08 03:33:18Z nelsonab $
+# $Revision: 181 $
+##########################################
+
+#------------------------------------------------------------------------------
+#
+# Class ZbxAP_ParameterError
+#
+# Exception class for parameter errors for Argument Processor calls.
+#
+#------------------------------------------------------------------------------
+
+require 'libs/zdebug'
+
+require 'singleton'
+require 'parseconfig'
+
+# This class is for storing global variables.  This is accomplished by inheriting
+# the singleton class.  To use a global variable it must be registered and then
+# if some part of the program needs to be notified of a change a notifier can
+# be registered for that variable.
+class GlobalsBase
+  include Singleton
+  include ZDebug
+
+  def initialize
+    @hash={}
+    @callbacks={}
+  end
+
+  # overload the assignment operator
+  def []=(key,val)
+    debug(9,[key,val],"Entering []= (key,val)",nil,true)
+    if val.nil?
+      delete(key) if !@hash[key].nil?
+    else
+      if !@hash[key].nil? and (@hash[key].class==Fixnum or @hash[key].class==Bignum)
+        @hash[key]=Integer(val)
+      else
+        @hash[key]=val
+      end
+
+      if !@callbacks[key].nil?
+         @callbacks[key].each {|proc|
+           proc.call(@hash[key])  #use the value stored in the hash should there have been a conversion
+         }
+      end
+    end
+  end
+
+  # overload the array operator
+  def [](key)
+    debug(9,key,"Entering [] (key)",nil,true)
+    if @hash[key].nil?
+      return nil
+    else
+      return @hash[key]
+    end
+  end
+
+  def delete(key)
+    @hash.delete(key)
+  end
+
+  def empty?
+    return @hash.empty?
+  end
+
+  def each
+    @hash.each {|k,v| yield k,v }
+  end
+
+  # Register a function to be called when the value of key changes.
+  def register_notifier(key,proc)
+    debug(9,[key,proc],"Entering register_notifier (key,proc)")
+    if @callbacks[key].nil?
+      @callbacks[key]=[proc]
+    else
+      @callbacks[key]<<proc
+    end
+  end
+end
+
+class GlobalVars < GlobalsBase
+
+  def initialize
+    super()
+  end
+
+end
+
+class EnvVars < GlobalsBase
+
+  def initialize
+    super()
+  end
+
+  #overrides is a hash of options which will override what is found in the config file.
+  #useful for command line options.
+  #if there is a hash called "config_file" this will override the default config file.
+  def load_config(overrides={})
+    begin
+      config_file = overrides["config_file"].nil? ? self["config_file"] : overrides["config_file"]
+      config = overrides["load_config"]==false ?   # nil != false
+      {} : ParseConfig.new(config_file).params
+      # If we are not loading the config use an empty hash
+    rescue Errno::EACCES
+      if !(config_file=="zabcon.conf" and !File::exists?(config_file))
+        puts "Unable to access configuration file: #{config_file}"
+      end
+      config={}
+    end
+
+    config.merge!(overrides)  # merge the two option sets together but give precedence
+                              # to command line options
+
+    config.each_pair { |k,v|
+      self[k]=v
+    }
+
+
+#    debug(6,params)
+#
+#    #Setup a local OpenStruct to copy potentially passed in OpenStruct
+#    #rather than query every time weather or not params is an OpenStruct
+#    localoptions=OpenStruct.new
+#
+#    env=EnvVars.instance  # Instantiate the global EnvVars
+#
+#    if params.nil? or params.empty?  # nil or empty, use conffile
+#      fname=@conffile
+#    elsif params.class==OpenStruct   # use OpenStruct value or conffile
+#      if params.configfile.nil?
+#        fname=@conffile
+#      else
+#        fname=params.configfile
+#        localoptions=params  # Since we have an OpenStruct passed in let's setup
+#                             # our local OpenStruct variable for use later
+#      end
+#    elsif params.class==Hash  # use Hash[:filename] or raise an exception
+#      if params[:filename].nil?
+#        raise ZabconError.new("Expected a hash with the key 'filename'")
+#      else
+#        fname=params[:filename]
+#      end
+#    else  # If we get here something went wrong.
+#      raise ZabconError.new("OH NO!!!  Received something unexpected in do_load_config.  Try again with debug level 6.")
+#    end
+#
+#    begin
+#      config=ParseConfig.new(fname).params
+#      debug(1,config)
+#
+#      if !config["debug"].nil?
+#        # If the command line option debug was not passed in use the config file
+#        env["debug"]=config["debug"].to_i if localoptions.debug.nil?
+#      end
+#
+#      if !config["server"].nil? and !config["username"].nil? and !config["password"].nil? then
+#        do_login({:server=>config["server"], :username=>config["username"],:password=>config["password"]})
+#      else
+#        puts "Missing one of the following, server, username or password or bad syntax"
+#      end
+#
+#      if !config["lines"].nil?
+#        env["sheight"]=config["lines"].to_i
+#      end
+#
+#      if !config["language"].nil?
+#        env["language"]=config["language"]
+#      end
+#
+#    rescue Errno::EACCES
+#      puts "Unable to open file #{fname}"
+#    rescue ZbxAPI_GeneralError => e
+#      puts "An error was received from the Zabbix server"
+#      if e.message.class==Hash
+#        puts "Error code: #{e.message["code"]}"
+#        puts "Error message: #{e.message["message"]}"
+#        puts "Error data: #{e.message["data"]}"
+#        retry
+#      else
+#        puts "Error: #{e.message}"
+#        e.attempt_retry
+#      end
+#    end
+  end
+
+
+end

data/libs/zbxcliserver.rb

@@ -0,0 +1,310 @@
+#GPL 2.0  http://www.gnu.org/licenses/gpl-2.0.html
+#Zabbix CLI Tool and associated files
+#Copyright (C) 2009,2010 Andrew Nelson nelsonab(at)red-tux(dot)net
+#
+#This program is free software; you can redistribute it and/or
+#modify it under the terms of the GNU General Public License
+#as published by the Free Software Foundation; either version 2
+#of the License, or (at your option) any later version.
+#
+#This program is distributed in the hope that it will be useful,
+#but WITHOUT ANY WARRANTY; without even the implied warranty of
+#MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+#GNU General Public License for more details.
+#
+#You should have received a copy of the GNU General Public License
+#along with this program; if not, write to the Free Software
+#Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA  02110-1301, USA.
+
+##########################################
+# Subversion information
+# $Id: zbxcliserver.rb 258 2010-12-28 22:49:21Z nelsonab $
+# $Revision: 258 $
+##########################################
+
+require 'zbxapi'
+require 'libs/zdebug'
+require 'libs/zabcon_globals'
+
+class ZbxCliServer
+
+  include ZDebug
+
+  attr_reader :server_url, :user, :password
+
+  def initialize(server,user,password,debuglevel=0)
+    @server_url=server
+    @user=user
+    @password=password
+    @debuglevel=debuglevel
+    # *Note* Do not rescue errors here, rescue in function that calls this block
+    @server=ZabbixAPI.new(@server_url,@debuglevel)
+    @server.login(@user, @password)
+    GlobalVars.instance["auth"]=@server.auth
+  end
+
+  def debuglevel=(level)
+    @server.debug_level=level
+  end
+
+  def login?
+    !@server.nil?
+  end
+
+  def version
+    @server.API_version
+  end
+
+  def reconnect
+    @server.login(@user,@password)
+  end
+
+  def getuser(parameters)
+    debug(6,parameters)
+
+    result=@server.user.get(parameters)
+    {:class=>:user, :result=>result}
+  end
+
+  def gethost(parameters)
+    debug(6,parameters)
+
+    result=@server.host.get(parameters)
+    {:class=>:host, :result=>result}
+  end
+
+  def addhost(parameters)
+    debug(6,parameters)
+    result=@server.host.create(parameters)
+    {:class=>:host, :message=>"The following host was created: #{result['hostids']}", :result=>result}
+  end
+
+  def deletehost(parameters)
+    debug(6,parameters)
+    result=@server.host.delete(parameters)
+    {:class=>:host, :message=>"The following host(s) was/were deleted: #{result['hostids']}", :result=>result}
+  end
+
+  def getitem(parameters)
+    debug(6,parameters)
+
+    result=@server.item.get(parameters)
+    {:class=>:item, :result=>result}
+  end
+
+  def additem(parameters)
+    debug(6,parameters)
+    {:class=>:item, :result=>@server.item.create(parameters)}
+  end
+
+  def deleteitem(parameters)
+    debug(6,parameters)
+    {:class=>:item, :result=>@server.item.delete(parameters)}
+  end
+
+  def adduser(parameters)
+    debug(6,parameters)
+    begin
+      uid=@server.user.create(parameters)
+      puts "Created userid: #{uid["userids"]}"
+    rescue ZbxAPI_ParameterError => e
+      puts "Add user failed, error: #{e.message}"
+    end
+  end
+
+  def deleteuser(parameter)
+    debug(6,parameter)
+    id=0  #id to delete
+#    if parameters.nil? then
+#      puts "User id required"
+#      return
+#    end
+
+    if !parameter["name"].nil?
+      users=@server.user.get({"pattern"=>parameter["name"], "extendoutput"=>true})
+      users.each { |user| id=user["userid"] if user["alias"]==parameter }
+    else
+      id=parameter["id"]
+    end
+    result=@server.user.delete(id)
+    if !result.empty?
+      puts "Deleted user id #{result["userids"]}"
+    else
+      puts "Error deleting #{parameter.to_a[0][1]}"
+    end
+  end
+
+  def updateuser(parameters)
+    debug(6,parameters)
+    valid_parameters=['userid','name', 'surname', 'alias', 'passwd', 'url', 'autologin',
+                      'autologout', 'lang', 'theme', 'refresh', 'rows_per_page', 'type',]
+    if parameters.nil? or parameters["userid"].nil? then
+      puts "Edit User requires arguments, valid fields are:"
+      puts "name, surname, alias, passwd, url, autologin, autologout, lang, theme, refresh"
+      puts "rows_per_page, type"
+      puts "userid is a required field"
+      puts "example:  edit user userid=<id> name=someone alias=username passwd=pass autologout=0"
+      return false
+    else
+      p_keys = parameters.keys
+
+      valid_parameters.each {|key| p_keys.delete(key)}
+      if !p_keys.empty? then
+        puts "Invalid items"
+        p p_keys
+        return false
+      elsif parameters["userid"].nil?
+        puts "Missing required userid statement."
+      end
+      p @server.user.update([parameters])  #TODO: remove print statement or comment if needed
+    end
+  end
+
+  def addusermedia(parameters)
+    debug(6,parameters)
+    valid_parameters=["userid", "mediatypeid", "sendto", "severity", "active", "period"]
+
+    if parameters.nil? then
+      puts "add usermedia requires arguments, valid fields are:"
+      puts "userid, mediatypeid, sendto, severity, active, period"
+      puts "example:  add usermedia userid=<id> mediatypeid=1 sendto=myemail@address.com severity=63 active=1 period=\"\""
+    else
+
+      p_keys = parameters.keys
+
+      valid_parameters.each {|key| p_keys.delete(key)}
+      if !p_keys.empty? then
+        puts "Invalid items"
+        p p_keys
+        return false
+      elsif parameters["userid"].nil?
+        puts "Missing required userid statement."
+      end
+      begin
+        @server.user.addmedia(parameters)
+      rescue ZbxAPI_ParameterError => e
+        puts e.message
+      end
+    end
+
+  end
+
+  def addhostgroup(parameters)
+    debug(6,parameters)
+    result = @server.hostgroup.create(parameters)
+    {:class=>:hostgroup, :result=>result}
+  end
+
+  def gethostgroup(parameters)
+    debug(6,parameters)
+
+    result=@server.hostgroup.get(parameters)
+    {:class=>:hostgroup, :result=>result}
+  end
+
+  def gethostgroupid(parameters)
+    debug(6,parameters)
+    result = @server.hostgroup.getObjects(parameters)
+    {:class=>:hostgroupid, :result=>result}
+  end
+
+  def getapp(parameters)
+    debug(6,parameters)
+
+    result=@server.application.get(parameters)
+    {:class=>:application, :result=>result}
+  end
+
+  def addapp(parameters)
+    debug(6,parameters)
+    result=@server.application.create(parameters)
+    {:class=>:application, :result=>result}
+  end
+
+  def getappid(parameters)
+    debug(6,parameters)
+    result=@server.application.getid(parameters)
+    {:class=>:application, :result=>result}
+  end
+
+  def gettrigger(parameters)
+    debug(6,parameters)
+    result=@server.trigger.get(parameters)
+    {:class=>:trigger, :result=>result}
+  end
+
+  # addtrigger( { trigger1, trigger2, triggern } )
+  # Only expression and description are mandatory.
+  # { { expression, description, type, priority, status, comments, url }, { ...} }
+  def addtrigger(parameters)
+    debug(6,parameters)
+    result=@server.trigger.create(parameters)
+    {:class=>:trigger, :result=>result}
+  end
+
+  def addlink(parameters)
+    debug(6,parameters)
+    result=@server.sysmap.addlink(parameters)
+    {:class=>:map, :result=>result}
+  end
+
+  def addsysmap(parameters)
+    debug(6,parameters)
+    result=@server.sysmap.create(parameters)
+    {:class=>:map, :result=>result}
+  end
+
+  def addelementtosysmap(parameters)
+    debug(6,parameters)
+    result=@server.sysmap.addelement(parameters)
+    {:class=>:map, :result=>result}
+  end
+
+  def getseid(parameters)
+    debug(6,parameters)
+    result=@server.sysmap.getseid(parameters)
+    {:class=>:map, :result=>result}
+  end
+
+  def addlinktrigger(parameters)
+    debug(6,parameters)
+    result=@server.sysmap.addlinktrigger(parameters)
+    {:class=>:map, :result=>result}
+  end
+
+  def raw_api(parameters)
+    debug(6,parameters)
+    result=@server.raw_api(parameters[:method],parameters[:params])
+    {:class=>:raw, :result=>result}
+  end
+
+  def raw_json(parameters)
+    debug(6,parameters)
+    begin
+      result=@server.do_request(parameters)
+      {:class=>:raw, :result=>result["result"]}
+    rescue ZbxAPI_GeneralError => e
+      puts "An error was received from the Zabbix server"
+      if e.message.class==Hash
+        puts "Error code: #{e.message["code"]}"
+        puts "Error message: #{e.message["message"]}"
+        puts "Error data: #{e.message["data"]}"
+      end
+      puts "Original text:"
+      puts parameters
+      puts
+      return {:class=>:raw, :result=>nil}
+    end
+  end
+
+end
+
+##############################################
+# Unit test
+##############################################
+
+if __FILE__ == $0
+  zbxcliserver = ZbxCliServer.new("http://localhost/","apitest","test")   #Change as appropriate for platform
+
+  p zbxcliserver.getuser(nil)
+end