zabbixapi 2.2.1 → 2.2.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 36996cc80617db9b2b099259078827cb00a79f92
-  data.tar.gz: eb15e6b0025ba2696e926f05c5d74dc8e3d1f9a9
+  metadata.gz: e1af8e059d91bcd50ee36f944393de794e0072d2
+  data.tar.gz: 3975f68a19eff6923a223943bd8d3511e6c4e088
 SHA512:
-  metadata.gz: 921aebf75006230af71140ad7680e1c06293c8cfaf6de71bc50a33ad4b18dabab62ce79b276bab3658abd6fb95aef98c0eb2e63196c972d7e50ab79b70701605
-  data.tar.gz: d5fbf12cc9995d0b77227871a490b99ed7c001b9aa3bffad4093735b2f739deb6c690bd31a5a685c0180e100dfd283d9740ad122e9fb421db5e5706f88468dfc
+  metadata.gz: 10ffe07da786c3a7cbc6b33fdd4d1c397d5b2ce8115cbacfe26d5c1136b4ade6d1cfb70e5a63558195b998d0aae8ed3c70ff20c946b01947eb4c42f93543a95a
+  data.tar.gz: c19d6d4e47b3c500dfe5e87a9dc40bd6d35570608663817a28944cf72323babda2b0f7b03f569976c2a838d9265542da775dd5a2ff9422751db06b05cafd54d9

data/README.md

