zabbixapi 0.1.6.4 → 0.1.7

data/README.rdoc

@@ -5,7 +5,7 @@ Simple and lightweight ruby module for work with zabbix api version 1.8.x
 {<img src="https://travis-ci.org/vadv/zabbixapi.png">}[https://travis-ci.org/vadv/zabbixapi]
 
 You can:
-* Create and delete host/template/application/items/triggers and screens;
+* Create and delete host/template/application/items/triggers/maintenance and screens;
 * Get info about all zabbix essences;
 
 == Installation
@@ -35,6 +35,12 @@ You can:
       puts zbx.get_group_id('some_group')
     end
 
+* Debugging
+
+For debug information on requests set
+
+	zbx.debug = true
+	
 More see in spec please... 
 
 == Dependencies

data/examples/basic_auth.rb

@@ -0,0 +1,30 @@
+#!/usr/bin/env ruby
+
+require 'rubygems'
+require 'getopt/std'
+require 'yaml'
+require 'zabbixapi'
+
+opt = Getopt::Std.getopts("g:E:")
+
+group_name = opt["g"]
+zabbix_env = opt["E"]
+
+maintenance_name = "Test Maintenance"
+
+# read config
+config = YAML::load(open('./config.yml'))
+
+api_url = config[zabbix_env]["api_url"]
+api_login = config[zabbix_env]["api_login"]
+api_password = config[zabbix_env]["api_password"]
+
+# Esablish new connection
+zbx = Zabbix::ZabbixApi.new(api_url, api_login, api_password)
+zbx.debug = true
+#Simply uses the api_login and api_password for basic auth
+zbx.basic_auth = true
+
+p " * Creating hostgroup #{group_name}."
+g_id = zbx.add_or_get_group(group_name)
+puts g_id

data/examples/maintenance-example.rb

@@ -0,0 +1,55 @@
+#
+# gems
+#
+require 'zabbixapi'
+
+#
+# main
+#
+@yourZabbixHost = 'https://zabbix.example.com/api_jsonrpc.php'
+@yourZabbixLogin = 'login'
+@yourZabbixPassword = 'password'
+@yourServerHost = 'examplehost'
+
+# init
+zbx = Zabbix::ZabbixApi.new(@yourZabbixHost, @yourZabbixLogin, @yourZabbixPassword)
+zbx.debug = true
+
+# find your host
+host_id = zbx.get_host_id(@yourServerHost);
+puts host_id
+
+# create an 1hour maintenance period
+# => true
+time_now = Time.now.to_i
+options = {
+	'name'					=> 'maintenance example',
+	'description'		=> 'maintenance example description ',
+  'active_since'	=> time_now,
+  'active_till'		=> time_now + 60*60
+}
+maintenance_id = zbx.create_maintenance(host_id,options)
+puts maintenance_id
+
+# is maintenance item available? 
+# => true
+puts zbx.maintenance_exists?(maintenance_id)
+
+# update name, description and extend period to 3h 
+# => true
+options = {
+	'name'					=> 'maintenance example update',
+	'description'		=> 'maintenance example update description',
+	'hostids'				=> [host_id],
+  'active_since'	=> time_now,
+  'active_till'		=> time_now + 180*60
+}
+puts zbx.update_maintenance(maintenance_id,options)
+
+# delete it 
+# => true
+puts zbx.delete_maintenance(maintenance_id)
+
+# is maintenance item still available? 
+# => false
+puts zbx.maintenance_exists?(maintenance_id)

data/examples/populate_new_zabbix.sh

@@ -0,0 +1,84 @@
+#!/bin/bash
+
+if [ $# -ne 1 ]; then
+  echo "usage: $(basename $0) ENVIRONMENT"
+  exit 1
+fi
+
+ENVIRONMENT=$1
+CURRENT_DIR=$(dirname $0)
+
+# Clear default
+bundle exec ruby zabbix_clear_default -E $ENVIRONMENT
+
+# Availability
+bundle exec ruby zabbix_availability -E $ENVIRONMENT -g "Templates"
+
+# Net
+bundle exec ruby zabbix_net -E $ENVIRONMENT -g "Templates" -i eth0
+bundle exec ruby zabbix_net -E $ENVIRONMENT -g "Templates" -i eth1
+bundle exec ruby zabbix_net -E $ENVIRONMENT -g "Templates" -i eth2
+bundle exec ruby zabbix_net -E $ENVIRONMENT -g "Templates" -i eth3
+
+# LA
+bundle exec ruby zabbix_la -E $ENVIRONMENT -g "Templates"
+
+# Memory
+bundle exec ruby zabbix_memory -E $ENVIRONMENT -g "Templates"
+
+# Filesystems
+for i in "/storage" "/" "/boot" "/mnt" "/var" "/home" "/tmp" "/backup" \
+  "/var/lib/postgresql"; do
+  bundle exec ruby zabbix_filesystem -E $ENVIRONMENT -g "Templates" -m "$i"
+done
+
+# SSH
+bundle exec ruby zabbix_ssh -E $ENVIRONMENT -g Templates
+
+# NTP
+bundle exec ruby zabbix_ntp -E $ENVIRONMENT -g Templates
+
+# HLSP
+for i in {1..8}; do
+  bundle exec ruby zabbix_hlsp -E $ENVIRONMENT -g Templates -i ${i}
+done
+
+# Playout
+bundle exec ruby zabbix_playout-t -E $ENVIRONMENT -g Templates 
+
+# MegaRAID
+bundle exec ruby zabbix_megaraid -E $ENVIRONMENT -g Templates
+
+# PGSQL
+bundle exec ruby zabbix_pgsql -E $ENVIRONMENT -g Templates
+
+# MDADM
+for i in md0 md1 md2 md3; do
+  bundle exec ruby zabbix_mdadm -E $ENVIRONMENT -g Templates -n ${i}
+done
+
+# ipmi_systemp
+bundle exec ruby zabbix_ipmi_systemp -E $ENVIRONMENT -g Templates
+
+# IO
+bundle exec ruby zabbix_iops -E $ENVIRONMENT -g Templates -n sda
+
+# varnish
+bundle exec ruby zabbix_varnish -E $ENVIRONMENT -g Templates
+
+# nginx
+bundle exec ruby zabbix_nginx -E $ENVIRONMENT -g Templates
+
+# nginx_500
+bundle exec ruby zabbix_nginx_500 -E $ENVIRONMENT -g Templates
+
+
+bundle exec ruby zabbix_cpufan-sersor  -E $ENVIRONMENT -g Templates
+bundle exec ruby zabbix_cputemp-sersor -E $ENVIRONMENT -g Templates
+bundle exec ruby zabbix_ipmi-cpufan-sersor -E $ENVIRONMENT -g Templates
+bundle exec ruby zabbix_mailer -E $ENVIRONMENT -g Templates
+bundle exec ruby zabbix_megaraid -E $ENVIRONMENT -g Templates
+bundle exec ruby zabbix_mpeg2lander_signal -E $ENVIRONMENT -g Templates
+bundle exec ruby zabbix_mpeg2lander_status -E $ENVIRONMENT -g Templates
+bundle exec ruby zabbix_named -E $ENVIRONMENT -g Templates
+bundle exec ruby zabbix_nv-gputemp -E $ENVIRONMENT -g Templates

data/examples/zabbix_availability

@@ -25,23 +25,23 @@ zbx = Zabbix::ZabbixApi.new(api_url, api_login, api_password)
 
 # Create new template
 p " * Creating template #{template_name}."
-g_id = zbx.get_group_id(group_name)
+g_id = zbx.add_or_get_group(group_name)
 
 options = {
   'groups' => [ g_id.to_i ],
   'host' => template_name
 }
 
-t_id = zbx.add_template(options)
+t_id = zbx.add_or_get_template(options)
 
 # Create application #{app_name}
 app_name = "Availability"
 p " ** Create application #{app_name}."
 application = {
-  'hostid' => t_id.to_i,
+  'hostid' => t_id,
   'name' => app_name
 }
-a_id = zbx.add_application(application)
+a_id = zbx.add_or_get_application(t_id, application)
 
 # 'Ping.'
 options = {
@@ -51,12 +51,12 @@ options = {
   'applications' => [ a_id.to_i ],
   'history' => 7,
   'trends' => 30,
-  'delay' => 60,
+  'delay' => 30,
   'value_type' => 0,
   'type' => '0'
 }
 p " ** Add 'Ping' to #{template_name}."
-i_id = zbx.add_item(options)
+i_id = zbx.add_or_get_item(t_id, options)
 
 # TRIGGERS
 options = {
@@ -70,4 +70,4 @@ options = {
 }
 
 p " ** Add 'Host availability disaster trigger'"
-tr_id = zbx.add_trigger(options)
+tr_id = zbx.add_or_get_trigger(t_id, options)

data/examples/zabbix_clear_default

@@ -0,0 +1,36 @@
+#!/usr/bin/env ruby
+
+require 'rubygems'
+require 'getopt/std'
+require 'yaml'
+require 'zabbixapi'
+
+opt = Getopt::Std.getopts("g:E:")
+
+group_name = opt["g"]
+zabbix_env = opt["E"]
+
+template_name = "TMPL_Availability"
+
+# read config
+config = YAML::load(open('./config.yml'))
+
+api_url = config[zabbix_env]["api_url"]
+api_login = config[zabbix_env]["api_login"]
+api_password = config[zabbix_env]["api_password"]
+
+
+# Esablish new connection
+zbx = Zabbix::ZabbixApi.new(api_url, api_login, api_password)
+
+defaults = zbx.get_templates()
+
+p " * Delete all template ^Template_."
+
+defaults.each do |template|
+  if template[1].match('^Template_')
+    p " ** Delete template #{template[1]}"
+    zbx.delete_template(template[1])
+  end
+end
+

data/examples/zabbix_cpufan-sersor

@@ -0,0 +1,114 @@
+#!/usr/bin/env ruby
+
+require 'rubygems'
+require 'getopt/std'
+require 'yaml'
+require 'zabbixapi'
+
+opt = Getopt::Std.getopts("g:E:")
+
+group_name = opt["g"]
+zabbix_env = opt["E"]
+
+template_name = "TMPL_cpufan_sensor"
+app_name = "cpufan_sensor"
+high_disaster_rpm = '5000'
+low_disaster_rpm = '800'
+
+# read config
+config = YAML::load(open('./config.yml'))
+
+api_url = config[zabbix_env]["api_url"]
+api_login = config[zabbix_env]["api_login"]
+api_password = config[zabbix_env]["api_password"]
+
+# Esablish new connection
+zbx = Zabbix::ZabbixApi.new(api_url, api_login, api_password)
+
+# Create new template
+p " * Creating template #{template_name}."
+g_id = zbx.add_or_get_group(group_name)
+
+options = {
+  'groups' => [ g_id.to_i ],
+  'host' => template_name
+}
+
+t_id = zbx.add_or_get_template(options)
+
+# Create application #{app_name}
+app_name = "cpufan_sensor"
+p " ** Create application #{app_name}."
+application = {
+  'hostid' => t_id.to_i,
+  'name' => app_name
+}
+a_id = zbx.add_or_get_application(t_id, application)
+
+# 'cpu fan speed'
+options = {
+  'description' => "CPU FAN Speed sensor",
+  'key_' => "cpufansensor",
+  'hostid' => t_id.to_i,
+  'applications' => [ a_id.to_i ],
+  'history' => 7,
+  'trends' => 30,
+  'delay' => 60,
+  'templateid' => t_id, 
+  'value_type' => '3',
+  'units' => 'rpm'
+}
+p " ** Add 'cpufansensor' to #{template_name}."
+sensor_item_id = zbx.add_or_get_item(t_id, options)
+
+# TRIGGER
+# cpufan disaster (high threshold)
+options = {
+  'description' => "CPU FAN sensor high",
+  'expression' => "{#{template_name}:cpufansensor.last(0)}>#{high_disaster_rpm}",
+  'priority' => 5, # disaster
+  'templateid' => 0,
+  'comments' => "Cpufan sensor high threshold (Disaster)",
+  'type' => 0,
+  'status' => '0'
+}
+p " ** Add 'cpufan sensor high disaster' trigger"
+zbx.debug = true
+tr_id = zbx.add_or_get_trigger(t_id, options)
+
+# TRIGGER
+# cpufan disaster (high threshold)
+options = {
+  'description' => "CPU FAN sensor low",
+  'expression' => "{#{template_name}:cpufansensor.last(0)}<#{low_disaster_rpm}",
+  'priority' => 5, # disaster
+  'templateid' => 0,
+  'comments' => "Cpufan sensor low threshold (Disaster)",
+  'type' => 0,
+  'status' => '0'
+}
+p " ** Add 'cpufan sensor low disaster' trigger"
+tr_id = zbx.add_or_get_trigger(t_id, options)
+
+# GRAPH
+options = {
+  'gitems' => [
+    {   
+      "itemid" => sensor_item_id,
+      "drawtype" => "0",
+      "sortorder" => "0",
+      "color" => "AA0000",
+      "yaxisside" => "0",
+      "calc_fnc" => "2",
+      "type" => "0",
+      "periods_cnt" => "5" 
+    }
+  ],  
+  "show_triggers" => "1",
+  "name" => "CPU FAN Speed sensor data from lm-sensors",
+  "width" => "900",
+  "height" => "200",
+  "templateid" =>  "0" 
+}
+
+g_id = zbx.add_or_get_graph(t_id, options)

data/examples/zabbix_cputemp-sersor

@@ -0,0 +1,112 @@
+#!/usr/bin/env ruby
+
+require 'rubygems'
+require 'getopt/std'
+require 'yaml'
+require 'zabbixapi'
+
+opt = Getopt::Std.getopts("g:E:")
+
+group_name = opt["g"]
+zabbix_env = opt["E"]
+
+template_name = "TMPL_cputemp_sensor"
+app_name = "cputemp_sensor"
+high_temperature = '60'
+crit_temperature = '80'
+
+# read config
+config = YAML::load(open('./config.yml'))
+
+api_url = config[zabbix_env]["api_url"]
+api_login = config[zabbix_env]["api_login"]
+api_password = config[zabbix_env]["api_password"]
+
+# Esablish new connection
+zbx = Zabbix::ZabbixApi.new(api_url, api_login, api_password)
+
+# Create new template
+p " * Creating template #{template_name}."
+g_id = zbx.add_or_get_group(group_name)
+
+options = {
+  'groups' => [ g_id.to_i ],
+  'host' => template_name
+}
+
+t_id = zbx.add_or_get_template(options)
+
+# Create application #{app_name}
+app_name = "cputemp_sensor"
+p " ** Create application #{app_name}."
+application = {
+  'hostid' => t_id.to_i,
+  'name' => app_name
+}
+a_id = zbx.add_or_get_application(t_id, application)
+
+# 'cpu temperature sensor'
+options = {
+  'description' => "CPU Temperature sensor",
+  'key_' => "cputempsensor",
+  'hostid' => t_id.to_i,
+  'applications' => [ a_id.to_i ],
+  'history' => 7,
+  'trends' => 30,
+  'delay' => 60,
+  'value_type' => '3',
+  'units' => 'C'
+}
+p " ** Add 'cputempsensor' to #{template_name}."
+sensor_item_id = zbx.add_or_get_item(t_id, options)
+
+# TRIGGER
+# cputemp disaster (high threshold)
+options = {
+  'description' => "CPU Temperature sensor warning",
+  'expression' => "{#{template_name}:cputempsensor.last(0)}>#{high_temperature}",
+  'priority' => 2, # warning
+  'templateid' => 0,
+  'comments' => "Cputemp sensor (Warning)",
+  'type' => 0,
+  'status' => '0'
+}
+p " ** Add 'cputemp sensor warning' trigger"
+tr_id = zbx.add_or_get_trigger(t_id, options)
+
+# TRIGGER
+# cputemp disaster (high threshold)
+options = {
+  'description' => "CPU temperature sensor disaster",
+  'expression' => "{#{template_name}:cputempsensor.last(0)}>#{crit_temperature}",
+  'priority' => 5, # disaster
+  'templateid' => 0,
+  'comments' => "Cputemp sensor (Disaster)",
+  'type' => 0,
+  'status' => '0'
+}
+p " ** Add 'cputemp sensor disaster' trigger"
+tr_id = zbx.add_or_get_trigger(t_id, options)
+
+# GRAPH
+options = {
+  'gitems' => [
+    {   
+      "itemid" => sensor_item_id,
+      "drawtype" => "0",
+      "sortorder" => "0",
+      "color" => "AA0000",
+      "yaxisside" => "0",
+      "calc_fnc" => "2",
+      "type" => "0",
+      "periods_cnt" => "5" 
+    }
+  ],  
+  "show_triggers" => "1",
+  "name" => "CPU Temperature from lm-sensors",
+  "width" => "900",
+  "height" => "200",
+  "templateid" =>  "0" 
+}
+
+g_id = zbx.add_or_get_graph(t_id, options)