zabbixapi 0.3.0 → 0.4.1

data/.travis.yml

@@ -0,0 +1,9 @@
+language: 
+  - ruby
+rvm: 
+  - 1.9.3
+before_script:
+  - sudo apt-get install mysql-server zabbix-server-mysql zabbix-frontend-php
+  - mysql -u root -e "use zabbix; insert into users_groups(usrgrpid, userid) values(10,1);"
+  - echo "$(curl -fsSL https://raw.github.com/gist/8f0df0d1824ea25a3827/zabbix.php)" | sudo tee /usr/share/zabbix/conf/zabbix.conf.php
+script: "bundle exec rspec spec/run.rb" 

data/Gemfile

@@ -0,0 +1,4 @@
+source :rubygems
+
+gem "rspec"
+gem "rake"

data/Gemfile.lock

@@ -0,0 +1,20 @@
+GEM
+  remote: http://rubygems.org/
+  specs:
+    diff-lcs (1.1.3)
+    rake (0.9.2.2)
+    rspec (2.12.0)
+      rspec-core (~> 2.12.0)
+      rspec-expectations (~> 2.12.0)
+      rspec-mocks (~> 2.12.0)
+    rspec-core (2.12.0)
+    rspec-expectations (2.12.0)
+      diff-lcs (~> 1.1.3)
+    rspec-mocks (2.12.0)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  rake
+  rspec

data/README.md