@@ -341,6 +341,36 @@ zbx.proxies.create(
 )
 ```
 
+### Export object
+
+```ruby
+zbx.configurations.export(
+    :format => "xml",
+    :options => {
+        :templates => [zbx.templates.get_id(:host => "template")]
+    }
+)
+```
+
+### Import object
+
+```ruby
+zbx.configurations.import(
+    :format => "xml",
+    :rules => {
+        :templates => {
+            :createMissing => true,
+            :updateExisting => true
+        },
+        :items => {
+            :createMissing => true,
+            :updateExisting => true
+        }
+    },
+    :source => "<!--?xml version=\"1.0\" encoding=\"UTF-8\"?--><zabbix_export><version>2.0</version><date>2012-04-18T11:20:14Z</date><groups><group><name>Zabbix servers</name></group></groups><hosts><host><host>Export host</host><name>Export host</name><proxyid>0</proxyid><status>0</status><ipmi_authtype>-1</ipmi_authtype><ipmi_privilege>2</ipmi_privilege><ipmi_username></ipmi_username><ipmi_password></ipmi_password><templates></templates><groups><group><name>Zabbix servers</name></group></groups><interfaces><interface><default>1</default><type>1</type><useip>1</useip><ip>127.0.0.1</ip><dns></dns><port>10050</port><interface_ref>if1</interface_ref></interface></interfaces><applications><application><name>Application</name></application></applications><items><item><name>Item</name><type>0</type><snmp_community></snmp_community><multiplier>0</multiplier><snmp_oid></snmp_oid><key>item.key</key><delay>30</delay><history>90</history><trends>365</trends><status>0</status><value_type>3</value_type><allowed_hosts></allowed_hosts><units></units><delta>0</delta><snmpv3_securityname></snmpv3_securityname><snmpv3_securitylevel>0</snmpv3_securitylevel><snmpv3_authpassphrase></snmpv3_authpassphrase><snmpv3_privpassphrase></snmpv3_privpassphrase><formula>1</formula><delay_flex></delay_flex><params></params><ipmi_sensor></ipmi_sensor><data_type>0</data_type><authtype>0</authtype><username></username><password></password><publickey></publickey><privatekey></privatekey><port></port><description></description><inventory_link>0</inventory_link><applications><application><name>Application</name></application></applications><valuemap></valuemap><interface_ref>if1</interface_ref></item></items><discovery_rules></discovery_rules><macros></macros><inventory></inventory></host></hosts><triggers><trigger><expression>{Export host:item.key.last(0)}=0</expression><name>Trigger</name><url></url><status>0</status><priority>2</priority><description>Host trigger</description><type>0</type><dependencies></dependencies></trigger></triggers><graphs><graph><name>Graph</name><width>900</width><height>200</height><yaxismin>0.0000</yaxismin><yaxismax>100.0000</yaxismax><show_work_period>1</show_work_period><show_triggers>1</show_triggers><type>0</type><show_legend>1</show_legend><show_3d>0</show_3d><percent_left>0.0000</percent_left><percent_right>0.0000</percent_right><ymin_type_1>0</ymin_type_1><ymax_type_1>0</ymax_type_1><ymin_item_1>0</ymin_item_1><ymax_item_1>0</ymax_item_1><graph_items><graph_item><sortorder>0</sortorder><drawtype>0</drawtype><color>C80000</color><yaxisside>0</yaxisside><calc_fnc>7</calc_fnc><type>0</type><item><host>Export host</host><key>item.key</key></item></graph_item></graph_items></graph></graphs></zabbix_export>"
+)
+```
+
 ### User and global macros
 ```ruby
 zbx.usermacros.create(

data/lib/zabbixapi.rb

@@ -22,6 +22,7 @@ require "zabbixapi/classes/unusable"
 require "zabbixapi/classes/usergroups"
 require "zabbixapi/classes/usermacros"
 require "zabbixapi/classes/users"
+require "zabbixapi/classes/configurations"
 
 class ZabbixApi
 
@@ -88,7 +89,7 @@ class ZabbixApi
 
   def screens
     @screens ||= Screens.new(@client)
-  end  
+  end
 
   def usergroups
     @usergroups ||= Usergroups.new(@client)
@@ -102,5 +103,9 @@ class ZabbixApi
     @mediatypes ||= Mediatypes.new(@client)
   end
 
+  def configurations
+    @configurations ||= Configurations.new(@client)
+  end
+
 end
 

data/lib/zabbixapi/classes/applications.rb

@@ -1,6 +1,8 @@
 class ZabbixApi
   class Applications
 
+    API_PARAMETERS = %w(applicationids groupids hostids inherited itemids templated templateids expandData selectHosts selectItems)
+
     def initialize(client)
       @client = client
     end
@@ -31,7 +33,11 @@ class ZabbixApi
     end
 
     def get_full_data(data)
-      @client.api_request(:method => "application.get", :params => {:filter => data, :output => "extend"})
+      filter_params = {}
+      request_data = data.dup # Duplicate data, as we modify it. Otherwise methods that use data after calling get_full_data (such as get_id) will fail.
+
+      request_data.each { |key, value| filter_params[key] = request_data.delete(key) unless API_PARAMETERS.include?(key) }
+      @client.api_request(:method => "application.get", :params => request_data.merge({:filter => filter_params, :output => "extend"}))
     end
 
     def get_id(data)

data/lib/zabbixapi/classes/configurations.rb

@@ -0,0 +1,36 @@
+class ZabbixApi
+  class Configurations < Basic
+
+    def array_flag
+      true
+    end
+
+    def method_name
+      "configuration"
+    end
+
+    def indentify
+      "host"
+    end
+
+    # Export configuration data as a serialized string
+    # * *Args*    :
+    # see available parameters: https://www.zabbix.com/documentation/2.2/manual/api/reference/configuration/export
+    # * *Returns* :
+    #   - String
+    def export(data)
+      @client.api_request(:method => "configuration.export", :params => data)
+    end
+
+    # Import configurations data from a serialized string
+    # * *Args*    :
+    # see available parameters: https://www.zabbix.com/documentation/2.2/manual/api/reference/configuration/import
+    # * *Returns* :
+    #   - Boolean
+    def import(data)
+      @client.api_request(:method => "configuration.import", :params => data)
+    end
+
+  end
+end
+

data/lib/zabbixapi/version.rb

@@ -1,3 +1,3 @@
 class ZabbixApi
-  VERSION = "2.2.1"
+  VERSION = "2.2.2"
 end

data/spec/configuration.rb

@@ -0,0 +1,122 @@
+#encoding: utf-8
+
+require "spec_helper"
+
+describe "configuration" do
+  before :all do
+    @hostgroup = gen_name "hostgroup"
+    @hostgroup_id = zbx.hostgroups.create(:name => @hostgroup)
+    @template    = gen_name "template"
+    @template_id = zbx.templates.create(
+      :host   => @template,
+      :groups => [:groupid => @hostgroup_id]
+    )
+    @source = zbx.configurations.export(
+      :format  => "xml",
+      :options => {
+        :templates => [@template_id]
+      }
+    )
+    @item = gen_name "item"
+    @item_id = zbx.items.create(
+      :name         => @item,
+      :description  => "item",
+      :key_         => "proc.num[aaa]",
+      :type         => 0,
+      :value_type   => 3,
+      :hostid       => zbx.templates.get_id(:host => @template),
+    )
+  end
+
+  after :all do
+    zbx.items.delete(zbx.items.get_id(:name => @item))
+    zbx.templates.delete(zbx.templates.get_id(:host => @template))
+    zbx.hostgroups.delete(zbx.hostgroups.get_id(:name => @hostgroup))
+  end
+
+  context "when object not exists" do
+    describe "import with createMissing" do
+      before do
+        zbx.items.delete(@item_id)
+        zbx.templates.delete(@template_id)
+        zbx.hostgroups.delete(@hostgroup_id)
+        zbx.configurations.import(
+          :format => "xml",
+          :rules  => {
+            :groups => {
+              :createMissing => true
+            },
+            :templates => {
+              :createMissing => true
+            }
+          },
+          :source => @source
+        )
+      end
+
+      it "should create object" do
+        expect(zbx.hostgroups.get_id(:name => @hostgroup)).to be_kind_of(Integer)
+        expect(zbx.templates.get_id(:host => @template)).to be_kind_of(Integer)
+      end
+    end
+  end
+
+  context "when object exists" do
+
+    describe "export" do
+      before do
+        zbx.items.create(
+          :name         => @item,
+          :description  => "item",
+          :key_         => "proc.num[aaa]",
+          :type         => 0,
+          :value_type   => 3,
+          :hostid       => zbx.templates.get_id(:host => @template),
+        )
+      end
+
+      it "should export updated object" do
+        expect(zbx.configurations.export(
+          :format  => "xml",
+          :options => {
+            :templates => [zbx.templates.get_id(:host => @template)]
+          }
+        )).to match(/#{@item}/)
+      end
+    end
+
+    describe "import with updateExisting" do
+      before do
+        @source_updated = zbx.configurations.export(
+          :format  => "xml",
+          :options => {
+            :templates => [zbx.templates.get_id(:host => @template)]
+          }
+        )
+        zbx.items.delete(zbx.items.get_id(:name => @item))
+        zbx.configurations.import(
+          :format  => "xml",
+          :rules   => {
+            :templates => {
+              :updateExisting => true
+            },
+            :items => {
+              :createMissing => true
+            }
+          },
+          :source => @source_updated
+        )
+      end
+
+      it "should update object" do
+        expect(zbx.configurations.export(
+          :format  => "xml",
+          :options => {
+            :templates => [zbx.templates.get_id(:host => @template)]
+          }
+        )).to match(/#{@item}/)
+      end
+    end
+  end
+end
+

data/spec/spec_helper.rb

@@ -11,7 +11,7 @@ def zbx
     :url => @api_url,
     :user => @api_login,
     :password => @api_password,
-    :debug => false
+    :debug => ENV['ZABBIX_DEBUG']? true : false
   )
 end
 

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: zabbixapi
 version: !ruby/object:Gem::Version
-  version: 2.2.1
+  version: 2.2.2
 platform: ruby
 authors:
 - Vasiliev D.V.
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2014-07-14 00:00:00.000000000 Z
+date: 2014-10-07 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: json
@@ -52,6 +52,7 @@ files:
 - lib/zabbixapi/basic/basic_init.rb
 - lib/zabbixapi/basic/basic_logic.rb
 - lib/zabbixapi/classes/applications.rb
+- lib/zabbixapi/classes/configurations.rb
 - lib/zabbixapi/classes/errors.rb
 - lib/zabbixapi/classes/graphs.rb
 - lib/zabbixapi/classes/hostgroups.rb
@@ -71,6 +72,7 @@ files:
 - lib/zabbixapi/version.rb
 - spec/application.rb
 - spec/basic_func.rb
+- spec/configuration.rb
 - spec/graph.rb
 - spec/host.rb
 - spec/hostgroup.rb
@@ -112,6 +114,7 @@ summary: Realization for Zabbix API.
 test_files:
 - spec/application.rb
 - spec/basic_func.rb
+- spec/configuration.rb
 - spec/graph.rb
 - spec/host.rb
 - spec/hostgroup.rb