@@ -0,0 +1,123 @@
+#Ruby Zabbix Api Module
+
+Simple and lightweight ruby module for work with zabbix api 
+
+[![Build Status](https://travis-ci.org/vadv/zabbixapi.png)](https://travis-ci.org/vadv/zabbixapi)
+
+#####Now worked with zabbix 
+* 1.8.2 (api version 1.2)
+* 1.8.9 (api version 1.3)
+
+## Installation
+```
+gem install zabbixapi
+```
+
+## Get Start
+
+### Connect
+```ruby
+zbx = ZabbixApi.connect(
+  :url => 'http://localhost/zabbix/api_jsonrpc.php',
+  :user => 'Admin',
+  :password => 'zabbix'
+)
+```
+### Create Hostgroup
+```ruby
+zbx.hostgroups.create(:name => "hostgroup")
+```
+
+### Create Template
+```ruby
+zbx.templates.create(
+  :host => "template",
+  :groups => [:groupid => zbx.hostgroups.get_id(:name => "hostgroup")]
+)
+```
+
+### Create Application
+```ruby
+zbx.applications.create(
+  :name => application,
+  :hostid => zbx.templates.get_id(:host => "template")
+)
+```
+
+### Create Item
+```ruby
+zbx.items.create(
+  :description => "item",
+  :key_ => "proc.num[aaa]",
+  :hostid => zbx.templates.get_id(:host => "template"),
+  :applications => [zbx.applications.get_id(:name => "application")]
+)
+```
+
+### Create host
+```ruby
+zbx.hosts.add(
+  :host => "hostname",
+  :groups => [ :groupid => zbx.hostgroups.get_id(:name => "hostgroup") ]
+)
+```
+
+### Get all templates linked with host
+```ruby
+zbx.templates.get_ids_by_host( :hostids => [zbx.hosts.get_id(:host => "hostname")] )
+returned hash:
+{
+  "Templatename" => "10",
+  "Templatename" => "1021"
+}
+``` 
+
+### Link host with templates
+```ruby
+zbx.hosts.unlink_templates(
+  :hosts_id => [zbx.hosts.get_id(:host => "hostname")],
+  :templates_id => [111, 214]
+)
+```
+
+### Create trigger
+```ruby
+zbx.triggers.create(
+  :description => "trigger",
+  :expression => "{template:proc.num[aaa].last(0)}<1",
+  :comments => "Bla-bla is faulty (disaster)",
+  :priority => 5,
+  :status     => 0,
+  :templateid => 0,
+  :type => 0
+ )
+````
+
+### Create user
+```ruby
+zbx.users.create(
+  :alias => "Test user",
+  :name => "username",
+  :surname => "usersername",
+  :passwd => "password"
+)
+```
+
+### Custom queries
+```ruby
+zbx.query(
+  :method => "apiinfo.version", 
+  :params => {}
+)
+```
+
+## Dependencies
+
+* net/http
+* net/https
+* json
+
+## Zabbix documentation
+
+* Zabbix Project Homepage -> http://zabbix.com/
+* Zabbix Api docs -> http://www.zabbix.com/documentation/1.8/api

data/Rakefile

@@ -0,0 +1 @@
+require 'bundler/gem_tasks'

data/lib/zabbixapi/applications.rb

@@ -0,0 +1,37 @@
+class ZabbixApi
+  class Applications
+
+    def initialize(options = {})
+      @client = Client.new(options)
+      @options = options
+    end
+
+    def create(data)
+      result = @client.api_request(:method => "application.create", :params => [data])
+      result.empty? ? nil : result['applicationids'][0].to_i
+    end
+
+    def add(data)
+      create(data)
+    end
+
+    def delete(data)
+      result = @client.api_request(:method => "application.delete", :params => [data])
+      result.empty? ? nil : result['applicationids'][0].to_i
+    end
+
+    def destroy(data)
+      delete(data)
+    end
+
+    def get_full_data(data)
+      @client.api_request(:method => "application.get", :params => {:filter => data, :output => "extend"})
+    end
+
+    def get_id(data)
+      result = get_full_data(data)
+      result.empty? ? nil : result[0]['applicationid'].to_i
+    end
+
+  end
+end

data/lib/zabbixapi/client.rb

@@ -0,0 +1,65 @@
+require 'json'
+require 'net/http'
+
+class ZabbixApi
+  class Client
+
+    def id
+      Random.rand(100000)
+    end
+
+    def api_version
+      @version ||= api_request(:method => "apiinfo.version", :params => {})
+    end
+
+    def auth
+      api_request(
+        :method => 'user.authenticate', 
+        :params => {
+          :user      => @options[:user],
+          :password  => @options[:password],
+        }
+      )
+    end
+
+    def initialize(options = {})
+      @options = options
+      @auth_hash = auth
+    end
+
+    def message_json(body)
+      message = {
+        :method  => body[:method],
+        :params  => body[:params],
+        :auth    => @auth_hash,
+        :id      => id,
+        :jsonrpc => '2.0'
+      }
+      JSON.generate(message)
+    end
+
+    def http_request(body)
+      uri = URI.parse(@options[:url])
+      http = Net::HTTP.new(uri.host, uri.port)
+      request = Net::HTTP::Post.new(uri.request_uri)
+      request.add_field('Content-Type', 'application/json-rpc')
+      request.body = body
+      response = http.request(request)
+      raise "HTTP Error: #{response.code} on #{@options[:url]}" unless response.code == "200"
+      puts "[DEBUG] Get answer: #{response.body}" if @options[:debug]
+      response.body
+    end
+
+    def _request(body)
+      puts "[DEBUG] Send request: #{body}" if @options[:debug]
+      result = JSON.parse(http_request(body))
+      raise "Server answer API error: #{result['error'].inspect} on request: #{body}" if result['error']
+      result['result']
+    end
+
+    def api_request(body)
+      _request message_json(body)
+    end
+
+  end
+end

data/lib/zabbixapi/errors.rb

@@ -0,0 +1,12 @@
+class ZabbixApi
+
+  class BaseError < RuntimeError
+  end
+
+  class ApiError < BaseError
+  end
+
+  class HttpError < BaseError
+  end
+
+end

data/lib/zabbixapi/graphs.rb

@@ -0,0 +1,47 @@
+class ZabbixApi
+  class Graphs
+
+    def initialize(options = {})
+      @client = Client.new(options)
+      @options = options
+    end
+
+    def create(data)
+      result = @client.api_request(:method => "graph.create", :params => [data])
+      result.empty? ? nil : result['graphids'][0].to_i
+    end
+
+    def add(data)
+      create(data)
+    end
+
+    def delete(data)
+      result = @client.api_request(:method => "graph.delete", :params => [data])
+      case @client.api_version
+        when "1.3"
+          result ? 1 : 0  #return "true" or "false" for this api version
+        else
+          result.empty? ? nil : result['graphids'][0].to_i
+      end
+    end
+
+    def destroy(data)
+      delete(data)
+    end
+
+    def get_full_data(data)
+      @client.api_request(:method => "graph.get", :params => {:search => {:name => data}, :output => "extend"})
+    end
+
+    def get_id(data)
+      result = @client.api_request(:method => "graph.get", :params => {:filter => {:name=> data[:name]}, :output => "extend"})
+      result.empty? ? nil : result[0]['graphid'].to_i
+    end
+
+    def update(data)
+      result = @client.api_request(:method => "graph.update", :params => data)
+      result.empty? ? nil : result['graphids'][0].to_i
+    end
+
+  end
+end

data/lib/zabbixapi/hostgroups.rb

@@ -0,0 +1,42 @@
+class ZabbixApi
+  class HostGroups
+
+    def initialize(options = {})
+      @client = Client.new(options)
+      @options = options
+    end
+
+    def create(data)
+      result = @client.api_request(:method => "hostgroup.create", :params => [data])
+      result.empty? ? nil : result['groupids'][0].to_i
+    end
+
+    def add(data)
+      create(data)
+    end
+
+    def delete(data)
+      result = @client.api_request(:method => "hostgroup.delete", :params => [:groupid => data])
+      result.empty? ? nil : result['groupids'][0].to_i
+    end
+
+    def destroy(data)
+      delete(data)
+    end
+
+    def get_full_data(data)
+      case @client.api_version 
+        when "1.2"
+          @client.api_request(:method => "hostgroup.get", :params => {:filter => data, :output => "extend"})
+        else
+          @client.api_request(:method => "hostgroup.get", :params => {:filter => data, :output => "extend"})
+      end
+    end
+
+    def get_id(data)
+      result = get_full_data(data)
+      result.empty? ? nil : result[0]['groupid'].to_i
+    end
+
+  end
+end

data/lib/zabbixapi/hosts.rb

@@ -0,0 +1,80 @@
+class ZabbixApi
+  class Hosts
+
+    def initialize(options = {})
+      @client = Client.new(options)
+      @options = options
+      @host_default_options = {
+        :host => nil,
+        :port => 10050,
+        :status => 1,
+        :useip => 1,
+        :dns => '',
+        :ip => '0.0.0.0',
+        :proxy_hostid => 0,
+        :groups => [],
+        :useipmi => 0,
+        :ipmi_ip => '',
+        :ipmi_port => 623,
+        :ipmi_authtype => 0,
+        :ipmi_privilege => 0,
+        :ipmi_username => '',
+        :ipmi_password => ''
+      }
+    end
+
+    def merge_params(params)
+      result = JSON.generate(@host_default_options).to_s + "," + JSON.generate(params).to_s
+      JSON.parse(result.gsub('},{', ','))
+    end
+
+    def create(data)
+      result = @client.api_request(:method => "host.create", :params => [merge_params(data)])
+      result.empty? ? nil : result['hostids'][0].to_i
+    end
+
+    def add(data)
+      create(data)
+    end
+
+    def unlink_templates(data)
+      result = @client.api_request(
+        :method => "host.massRemove", 
+        :params => {
+          :hostids => data[:hosts_id],
+          :templates => data[:templates_id]
+        }
+      )
+      case @client.api_version
+        when "1.2"
+          result ? true : false
+        else
+          result.empty? ? false : true
+      end
+    end
+
+    def delete(data)
+      result = @client.api_request(:method => "host.delete", :params => [:hostid => data])
+      result.empty? ? nil : result['hostids'][0].to_i
+    end
+
+    def destroy(data)
+      delete(data)
+    end
+
+    def update(data)
+      result = @client.api_request(:method => "host.update", :params => data)
+      result.empty? ? nil : result['hostids'][0].to_i
+    end
+
+    def get_full_data(data)
+      @client.api_request(:method => "host.get", :params => {:filter => data, :output => "extend"})
+    end
+
+    def get_id(data)
+      result = get_full_data(data)
+      result.empty? ? nil : result[0]['hostid'].to_i
+    end
+
+  end
+end

data/lib/zabbixapi/items.rb

@@ -0,0 +1,81 @@
+class ZabbixApi
+  class Items
+
+    def initialize(options = {})
+      @client = Client.new(options)
+      @options = options
+      @item_default_options = {
+        :description => nil,
+        :key_ => nil,
+        :hostid => nil,
+        :delay => 60,
+        :history => 60,
+        :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 => 365,
+        :logtimefmt => '',
+        :valuemapid => 0,
+        :delay_flex => '',
+        :authtype => 0,
+        :username => '',
+        :password => '',
+        :publickey => '',
+        :privatekey => '',
+        :params => '',
+        :ipmi_sensor => ''
+      }
+    end
+
+    def merge_params(params)
+      result = JSON.generate(@item_default_options).to_s + "," + JSON.generate(params).to_s
+      JSON.parse(result.gsub('},{', ','))
+    end
+
+    def create(data)
+      result = @client.api_request(:method => "item.create", :params => [merge_params(data)] )
+      result.empty? ? nil : result['itemids'][0].to_i
+    end
+
+    def add(data)
+      create(data)
+    end    
+
+    def get_full_data(data)
+      @client.api_request(:method => "item.get", :params => {:filter => data, :output => "extend"})
+    end
+
+    def get_id(data)
+      result = get_full_data(data)
+      result.empty? ? nil : result[0]['itemid'].to_i
+    end
+
+    def update(data)
+      result = @client.api_request(:method => "item.update", :params => data)
+      result.empty? ? nil : result['itemids'][0].to_i
+    end
+
+    def delete(data)
+      result = @client.api_request(:method => "item.delete", :params => [data])
+      result.empty? ? nil : result['itemids'][0].to_i
+    end
+
+    def destroy(data)
+      delete(data)
+    end
+
+  end
+end

data/lib/zabbixapi/server.rb

@@ -0,0 +1,12 @@
+class ZabbixApi
+  class Server
+
+    attr :version
+
+    def initialize(options = {})
+      @client = Client.new(options)
+      @version = @client.api_request(:method => "apiinfo.version", :params => {})
+    end
+
+  end
+end

data/lib/zabbixapi/templates.rb

@@ -0,0 +1,78 @@
+class ZabbixApi
+  class Templates
+
+    def initialize(options = {})
+      @client = Client.new(options)
+      @options = options
+    end
+
+    def create(data)
+      result = @client.api_request(:method => "template.create", :params => [data])
+      result.empty? ? nil : result['templateids'][0].to_i
+    end
+
+    def add(data)
+      create(data)
+    end
+
+    def delete(data)
+      result = @client.api_request(:method => "template.delete", :params => [:templateid => data])
+      result.empty? ? nil : result['templateids'][0].to_i
+    end
+
+    def destroy(data)
+      delete(data)
+    end
+
+    def get_ids_by_host(data)
+      result = []
+      @client.api_request(:method => "template.get", :params => data).each do |tmpl|
+        result << tmpl['templateid']
+      end
+      result
+    end
+
+    def link_with_host(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
+
+    def all
+      result = {}
+      case @client.api_version
+        when "1.2"
+          @client.api_request(:method => "template.get", :params => {:output => "extend"}).values.each do |tmpl|
+            result[tmpl['host']] = tmpl['hostid']
+          end          
+        else
+          @client.api_request(:method => "template.get", :params => {:output => "extend"}).each do |tmpl|
+            result[tmpl['host']] = tmpl['hostid']
+          end
+      end
+      result
+    end
+
+    def get_full_data(data)
+      case @client.api_version
+        when "1.2"
+          # in this version returned id=>{...}
+          result = @client.api_request(:method => "template.get", :params => {:filter => data, :output => "extend"})
+          result.empty? ? [] : result.values 
+        else
+          @client.api_request(:method => "template.get", :params => {:filter => data, :output => "extend"})
+      end
+    end
+
+    def get_id(data)
+      result = get_full_data(data)
+      result.empty? ? nil : result[0]['templateid'].to_i
+    end
+
+  end
+end

data/lib/zabbixapi/triggers.rb

@@ -0,0 +1,42 @@
+class ZabbixApi
+  class Triggers
+
+    def initialize(options = {})
+      @client = Client.new(options)
+      @options = options
+    end
+
+    def create(data)
+      result = @client.api_request(:method => "trigger.create", :params => [data])
+      result.empty? ? nil : result['triggerids'][0].to_i
+    end
+
+    def add(data)
+      create(data)
+    end
+
+    def delete(data)
+      result = @client.api_request(:method => "trigger.delete", :params => [data])
+      result.empty? ? nil : result['triggerids'][0].to_i
+    end
+
+    def destroy(data)
+      delete(data)
+    end
+
+    def update(data)
+      result = @client.api_request(:method => "trigger.update", :params => data)
+      result.empty? ? nil : result['triggerid'][0].to_i
+    end
+
+    def get_full_data(data)
+      @client.api_request(:method => "trigger.get", :params => {:filter => data, :output => "extend"})
+    end
+
+    def get_id(data)
+      result = get_full_data(data)
+      result.empty? ? nil : result[0]['triggerid'].to_i
+    end
+
+  end
+end